Open Platform(API)

v8.0

Open Platform is an open platform based on the sales business. Provide the our partners and customers products information, order information, shipping charge calculation , parcel tracking information and so on , users can easily integrated into our website or system, to realize the seamless connection of all the information.

How to Use

1	First of all, you need to have a account
2	.Enter into the user center enable the API service, access to get the secret key(Identifier)
3	The API service request Address: `"http://网址/webservice/APIWebService.asmx"`

Authorization

First
.Use API need to apply from the user center,the system will generate an identifier automatically,the identifier can be blocked up or changed.
Second
API Can only take out your own account information.

Function

API user authorization types

need

Acquire the country names

Application scenarios: queries supported by the by the state
Function Name：getCountry（secretkey）
Submit parameters：secretkey(API Key)
Authorization: need
Return：JSON

Input parameters

Field	Type	Whether must	Default	Description	Example
Secretkey	String	Must		Key	d0fc2606-611f-443a-aea2-aa209673a32c10000

Return result

Field	Type	Whether must	Description	Example
ShortName	String	Must	The national shorthand	AF
EnName	String	Must	Country English name	Afghanistan
Cnname	String	Must	Country Chinese name	阿富汗
Base_placeId	String	Must	Country Code	20

Error code

Field	Type	Whether must	Example	Description
complete	Boolean	No	true	The success of that submission

API sample tool

For Example

.NET For Example

First step:In your own project:asp.net,add web quotation,Provide the API service website address offered by. Be assumed to be:"{Website}/webservice/APIWebService.asmx"
Second step:Initialization,then use the method,can obtain the data
pfc.pfcwebservice p=new pfc.pfcwebservice();
string result = p.getCountry(secretkey);

Returns the sample

 [{"ShortName":"AF","EnName":"Afghanistan","Cnname":"\u963F\u5BCC\u6C57","Base_placeId":"20"}]

Search supporting service modes

Application of scene：Gets a list of valid means of transport（Chinese name,English name,code,delivery time,icon）
Function：getChannel（secretkey）
Submit parameters：secretkey(API Key)
Authorization: need
Return：JSON

Input parameters

Field	Type	Whether must	Default	Description	Example
Secretkey	String	Must		Key	d0fc2606-611f-443a-aea2-aa209673a32c10000

Return result

Field	Type	Whether must	Description	Example
Base_ChannelInfoID	String	Must	Channel code	46
ChannelCode	String	Must	Transport code	CNDHL
CnName	String	Must	Transport Chinese name	大陆DHL普货价
EnName	String	Must	Transport English name	CNDHL
Reftime	String	Must	Prescription	2 - 4
ShortenImage	String	Optional	Transport icons	635195880046832907_dhl.gif

Error Code

Field	Type	Whether must	Example	Description
complete	Boolean	No	true	The success of that submission

API sample tool

For Example

.NET For Example

First step:In your own project:asp.net,add web quotation,Provide the API service website address offered .Be assumed to be: "{Website}/webservice/APIWebService.asmx"
Second step:Initialization,then use the method,can obtain the data
pfc.pfcwebservice p=new pfc.pfcwebservice();
string result = p.getChannel (secretkey);

Returns the sample

 [{"base_Channelinfoid":"46","ChannelCode":"CNDHL","CnName":"\u5927\u9646DHL\u666E\u8D27\u4EF7","enname":"CNDHL","reftime":"2 - 4","shortenimage":"635195880046832907_dhl.gif"}

Shipping query

Application of scene:According to the country and the weight and volume to get all transportation prices(Transportation Chinses name CHCnName,English name.
CHEnName,code ChannelCode,delivery time RefTime,icon,totao amount MinSaleAmountTotal)
Function name：getFeeByCWV（string country,stringweight,stringvolume,stringcustomerid, string secretkey)
If you can identify the account of the total cost of discount
Submit the parameter:country code, weight, volume, customerID ,scretkey --identifier
Authorization: need
Back：JSON

Input parameters

Field	Type	Whether must	Description	Example
country	String	Must	Country code	Austria-澳大利亚
Weight	String	Must	Weight	0.25(kg)
Volume	String	Must	Volume	0.25cm³
Customer ID	String	Must	Customer ID	10000
Identifier	String	Must	Key	d0fc2606-611f-443a-aea2-aa209673a32c10000

Return result

Field	Type	The return value	Description
CHCnName	string	香港邮政航空大包	Service Chinese name
CHEnName	string	HKBPOST	Service English name
ChannelCode	string	HKBPOST	Channel code
RefTime	string	7 - 14	Reference prescription
MinSaleAmountTotal	string	109.740	Total amount

Error Code

API sample tool

For Example

.NET For Example

First step:In your own project:asp.net,add web quotation,Provide the API service website address offered.Be assumed to be:"{Website}/webservice/APIWebService.asmx"
Second step:Initialization,then use the method,can obtain the data
pfc.pfcwebservice p=new pfc.pfcwebservice();
string result = p.getFeeByCWV(country,weight, volume,stringcustomerid, secretkey);

Returns the sample

    [{"CHCnName":"\u9999\u6E2F\u90AE\u653F\u822A\u7A7A\u5927\u5305","CHEnName":"HKBPOST","ChannelCode":"HKBPOST","RefTime":"7 - 14","MinSaleAmountTotal":"200.620"}

Parcel information checking

Application of scene：Get through the order number or a tracking number（order state,total amount,order number,tracking number）
Function name：getPackage（string orderNo,stringcustomerid, string secretkey）
Submit the parameter：strwhere（order number or tracking number）, customerid（customerID）,scretkey(Key)
Authorization: need
Return：JSON

Input parameters

Field	Type	Whether must	Description	Example
OrderNo	String	Must	Order No	R100001407290002
CustomerId	String	Must	Customer number	10000
SecretKey	String	Must	Key	d0fc2606-611f-443a-aea2-aa209673a32c10000
Remark	String	Optional	Remark	Null

Return result

Field	Type	The return value	Description
OrderNo	String	R100001407290002	Order No
TrackingNo	String	RS12345678910	Tracking number
field1	String	234234	Turn number
OrderStatus	String	6	Order status 1
OrderStatus2	String	已发货	Order status 2
TotalAmount	String	6027.250	The total cost
EnName	String	Albania	Recipient countries
ChannelCode	String	GBPOST	Channel Code

Error code

API sample tool

For Example

.NET For Example

First step:In your own project:asp.net,add web quotation,Provide the API service website address offered.Be assumed to be:"{Website}/webservice/APIWebService.asmx"
Second step:Initialization,then use the method,can obtain the data
pfc.pfcwebservice p=new pfc.pfcwebservice();
string result = p.getPackage(orderNO, string customerid, secretkey);

Returns the sample

[{"OrderNo":"R100001411160002","TrackingNo":"DDU1371690781102767","field1":"","OrderStatus2":"\u5DF2\u53D1\u8D27","TotalAmount":"26.500","ChannelCode":"GBPOST","EnName":"Argentina","OrderStatus":"6"}]

Create Order

Application scenarios: users can set up by API order information into the system
The requested address: "{Website}/webservice/APIWebService.asmx"
Authorization: need
The input parameters:Such as

Input parameters

Field	Type	Whether must	Default	Description	Example
Secretkey	String	Must		Key	d0fc2606-611f-443a-aea2-aa209673a32c10000
OrderType	String	Must		Order types（Fulfillment orders or Ordinary orders）Fulfillment orders is 1,Ordinary orders is 2	2
CustomID	String	Must		Customer ID	10000
ConsigneeName	String	Must		The recipient name	lemon
Consignee Country	String	Must		Recipient countries	221
Shipping service	String	Must		Transport(channel)	91
State	String	Must		State	Vlaams Brabant
City	String	Must		City	Londerzeel
Order Status	String	Must		Order status --to be modified (Draft), to be sent, has sent (confirm)	1
Address1	String	Must		Address 1	United States,,,MN.USA
Address2	String	Optional		Address 2	United States,,,MN.USA
CsRefNo	String	Optional		Customer reference number	1122
Zipcode	String	Optional		Zip code	2134342
Contact	String	Optional		Contact	180344345665
CusRemark	String	Optional		Customer order note	Null
TrackingNo	String	Optional		Tracking Number	RT209114500HK
OrderNo	String	Optional		Order No	R100001411160002--If it is modified, put in order number; if it is new, do not fill out
MaterialRefNo	String	Must		Item 1 product code	11
Quantity	String	Must		Item 1 Quantity	100
Price	String	Must		Item 1 Price	10.2
Weight	String	Must		Item 1 Weight	10
Product English name	String	Must		Item 1 Products English name	MP31232
Warehouse ID	String	Must		Item 1 Warehouse ID	302
ProducingArea	String	Optional		Item 1 Country of origin
MaterialRefNo	String	Must		Item 2 product code	A0002
Quantity	String	Must		Item 2 Quantity	100
Price	String	Must		Item 2 Price	10.2
Weight	String	Must		Item 2 Weight	10
Product English name	String	Must		Item 2 Product English name	MP31232
Warehouse ID	String	Must		Item 2 Warehouse ID	302
ProducingArea	String	Optional		Item 2 Country of origin
......	......	......	......	......	......

Return result

Field	Type	Whether must	Example	Description
complete	Boolean	No	True	The success of that submission The output parameters after the submission of returns generated by the system order number and return message, order number and prompt information separated with '-', if the error returned error code returned information shown in column directly return a string of success: the order preserving and submitted successfully! -DL140887 (tracking number); R100001409100028 (Order No.) Note: the tracking number back tracking number, no tracking number does not return, order No. shall return error information is returned instance: save failed, please check whether the data entry error! Error recipient countries! System matching to the corresponding recipient countries order new successful, successful forecast results of an example: order preserving and submitted successfully! -DL140887 (tracking number); R100001409100028 (Order No.) prediction results: Forecast: 1 records!, successful prediction of 1 records orders new successful, forecast failure results of example: order preserving and submitted to the success! -DL140887 (tracking number); R100001409100028 (Order No.) prediction results: forecast failure Order No.: R100001409090003 error message: order validation errors, the error message [0] for the weight of the commodity can not

Returns the sample

Description	Example
Order to save and submit success	R100001411160002

Error Code

Error Code	Error description	The solution
	Save failed, please check whether the error data entry item!!	According to the prompt enter the correct data

API sample tool

For Example

.NET For Example

First step:In your own project:asp.net,add web quotation,Provide the API service website address offered.Be assumed to be:{Website}/webservice/APIWebService.asmx
Second step:Initialization,then use the method,can obtain the data
pfc.pfcwebservice p = newpfc.pfcwebservice();
string result = p. InsertUpdateOrder(strorderinfo, strorderproduct, stradd, secretkey);

Order to save and submit success!-R100001501190004

Through the API check the storage status

For the users of the application scenario can through the API to check the SKU/bar code stored information
If need to be authorized ，please go to the user center to apply the key---the identifier .
Query website address:"{Website}/webservice/APIWebService.asmx/getStock"
Input parameter:
Authorization: need
Return：Json

Input parameters

Field	Type	Whether must	Description	Example
skuorcode	String	Must	SKU/Bar code	A00001
customerid	String	Must	Customer id	10000
Secretkey	String	Must	Key	d0fc2606-611f-443a-aea2-aa209673a32c10000
WarehouseName	String	Must	Storage (SZWH- Shenzhen West Licang (302), GZWH (381) HKWH- Hongkong Guangzhou storage warehouse(382))	302

Return result

Field	The return value	Description
OutinQuantity	8662	The amount of inventory
Stock	6	The occupation number
CnName	MP31243 112\uFF0C	Products Chinese name
EnName	MP31	Products English name

Error code

Error code	Error Description	The solution

API sample tool

For Example

.NET For Example

First step:In your own project:asp.net,add web quotation,Provide the API service website address offered by.Be assumed to be:"{Website}/webservice/APIWebService.asmx "
Second step:Initialization,then use the method,can obtain the data
string result = p. getStock (skuorcode, customerid, secretkey, WarehouseName);
Such as:p.getStock(S4-ACHEB, 80003,2acd2496-78f8-4eac-ba9c-fd152c2fb41e80003,302)

    [{"OutinQuantity":"8662","Stock":"6","CnName":"MP31243 112\uFF0C","EnName":"MP31"},{"OutinQuantity":"1","Stock":"1","CnName":"MP31243 112\uFF0C","EnName":"MP31"}]

Orders tracking information

The application scenario users can be through the API check the order tracking information.
Query website address:"{Website}/webservice/APIWebService.asmx/getOrder_Track"
Input parameter：OrderNo(tracking information ，tracking number)
Output parameter：back json character string

Input parameters

Field	Type	Whether must	Default	Description	Example
Order number/Tracking number	String	Must		Order No/TrackingNo	R100001411160002

Return result

Description	The return value
The delivery of content	SHENZHEN - CHINA:交运发往目的地(Departed Facility）
Time	2014-11-16 16:19:55

Error Code

Error Code	Error Description	The Solution

API sample tool

For Example

.NET For Example

First step:In your own project:asp.net,add web quotation, Provide the API service website address offered.Be assumed to be: "{Website}/webservice/APIWebService.asmx"
Second step:Initialization,then use the method, can obtain the data. pfc.pfcwebservice p = newpfc.pfcwebservice();
string result = p. getOrder_Track("R807521408070065")

Returns the sample

 Describe                                                    The last delivery time SHENZHEN - CHINA:交运发往目的地(Departed Facility)   2014-11-16 16:32:09 SHENZHEN - CHINA:收取包裹(Shipment picked up) 	             2014-11-16 16:19:55

Print the shipping labels

Users of application scenarios can access the address directly fill in the corresponding information can print label
Query website address:
"{Website}/Manage/PrintPage/Print_PDF.aspx?OrderNo=RP05851311190001,&type=A4"(A4label)
"{Website}/Manage/PrintPage/Print_PDF.aspx?OrderNo=RP05851311190001,&type=(heat-sensitive Label)"
Rameter introduction:OrderNo can fill order number,tracking number.RP05851311190001,RP05851311190001 Use the semicolon to separate.
Type:Print format =A4 or Heat sensitive

Input parameters

Field	Type	Whether must	Default	Description	Example
type				Printing paper format: A4 print A4 size; Blank thermal printing format.	A4
Order number		Must		Order Number/Tracking Number	R100001411160002

API Example Tools

Acquire the fulfillment information

Users of application scenarios can be through API to get the fulfillment details
Query website address: "{Website}/webservice/APIWebService.asmx"

Input parameters

Field	Type	Whether must	Default	Description	Example
Secretkey	String	Must		Key	d0fc2606-611f-443a-aea2-aa209673a32c10000

Return result

Filed	The return value
SZWH-Shenzhen West Licang	storage name
302	storage ID

API sample tool

For Example

.NET For Example

First step:In your own project:asp.net,add web quotation, Provide the API service website address offered.Be assumed to be: "{Website}/webservice/APIWebService.asmx"
Second step:Initialization,then use the method, can obtain the data.
pfc.pfcwebservice p = newpfc.pfcwebservice();
string result = p. GetWarehouse();//back to the character string

   302:SZWH-Shenzhen warehouse;381:GZWH-Guangzhou warehouse;382:HKWH-Hongkong warehouse;457:Shenzhen VIP warehouse

Technical support

Please contact us for API questions

Open Platform(API)

How to Use

Authorization

First

Second

Function

API user authorization types

need

Acquire the country names

Input parameters

Return result

Error code

API sample tool

For Example

Search supporting service modes

Input parameters

Return result

Error Code

API sample tool

For Example

Shipping query

Input parameters

Return result

Error Code

API sample tool

For Example

Parcel information checking

Input parameters

Return result

Error code

API sample tool

For Example

Create Order

Input parameters

Return result

Returns the sample

Error Code

API sample tool

For Example

Through the API check the storage status

Input parameters

Return result

Error code

API sample tool

For Example

Orders tracking information

Input parameters

Return result

Error Code

API sample tool

For Example

Print the shipping labels

Input parameters

API Example Tools

Acquire the fulfillment information

Input parameters

Return result

API sample tool

For Example

Technical support