WishPost API Documentation
Order(New)
Create an order(New)
API endpoint: https://www.wishpost.cn/api/v2/create_order
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| api_key | string | 83-84 | Used to verify the identity. Please use v1 instead of v2 in the url. |
| mark | string | 0-50 | If you need multiple labels in one PDF file, please use the previous returned mark |
| bid | int | 0-99999 | Unique submission identifier provided by user |
| guid | string | 100 | Unique waybill identifier provided by user, returned together with waybill number |
| otype | string | 1-50 |
China Post Unregistered=0 China Post Registered=1 China Post Simplified Tracked Packet=1 -------------------------------------- DLE=10-1 EUB=11-1 MPAK=14-1 IB Express=21-1 IB Standard=22-1 Sinotrans=23-1 DHLe-PKG=30-0 DHLe-PPS=31-1 Wishpost EPC=36-1 Wishpost YunExpress=37-1 Wishpost WiseExpress=44-1 Sunyou Packet Registered=49-1(Online Payment) Sunyou Packet Unregistered=54-0(Online Payment) FlyT Registered Packet=55-1 FlyT Unregistered Packet=56-0 TopYou unregistered general cargo=77-0(Online Payment) TopYou unregistered special cargo=78-0(Online Payment) TopYou registered general cargo=79-1(Online Payment) TopYou registered special cargo=80-1(Online Payment) Europe Economy=200-0 Europe Standard=201-1 Wishpriority=300-1For more channels' otype, please call get channels API |
| platform | int | 0-100 |
Others=0 1688=1 AliExpress=2 Amazon=3 Cdiscount=4 DHgate=5 eBay=6 JD=7 Joom=8 Jumia=9 Lazada=10 magento=11 mymall=12 Rakuten=13 Shopee=14 Shopify=15 Shopline=16 tiki=17 Tophatter=18 UEESHOP=19 Vova=20 Walmart=21 Woocommerce=22 xshoppy=23 |
| merchant_website_name | string | 0-100 | Merchant Website name |
| non_wish_transaction_id | string | 0-100 | Other Platform Order ID |
| store_id | string | 0-100 | Store ID |
| from | string | 0-100 | Sender Name (cannot contain Chinese characters, default info in address book will be used if left blank) |
| sender_province | string | 0-100 | Sender Province (cannot contain Chinese characters, default info in address book will be used if left blank) |
| sender_city | string | 0-100 | Sender City (cannot contain Chinese characters, default info in address book will be used if left blank) |
| sender_district | string | 0-100 | Sender District (cannot contain Chinese characters, default info in address book will be used if left blank) |
| sender_addres | string | 0-100 | Sender Address (cannot contain Chinese characters, default info in address book will be used if left blank) |
| sender_phone | string | 0-20 | Sender Phone Number (Default info in address book will be used if left blank. Phone number could start with one + numbers can be connected with - or encapsulated by (). But could not contain any other mark or other language character.) |
| sender_zipcode | string | 1-200 | Sender postal code to contact for Collection(default info in address book will be used if left blank, if sender postal code is blank in address, 310000 will be used as default) |
| sender_tax_id | string | 1-200 | Sender tax id, this field is required for UK non Wish order.For orders placed after 2021/6/15, if the destination country is EU member, and the total net selling price of goods is equal to or greater than 150 euro, please fill in with the following rules: if the seller pays the import tariff, fill in this field;If the buyer pays the import tariff, this field may not be filled in or passed in. |
| sender_eori | string | 1-200 | Sender EORI (this fieldis required for UK non wish order) |
| pickup_service | string | 1-100 | Pick Up Service for EPC/A+, if choose Collection, must fill in 25-1(IVPX PICKUP) or 27-1(WISE PICKUP) or 42-0(YANWEN PICKUP), if choose self deliver, this field can be noneFor Other channels, wipe this field out |
| pickup_from_local | string | 1-100 | Sender Name to Collect Parcel From (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_phone | string | 1-250 | Sender Phone to contact for Collection (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_zip_code | string | 1-200 | Sender postal code to contact for Collection |
| pickup_addres_local | string | 1-200 | Sender Address to Collect Parcel From (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_province_local | string | 1-1000 | Sender Province to Collect Parcel From (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_city_local | string | 1-1000 | Sender City to Collect Parcel From (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_district_local | string | 1-1000 | Sender District to Collect Parcel From |
| pickup_from | string | 1-100 | Sender Name to Collect Parcel From |
| pickup_addres | string | 1-200 | Sender Address to Collect Parcel From |
| pickup_province | string | 1-1000 | Sender Province to Collect Parcel From |
| pickup_city | string | 1-1000 | Sender City to Collect Parcel From |
| pickup_district | string | 1-1000 | Sender District to Collect Parcel From |
| pickup_country_local | string | 1-500 | Sender Country to Collect Parcel From |
| pickup_country | string | 1-500 | Sender Country to Collect Parcel From |
| pickup_country_code | string | 3 | Sender Country ISO3 Code to Collect Parcel From |
| return_action_in_country | int | 0,2,3 | Return action in country: 0-abandon，2-return to pickup address，3-return to return address(return address info required) |
| reverse_logistics_mode | int | 1,3 | Return logistics mode: 1-return by pickup carrier，3-return via express prepaid |
| return_name_local | string | 1-100 | Return local name, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_phone | string | 1-20 | Return phone number, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_zipcode | string | 1-200 | Return zip code, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value contact for Collection |
| return_address_local | string | 1-200 | Return local address, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_province_local | string | 1-1000 | Return local province, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_city_local | string | 1-1000 | Return local city, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_district_local | string | 1-1000 | Return local district, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| to | string | 1-100 | Recipient Name |
| recipient_country | string | 1-50 | Recipient Country (in English),optional for Wishpost EPC channel |
| recipient_country_short | string | 1-3 | Recipient Country Shortcode (e.g. US, GB, UK),optional for Wishpost EPC channel |
| recipient_province | string | 1-100 | Recipient Province/State (in English),optional for Wishpost EPC channel |
| recipient_city | string | 1-100 | Recipient City (in English),optional for Wishpost EPC channel |
| recipient_district | string | 1-100 | Recipient District (in English),optional |
| recipient_addres | string | 1-100 | Recipient Address (in English),optional for Wishpost EPC channel |
| recipient_postcode | string | 1-10 | Recipient Postal Code/ZIP,optional for Wishpost EPC channel |
| recipient_phone | string | 1-20 | Recipient Phone Number(Phone number could start with one + numbers can be connected with - or encapsulated by (). But could not contain any other mark or other language character.),optional for Wishpost EPC channel |
| recipient_email | string | 1-50 | Recipient Email (email must contain @,required for Wishpost Nile channel) |
| to_local | string | 1-100 | Recipient Name (use recipient country’s language, if left blank, use English) |
| recipient_country_local | string | 0-50 | Recipient Country (use recipient country’s language, if left blank, use English) |
| recipient_province_local | string | 0-100 | Recipient Province/State (use recipient country’s language, if left blank, use English) |
| recipient_city_local | string | 0-100 | Recipient City (use recipient country’s language, if left blank, use English) |
| recipient_district_local | string | 0-100 | Recipient District (use recipient country’s language, if left blank, use English) |
| recipient_addres_local | string | 0-100 | Recipient Address (use recipient country’s language, if left blank, use English) |
| receive_from | string | 0-100 | Courier Contact (Must be in Chinese) |
| receive_province | string | 0-100 | Courier Province Name (Must be in Chinese) |
| receive_city | string | 0-100 | Courier Country Name (Must be in Chinese) |
| receive_district | string | 0-100 | Courier Country Name (Must be in Chinese) |
| receive_addres | string | 0-100 | Courier Information (Must be in Chinese) |
| receive_phone | string | 0-20 | Courier Phone Number |
| buyer_tax_id | string | 1-100 | Buyer tax id, optional |
| type_no | int | 1 |
Product type: 5=Sale of Good |
| unit_measurement | string | 0-20 | Unit Of Measurement |
| unit_measurement_chinese | string | 0-20 | Unit Of Measurement in Chinese |
| user_desc | string | 0-500 | Merchant-defined Information, such as merchant order ID, product ID, location ID |
| trade_amount | money | 0-99999.00 | Trade amount on Wish (Unit: US dollar), including product value and shipping fee |
| currency | string | 1-200 | Declared value currency.this field is not required ('gbp' for UK,'eur' for orders placed after 2021/7/1 with the destination country is EU member'usd' for the left countries currency） |
| warehouse_code | int | 0-10 |
Warshouse code(Mandatory for China Post and IB) ---------------------------------------------------------------- Below are China Post Registered/Unregistered Warehouses: 1=Shanghai 2=Guangzhou 3=Shenzhen 4=Yiwu 5=Beijing 6=Nanjing 7=Fuzhou 8=Qingdao 9=Wuhan 10=Dongguan 11=Hangzhou 12=Jinhua 13=Ningbo 14=Wenzhou 15=Xiamen 16=Chongqing 17=Tianjin 18=Suzhou 19=Hefei 20=Changsha 21=Zhengzhou 22=Chengdu 23=Xuchang 24=Quanzhou 25=Foshan 26=Zhangpu 29=Wuxi 30=Nanyang 31=Shijiazhuang 32=Jingzhou 33=Nanchang 34=Dalian 35=Jinan 36=Yichang 37=Nantong 38=Zhongshan --------------------------------------------------------------- Below are IB Standard/Express Warehouses: 27=EastChina 28=SouthChina |
| doorpickup | int | 1 |
Door pickup method 0=Customer Drop Off 1=Door Pickup 2=Pending |
| product_item_from_country | string | string | Product’s original country (in English) |
| product_item_name | string | 1-100 | Product’s detailed name (in English), which must contain at least one English character |
| product_item_name_chinese | string | 1-50 | Product’s detailed name (mandatory, must contains Chinese) |
| product_item_num | int | 1-99999 | Product Quantity |
| product_item_weight | float | 0-2.000 | Product Weight (in kg, to 3 decimal places) |
| product_item_single_price | money | 0-99999.00 | Product Price (to 2 decimal places),UK needs to fill in the pound value; For orders placed between 2021/6/15 and 2021/6/30, the destination country is the EU member, the declared value is still in US dollars.For orders placed after 2021/7/1 with the destination country is EU member,the declared value needs to fill in the euro value |
| wish_order_id | string | 1-499 |
Ｗish order ID in Wish merchant dashboard， mandatory for all channels. This field must be a string only containing English and numeric characters, with English comma to separate multiple ids if there are. No extra space characters are allowed in the middle of it. If this order does not belong to Wish platform, please provide default value as NonWishOrder(no limit in upper/lower case), please be noted this logistics order will not be able to fulfilled into Wish merchant dashboard; If this order does belong to Wish platform, please correctly provide the 24-char Wish order ID provided by Wish merchant dashboard. This field support a single ID, such as 56f1205a44dc6fb51631f26f. |
| product_item_has_battery | int | 1 |
Has battery or not, Mandatory 0=Without battery, 1=With battery EPC order with sentitive goods should use 1 as well EPC sensitive goods list: https://s3.cn-north-1.amazonaws.com.cn/wishpost-production-wishpost-announcement/EPC特货清单.xlsx |
| product_item_sensitivity_type | int | 2 |
Product sensitivity type, 0=General Cargo, 1=Has Battery, 2=Sensitive, If the value of product_item_sensitivity_type is smaller than product_item_has_battery,We will use product_item_has_battery as the value of this field.Sensitivity type list: https://wishpost-data.s3.cn-north-1.amazonaws.com.cn/manual/special_sensitive%2Bdefinition.xlsx |
| product_item_product_url | string | string | Product url(Mandatory) |
| product_item_hs_code | string | string | Product HS Code |
| sender_ioss_vat_id | string | string | The sender's IOSS vat id, which is the unique number of the VAT payerregistered in the EU Member States. After 2021/6/15, required when 1）2）3） are met. 1) the destination countryis EU member; 2) the net selling price of goods in the invoice is less than 150 euro; 3) Non Wish order |
| product_item_intrinsic_value | money | Product Item Intrinsic Value (Euro),which is the totalproduct item intrinsic value of goods listed in the invoice of sales platform (unit price of goods * quantity of goods, excluding tax, freight, insurance, etc.).After 2021/6/15, required when 1) 2) are met: 1) destination country is EU member, 2) Non Wish order | |
| product_item_intrinsic_vat_amount | money | Product Item Intrinsic Vat Amount, Optional, default is 0 | |
| total_transport_value | money | Total Transport Value, Optional, default is 0 | |
| total_transport_vat_amount | money | Total Transport Vat Amount, Optional, default is 0 |
Response
| Parameter name | Description |
|---|---|
| Timestamp | Timestamp |
| Status | Status |
| wish_standard_tracking_id | WOSP Order Number |
| barcode | Waybill Number |
| warehouse | Combine Warehouse |
| mark | mark |
| PDF_10_EN_URL | PDF Label 10*10 English Version Download URL |
| PDF_10_LCL_URL | PDF Label 10*10 Recipient Country Download URL |
| error_message | Error message |
| PDF_15_EN_URL | PDF Label 10*5 Download URL |
| recipient_country | Recipient Country |
| recipient_country_short | Recipient Country Code |
| c_code | Product Code |
| q_code | Channel Code |
| y_ code | Verification Code |
| user_desc | User-defined Information |
| reference_qrcode | Sweden reference QRcode |
| error_ref_id | Error Reference Id |
Example Request
<?xml version="1.0" ?>
<orders>
<access_token>f06d703a71e4412aad8a579925aef656</access_token>
<mark/>
<bid>0</bid>
<order>
<guid>12345</guid>
<otype>0</otype>
<from>ZENG WEI</from>
<sender_addres>756 ROOM 2 DANYUAN MEILONGYUAN LONGHUA</sender_addres>
<sender_province>GUANGDONG</sender_province>
<sender_city>SHENZHEN</sender_city>
<sender_phone>18620352867</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<sender_ioss_vat_id>xxxxx</sender_ioss_vat_id>
<to>Kali West</to>
<to_local>Kali West</to_local>
<recipient_addres>20/37 Gerrale Street</recipient_addres>
<recipient_addres_local>20/37 Gerrale Street</recipient_addres_local>
<recipient_country>Germany</recipient_country>
<recipient_country_short>DE</recipient_country_short>
<recipient_country_local>Germany</recipient_country_local>
<recipient_province>Berlin</recipient_province>
<recipient_province_local>New South Wales</recipient_province_local>
<recipient_city>Berlin</recipient_city>
<recipient_city_local>Berlin</recipient_city_local>
<recipient_postcode>2230</recipient_postcode>
<recipient_phone>11</recipient_phone>
<type_no>5</type_no>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<user_desc>asgfdgs</user_desc>
<trade_amount>11.45</trade_amount>
<doorpickup>1</doorpickup>
<warehouse_code>1</warehouse_code>
<product_items>
<product_item>
<wish_order_id>5a80417edf3b162557f66545</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>LED light</product_item_name>
<product_item_name_chinese>发光二极管</product_item_name_chinese>
<product_item_num>3</product_item_num>
<product_item_weight>0.15</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>1</product_item_has_battery>
<product_item_sensitivity_type>2</product_item_sensitivity_type>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
<product_item_intrinsic_value>24.01</product_item_intrinsic_value>
<product_item_intrinsic_vat_amount>3.03</product_item_intrinsic_vat_amount>
</product_item>
<product_item>
<wish_order_id>5a80417edf3b162557f66544</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>head</product_item_name>
<product_item_name_chinese>帽子</product_item_name_chinese>
<product_item_num>2</product_item_num>
<product_item_weight>0.1</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>0</product_item_has_battery>
<product_item_sensitivity_type>0</product_item_sensitivity_type>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
<product_item_intrinsic_value>24.01</product_item_intrinsic_value>
<product_item_intrinsic_vat_amount>3.03</product_item_intrinsic_vat_amount>
</product_item>
</product_items>
<total_transport_value>12.02</total_transport_value>
<total_transport_vat_amount>3.03</total_transport_vat_amount>
</order>
<order>
<guid>12346</guid>
<otype>1</otype>
<from>ZENG WEI</from>
<sender_province>GUANGDONG</sender_province>
<sender_city>SHENZHEN</sender_city>
<sender_addres>756 ROOM 2 DANYUAN MEILONGYUAN LONGHUA</sender_addres>
<sender_phone>18620352867</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kali West</to>
<to_local>Kali West</to_local>
<recipient_addres>20/37 Gerrale Street</recipient_addres>
<recipient_addres_local>20/37 Gerrale Street</recipient_addres_local>
<recipient_country>Australia</recipient_country>
<recipient_country_short>AU</recipient_country_short>
<recipient_country_local>Australia</recipient_country_local>
<recipient_province>New South Wales</recipient_province>
<recipient_province_local>New South Wales</recipient_province_local>
<recipient_city>Cronulla</recipient_city>
<recipient_city_local>Cronulla</recipient_city_local>
<recipient_postcode>2230</recipient_postcode>
<recipient_phone>11</recipient_phone>
<type_no>5</type_no>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<user_desc>something</user_desc>
<trade_amount>11.45</trade_amount>
<receive_from>许勤</receive_from>
<receive_province>广东</receive_province>
<receive_city>深圳</receive_city>
<receive_addres>福田区福中三路市民中心大楼</receive_addres>
<receive_phone>12345</receive_phone>
<doorpickup>1</doorpickup>
<warehouse_code>2</warehouse_code>
<product_items>
<product_item>
<wish_order_id>5a80417edf3b162557f66545</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>LED light</product_item_name>
<product_item_name_chinese>发光二极管</product_item_name_chinese>
<product_item_num>3</product_item_num>
<product_item_weight>0.15</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>1</product_item_has_battery>
<product_item_sensitivity_type>1</product_item_sensitivity_type>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
<product_item>
<wish_order_id>5a80417edf3b162557f66544</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>head</product_item_name>
<product_item_name_chinese>帽子</product_item_name_chinese>
<product_item_num>2</product_item_num>
<product_item_weight>0.1</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>0</product_item_has_battery>
<product_item_sensitivity_type>0</product_item_sensitivity_type>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
</product_items>
</order>
<order>
<guid>12347</guid>
<otype>9-0</otype>
<from>ZENG WEI</from>
<sender_province>GUANGDONG</sender_province>
<sender_city>SHENZHEN</sender_city>
<sender_addres>756 ROOM 2 DANYUAN MEILONGYUAN LONGHUA</sender_addres>
<sender_phone>18620352867</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kali West</to>
<to_local>Kali West</to_local>
<recipient_addres>20/37 Gerrale Street</recipient_addres>
<recipient_addres_local>20/37 Gerrale Street</recipient_addres_local>
<recipient_country>Australia</recipient_country>
<recipient_country_short>AU</recipient_country_short>
<recipient_country_local>Australia</recipient_country_local>
<recipient_province>New South Wales</recipient_province>
<recipient_province_local>New South Wales</recipient_province_local>
<recipient_city>Cronulla</recipient_city>
<recipient_city_local>Cronulla</recipient_city_local>
<recipient_postcode>2230</recipient_postcode>
<recipient_phone>11</recipient_phone>
<type_no>5</type_no>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<user_desc>something</user_desc>
<trade_amount>11.45</trade_amount>
<doorpickup>1</doorpickup>
<product_items>
<product_item>
<wish_order_id>5a80417edf3b162557f66545</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>LED light</product_item_name>
<product_item_name_chinese>发光二极管</product_item_name_chinese>
<product_item_num>3</product_item_num>
<product_item_weight>0.15</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>1</product_item_has_battery>
<product_item_sensitivity_type>1</product_item_sensitivity_type>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
<product_item>
<wish_order_id>5a80417edf3b162557f66544</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>head</product_item_name>
<product_item_name_chinese>帽子</product_item_name_chinese>
<product_item_num>2</product_item_num>
<product_item_weight>0.1</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>0</product_item_has_battery>
<product_item_sensitivity_type>0</product_item_sensitivity_type>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
</product_items>
</order>
<order>
<guid>12348</guid>
<otype>10-0</otype>
<from>ZENG WEI</from>
<sender_province>GUANGDONG</sender_province>
<sender_city>SHENZHEN</sender_city>
<sender_addres>756 ROOM 2 DANYUAN MEILONGYUAN LONGHUA</sender_addres>
<sender_phone>18620352867</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kali West</to>
<to_local>Jaden Smith</to_local>
<recipient_addres>322 Edge Street</recipient_addres>
<recipient_addres_local>322 Edge Street</recipient_addres_local>
<recipient_country>United States</recipient_country>
<recipient_country_short>US</recipient_country_short>
<recipient_country_local>United States</recipient_country_local>
<recipient_province>South Carolina</recipient_province>
<recipient_province_local>South Carolina</recipient_province_local>
<recipient_city>Columbia</recipient_city>
<recipient_city_local>Columbia</recipient_city_local>
<recipient_postcode>29201</recipient_postcode>
<recipient_phone>11</recipient_phone>
<type_no>5</type_no>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<user_desc>something</user_desc>
<trade_amount>11.45</trade_amount>
<doorpickup>1</doorpickup>
<product_items>
<product_item>
<wish_order_id>5a80417edf3b162557f66545</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>LED light</product_item_name>
<product_item_name_chinese>发光二极管</product_item_name_chinese>
<product_item_num>3</product_item_num>
<product_item_weight>0.15</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>1</product_item_has_battery>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
<product_item>
<wish_order_id>5a80417edf3b162557f66544</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>head</product_item_name>
<product_item_name_chinese>帽子</product_item_name_chinese>
<product_item_num>2</product_item_num>
<product_item_weight>0.1</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>0</product_item_has_battery>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
</product_items>
</order>
<order>
<guid>12349</guid>
<otype>11-0</otype>
<from>ZENG WEI</from>
<sender_province>GUANGDONG</sender_province>
<sender_city>SHENZHEN</sender_city>
<sender_addres>756 ROOM 2 DANYUAN MEILONGYUAN LONGHUA</sender_addres>
<sender_phone>18620352867</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kali West</to>
<to_local>Kali West</to_local>
<recipient_addres>20/37 Gerrale Street</recipient_addres>
<recipient_addres_local>20/37 Gerrale Street</recipient_addres_local>
<recipient_country>Australia</recipient_country>
<recipient_country_short>AU</recipient_country_short>
<recipient_country_local>Australia</recipient_country_local>
<recipient_province>New South Wales</recipient_province>
<recipient_province_local>New South Wales</recipient_province_local>
<recipient_city>Cronulla</recipient_city>
<recipient_city_local>Cronulla</recipient_city_local>
<recipient_postcode>2230</recipient_postcode>
<recipient_phone>11</recipient_phone>
<type_no>5</type_no>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<user_desc>something</user_desc>
<trade_amount>11.45</trade_amount>
<doorpickup>1</doorpickup>
<product_items>
<product_item>
<wish_order_id>5a80417edf3b162557f66545</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>LED light</product_item_name>
<product_item_name_chinese>发光二极管</product_item_name_chinese>
<product_item_num>3</product_item_num>
<product_item_weight>0.15</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>1</product_item_has_battery>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
<product_item>
<wish_order_id>5a80417edf3b162557f66544</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>head</product_item_name>
<product_item_name_chinese>帽子</product_item_name_chinese>
<product_item_num>2</product_item_num>
<product_item_weight>0.1</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>0</product_item_has_battery>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
</product_items>
</order>
<order>
<guid>MGP1704200142254</guid>
<otype>21-1</otype>
<warehouse_code>27</warehouse_code>
<pickup_from_local>苏蕙</pickup_from_local>
<pickup_addres_local>鼓楼区 新三路987弄3号201室</pickup_addres_local>
<pickup_province_local>福建省</pickup_province_local>
<pickup_city_local>福州市</pickup_city_local>
<pickup_phone>13763813216</pickup_phone>
<from>subilong</from>
<sender_addres>GulouQu Darushijai</sender_addres>
<sender_province>Fujiansheng</sender_province>
<sender_city>Fuzhoushi</sender_city>
<sender_phone>13763813216</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kalynn Stiles</to>
<to_local />
<recipient_addres>25380 County Rd. 21A</recipient_addres>
<recipient_addres_local />
<recipient_country>United States</recipient_country>
<recipient_country_short>US</recipient_country_short>
<recipient_country_local />
<recipient_province>California</recipient_province>
<recipient_province_local />
<recipient_city>Esparto</recipient_city>
<recipient_city_local />
<recipient_postcode>95627</recipient_postcode>
<recipient_phone>(530)787-3999</recipient_phone>
<type_no>5</type_no>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<user_desc>手表 Deng21 1;</user_desc>
<trade_amount>3.00</trade_amount>
<receive_from>苏碧龙</receive_from>
<receive_province>福建省</receive_province>
<receive_city>福州市</receive_city>
<receive_addres>鼓楼区大儒世家</receive_addres>
<receive_phone>13763813216</receive_phone>
<doorpickup>1</doorpickup>
<product_items>
<product_item>
<wish_order_id>5a80417edf3b162557f66545</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>LED light</product_item_name>
<product_item_name_chinese>发光二极管</product_item_name_chinese>
<product_item_num>3</product_item_num>
<product_item_weight>0.15</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>1</product_item_has_battery>
<product_item_sensitivity_type>2</product_item_sensitivity_type>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
<product_item>
<wish_order_id>5a80417edf3b162557f66544</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>head</product_item_name>
<product_item_name_chinese>帽子</product_item_name_chinese>
<product_item_num>2</product_item_num>
<product_item_weight>0.1</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>0</product_item_has_battery>
<product_item_sensitivity_type>0</product_item_sensitivity_type>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
</product_items>
</order>
<order>
<guid>12345</guid>
<otype>33-0</otype>
<from>ZENG WEI</from>
<sender_addres>756 ROOM 2 DANYUAN MEILONGYUAN LONGHUA</sender_addres>
<sender_province>GUANGDONG</sender_province>
<sender_city>SHENZHEN</sender_city>
<sender_phone>18620352867</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kali West</to>
<to_local>Kali West</to_local>
<recipient_addres>20/37 Gerrale Street</recipient_addres>
<recipient_addres_local>20/37 Gerrale Street</recipient_addres_local>
<recipient_country>Australia</recipient_country>
<recipient_country_short>AU</recipient_country_short>
<recipient_country_local>Australia</recipient_country_local>
<recipient_province>New South Wales</recipient_province>
<recipient_province_local>New South Wales</recipient_province_local>
<recipient_city>Cronulla</recipient_city>
<recipient_city_local>Cronulla</recipient_city_local>
<recipient_postcode>2230</recipient_postcode>
<recipient_phone>11</recipient_phone>
<type_no>5</type_no>
<user_desc>asgfdgs</user_desc>
<trade_amount>11.45</trade_amount>
<doorpickup>1</doorpickup>
<warehouse_code>1</warehouse_code>
<product_items>
<product_item>
<wish_order_id>5a80417edf3b162557f66545</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>LED light</product_item_name>
<product_item_name_chinese>发光二极管</product_item_name_chinese>
<product_item_num>3</product_item_num>
<product_item_weight>0.15</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>1</product_item_has_battery>
<product_item_sensitivity_type>1</product_item_sensitivity_type>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
<product_item>
<wish_order_id>5a80417edf3b162557f66544</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>head</product_item_name>
<product_item_name_chinese>帽子</product_item_name_chinese>
<product_item_num>2</product_item_num>
<product_item_weight>0.1</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>0</product_item_has_battery>
<product_item_sensitivity_type>0</product_item_sensitivity_type>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
</product_items>
</order>
<order>
<guid>MGP1704200142254</guid>
<otype>300-1</otype>
<from>subilong</from>
<sender_addres>GulouQu Darushijai</sender_addres>
<sender_province>Fujiansheng</sender_province>
<sender_city>Fuzhoushi</sender_city>
<sender_phone>13763813216</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kalynn Stiles</to>
<to_local />
<recipient_addres>25380 County Rd. 21A</recipient_addres>
<recipient_addres_local />
<recipient_country>United States</recipient_country>
<recipient_country_short>US</recipient_country_short>
<recipient_country_local />
<recipient_province>California</recipient_province>
<recipient_province_local />
<recipient_city>Esparto</recipient_city>
<recipient_city_local />
<recipient_postcode>95627</recipient_postcode>
<recipient_phone>(530)787-3999</recipient_phone>
<type_no>5</type_no>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<user_desc>烛台 Deng21 1;</user_desc>
<trade_amount>3.00</trade_amount>
<receive_from>苏碧龙</receive_from>
<receive_province>福建省</receive_province>
<receive_city>福州市</receive_city>
<receive_addres>鼓楼区大儒世家</receive_addres>
<receive_phone>13763813216</receive_phone>
<warehouse_code />
<doorpickup>1</doorpickup>
<product_items>
<product_item>
<wish_order_id>5a80417edf3b162557f66545</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>LED light</product_item_name>
<product_item_name_chinese>发光二极管</product_item_name_chinese>
<product_item_num>3</product_item_num>
<product_item_weight>0.15</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>1</product_item_has_battery>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
<product_item>
<wish_order_id>5a80417edf3b162557f66544</wish_order_id>
<product_item_from_country>China</product_item_from_country>
<product_item_name>head</product_item_name>
<product_item_name_chinese>帽子</product_item_name_chinese>
<product_item_num>2</product_item_num>
<product_item_weight>0.1</product_item_weight>
<product_item_single_price>2</product_item_single_price>
<product_item_has_battery>0</product_item_has_battery>
<product_item_product_url> https://www.wish.com/c/561f48726475cc5873cda03e</product_item_product_url>
</product_item>
</product_items>
</order>
</orders>
Success Response
<?xml version="1.0" ?>
<root>
<timestamp>2014-2-7 11:56:09</timestamp>
<status>0</status>
<wish_standard_tracking_id guid="12345" state="Created">WOSP000000022891AUS</wish_standard_tracking_id>
<barcode guid="12345" state="Created">PP001764319BJ</barcode>
<mark>1e191d851b3b49a248f4ea62f6b06410</mark>
<PDF_10_EN_URL>https://www.wishpost.cn/api/v2/download_label?access_token
=f06d703a71e4412aad8a579925aef656&format=10&use_local=false&mark
=7fcb4b1c5aa611e6932260a44c5bad70</PDF_10_EN_URL>
<PDF_10_LCL_URL>https://www.wishpost.cn/api/v2/download_label
?access_token=f06d703a71e4412aad8a579925aef656&format=10&use_local=true
&mark=7fcb4b1c5aa611e6932260a44c5bad70</PDF_10_LCL_URL>
</root>
or
<?xml version="1.0" ?>
<root>
<timestamp>2014-2-7 11:56:09</timestamp>
<status>0</status>
<wish_standard_tracking_id guid="12345" state="Created">WOSP000000022891AUS</wish_standard_tracking_id>
<barcode guid="12345" state="Reviewing"></barcode>
<mark>1e191d851b3b49a248f4ea62f6b06410</mark>
<PDF_10_EN_URL>https://www.wishpost.cn/api/v2/download_label?access_token
=f06d703a71e4412aad8a579925aef656&format=10&use_local=false&mark
=7fcb4b1c5aa611e6932260a44c5bad70</PDF_10_EN_URL>
<PDF_10_LCL_URL>https://www.wishpost.cn/api/v2/download_label
?access_token=f06d703a71e4412aad8a579925aef656&format=10&use_local=true
&mark=7fcb4b1c5aa611e6932260a44c5bad70</PDF_10_LCL_URL>
</root>
Error Response
<?xml version="1.0" ?>
<root>
<timestamp>2014-2-7 11:54:39</timestamp>
<status>1</status>
<error_message>Unauthorized Request</error_message>
<error_ref_id>c95b61820af911ec9bf20242ad102a67</error_ref_id>
</root>
or
<?xml version="1.0" encoding="utf-8"?>
<root>
<status>2</status>
<timestamp>2018/05/16 11:59:49</timestamp>
<error_message guid="0" code="1000" error_ref_id="5c7222b40af811ec8d220242ad102a67" wish_standard_tracking_id="">收件人邮编4501错误，印度的邮编是6位数字，如：456001</error_message>
<mark>9445c60a58bd11e880c90242ac110005</mark>
<PDF_10_EN_URL>https://www.wishpost.cn/api/v2/download_label?access_token=e7339bc2203f41fdbeaba7c78ba7e37e&format=10&use_local=false&mark=9445c60a58bd11e880c90242ac110005</PDF_10_EN_URL>
<PDF_10_LCL_URL>https://www.wishpost.cn/api/v2/download_label?access_token=e7339bc2203f41fdbeaba7c78ba7e37e&format=10&use_local=true&mark=9445c60a58bd11e880c90242ac110005</PDF_10_LCL_URL>
</root>
订单
Create an order
API endpoint: https://www.wishpost.cn/api/v2/create_order
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| api_key | string | 83-84 | Used to verify the identity. Please use v1 instead of v2 in the url. |
| mark | string | 0-50 | If you need multiple labels in one PDF file, please use the previous returned mark |
| bid | int | 0-99999 | Unique submission identifier provided by user |
| guid | string | 100 | Unique waybill identifier provided by user, returned together with waybill number |
| otype | string | 1-50 |
China Post Unregistered=0 China Post Registered=1 China Post Simplified Tracked Packet=1 -------------------------------------- DLE=10-1 EUB=11-1 MPAK=14-1 IB Express=21-1 IB Standard=22-1 Sinotrans=23-1 DHLe-PKG=30-0 DHLe-PPS=31-1 Wishpost EPC=36-1 Wishpost YunExpress=37-1 Wishpost WiseExpress=44-1 Sunyou Packet Registered=49-1(Online Payment) Sunyou Packet Unregistered=54-0(Online Payment) FlyT Registered Packet=55-1 FlyT Unregistered Packet=56-0 TopYou unregistered general cargo=77-0(Online Payment) TopYou unregistered special cargo=78-0(Online Payment) TopYou registered general cargo=79-1(Online Payment) TopYou registered special cargo=80-1(Online Payment) Europe Economy=200-0 Europe Standard=201-1 Wishpriority=300-1For more channels' otype, please call get channels API |
| platform | int | 0-100 |
Others=0 1688=1 AliExpress=2 Amazon=3 Cdiscount=4 DHgate=5 eBay=6 JD=7 Joom=8 Jumia=9 Lazada=10 magento=11 mymall=12 Rakuten=13 Shopee=14 Shopify=15 Shopline=16 tiki=17 Tophatter=18 UEESHOP=19 Vova=20 Walmart=21 Woocommerce=22 xshoppy=23 |
| non_wish_transaction_id | string | 0-100 | Other Platform Order ID |
| store_id | string | 0-100 | Store ID |
| from | string | 0-100 | Sender Name (cannot contain Chinese characters, default info in address book will be used if left blank) |
| sender_province | string | 0-100 | Sender Province (cannot contain Chinese characters, default info in address book will be used if left blank) |
| sender_city | string | 0-100 | Sender City (cannot contain Chinese characters, default info in address book will be used if left blank) |
| sender_district | string | 0-100 | Sender District (cannot contain Chinese characters, default info in address book will be used if left blank) |
| sender_addres | string | 0-100 | Sender Address (cannot contain Chinese characters, default info in address book will be used if left blank) |
| sender_phone | string | 0-20 | Sender Phone Number (Default info in address book will be used if left blank. Phone number could start with one + numbers can be connected with - or encapsulated by (). But could not contain any other mark or other language character.) |
| sender_zipcode | string | 1-200 | Sender postal code to contact for Collection(default info in address book will be used if left blank, if sender postal code is blank in address, 310000 will be used as default) |
| sender_tax_id | string | 1-200 | Sender tax id, this field is required for UK non Wish order.For orders placed after 2021/6/15, if the destination country is EU member, and the total net selling price of goods is equal to or greater than 150 euro, please fill in with the following rules: if the seller pays the import tariff, fill in this field;If the buyer pays the import tariff, this field may not be filled in or passed in. |
| sender_eori | string | 1-200 | Sender EORI (this fieldis required for UK non wish order) |
| pickup_service | string | 1-100 | Pick Up Service for EPC/A+, if choose Collection, must fill in 25-1(IVPX PICKUP) or 27-1(WISE PICKUP) or 42-0(YANWEN PICKUP), if choose self deliver, this field can be noneFor Other channels, wipe this field out |
| pickup_from_local | string | 1-100 | Sender Name to Collect Parcel From (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_phone | string | 1-250 | Sender Phone to contact for Collection (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_zip_code | string | 1-200 | Sender postal code to contact for Collection |
| pickup_addres_local | string | 1-200 | Sender Address to Collect Parcel From (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_province_local | string | 1-1000 | Sender Province to Collect Parcel From (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_city_local | string | 1-1000 | Sender City to Collect Parcel From (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_district_local | string | 1-1000 | Sender District to Collect Parcel From |
| pickup_from | string | 1-100 | Sender Name to Collect Parcel From |
| pickup_addres | string | 1-200 | Sender Address to Collect Parcel From |
| pickup_province | string | 1-1000 | Sender Province to Collect Parcel From |
| pickup_city | string | 1-1000 | Sender City to Collect Parcel From |
| pickup_district | string | 1-1000 | Sender District to Collect Parcel From |
| pickup_country_local | string | 1-500 | Sender Country to Collect Parcel From |
| pickup_country | string | 1-500 | Sender Country to Collect Parcel From |
| pickup_country_code | string | 3 | Sender Country ISO3 Code to Collect Parcel From |
| return_action_in_country | int | 0,2,3 | Return action in country: 0-abandon，2-return to pickup address，3-return to return address(return address info required) |
| reverse_logistics_mode | int | 1,3 | Return logistics mode: 1-return by pickup carrier，3-return via express prepaid |
| return_name_local | string | 1-100 | Return local name, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_phone | string | 1-20 | Return phone number, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_zipcode | string | 1-200 | Return zip code, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value contact for Collection |
| return_address_local | string | 1-200 | Return local address, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_province_local | string | 1-1000 | Return local province, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_city_local | string | 1-1000 | Return local city, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_district_local | string | 1-1000 | Return local district, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| to | string | 1-100 | Recipient Name |
| recipient_country | string | 1-50 | Recipient Country (in English),optional for Wishpost EPC channel |
| recipient_country_short | string | 1-3 | Recipient Country Shortcode (e.g. US, GB, UK),optional for Wishpost EPC channel |
| recipient_province | string | 1-100 | Recipient Province/State (in English),optional for Wishpost EPC channel |
| recipient_city | string | 1-100 | Recipient City (in English),optional for Wishpost EPC channel |
| recipient_district | string | 1-100 | Recipient City (in English),optional |
| recipient_addres | string | 1-100 | Recipient Address (in English),optional for Wishpost EPC channel |
| recipient_postcode | string | 1-10 | Recipient Postal Code/ZIP,optional for Wishpost EPC channel |
| recipient_phone | string | 1-20 | Recipient Phone Number(Phone number could start with one + numbers can be connected with - or encapsulated by (). But could not contain any other mark or other language character.),optional for Wishpost EPC channel |
| recipient_email | string | 1-50 | Recipient Email (email must contain @,required for Wishpost Nile channel) |
| to_local | string | 1-100 | Recipient Name (use recipient country’s language, if left blank, use English) |
| recipient_country_local | string | 0-50 | Recipient Country (use recipient country’s language, if left blank, use English) |
| recipient_province_local | string | 0-100 | Recipient Province/State (use recipient country’s language, if left blank, use English) |
| recipient_city_local | string | 0-100 | Recipient City (use recipient country’s language, if left blank, use English) |
| recipient_district_local | string | 0-100 | Recipient District (use recipient country’s language, if left blank, use English) |
| recipient_addres_local | string | 0-100 | Recipient Address (use recipient country’s language, if left blank, use English) |
| type_no | int | 1 | |
| from_country | string | string | Product’s original country (in English) |
| content | string | 1-100 | Product’s detailed name (in English), which must contain at least one English character |
| content_chinese | string | 1-50 | Product’s detailed name (mandatory, must contains Chinese) |
| num | int | 1-99999 | Product Quantity |
| unit_measurement | string | 0-20 | Unit Of Measurement |
| unit_measurement_chinese | string | 0-20 | Unit Of Measurement in Chinese |
| weight | float | 0-2.000 | Product Weight (in kg, to 3 decimal places) |
| single_price | money | 0-99999.00 | Product Price (to 2 decimal places),UK needs to fill in the pound value; For orders placed between 2021/6/15 and 2021/6/30, the destination country is the EU member, the declared value is still in US dollars.For orders placed after 2021/7/1 with the destination country is EU member,the declared value needs to fill in the euro value |
| currency | string | 1-200 | Declared value currency.this field is not required ('gbp' for UK,'eur' for orders placed after 2021/7/1 with the destination country is EU member'usd' for the left countries currency） |
| trande_no | string | 1-499 |
Ｗish order ID in Wish merchant dashboard， mandatory for all channels. This field must be a string only containing English and numeric characters, with English comma to separate multiple ids if there are. No extra space characters are allowed in the middle of it. If this order does not belong to Wish platform, please provide default value as NonWishOrder(no limit in upper/lower case), please be noted this logistics order will not be able to fulfilled into Wish merchant dashboard; If this order does belong to Wish platform, please correctly provide the 24-char Wish order ID provided by Wish merchant dashboard. This field support a single ID, such as 56f1205a44dc6fb51631f26f; or multiple IDs (20 at most), such as 56f1205a44dc6fb51631f26f,56f1205a44dc6fb51631f26f. |
| trade_amount | money | 0-99999.00 | Trade amount on Wish (Unit: US dollar), including product value and shipping fee |
| orders_bag_number | string | 21 |
WishPost bag number, from the response of 'Create Orders Bag' api, like WI2019110400000123BAG. Only required for STO channel(2801). |
| user_desc | string | 0-500 | Merchant-defined Information, such as merchant order ID, product ID, location ID |
| receive_from | string | 0-100 | Courier Contact (Must be in Chinese) |
| receive_province | string | 0-100 | Courier Province Name (Must be in Chinese) |
| receive_city | string | 0-100 | Courier Country Name (Must be in Chinese) |
| receive_district | string | 0-100 | Courier Country Name (Must be in Chinese) |
| receive_addres | string | 0-100 | Courier Information (Must be in Chinese) |
| receive_phone | string | 0-20 | Courier Phone Number |
| buyer_tax_id | string | 1-100 | Buyer tax id, optional |
| warehouse_code | int | 0-10 |
Warshouse code(Mandatory for China Post and IB) ---------------------------------------------------------------- Below are China Post Registered/Unregistered Warehouses: 1=Shanghai 2=Guangzhou 3=Shenzhen 4=Yiwu 5=Beijing 6=Nanjing 7=Fuzhou 8=Qingdao 9=Wuhan 10=Dongguan 11=Hangzhou 12=Jinhua 13=Ningbo 14=Wenzhou 15=Xiamen 16=Chongqing 17=Tianjin 18=Suzhou 19=Hefei 20=Changsha 21=Zhengzhou 22=Chengdu 23=Xuchang 24=Quanzhou 25=Foshan 26=Zhangpu 29=Wuxi 30=Nanyang 31=Shijiazhuang 32=Jingzhou 33=Nanchang 34=Dalian 35=Jinan 36=Yichang 37=Nantong 38=Zhongshan --------------------------------------------------------------- Below are IB Standard/Express Warehouses: 27=EastChina 28=SouthChina |
| doorpickup | int | 1 |
Door pickup method 0=Customer Drop Off 1=Door Pickup 2=Pending |
| has_battery | int | 1 |
Has battery or not, Mandatory 0=Without battery, 1=With battery EPC order with sentitive goods should use 1 as well EPC sensitive goods list: https://s3.cn-north-1.amazonaws.com.cn/wishpost-production-wishpost-announcement/EPC特货清单.xlsx |
| sensitivity_type | int | 2 |
Product sensitivity type, 0=General Cargo, 1=Has Battery 2=Sensitive If the value of sensitivity_type is smaller than has_battery,We will use has_battery as the value of this field.Otherwise, an error will be returned.Sensitivity type list: https://wishpost-data.s3.cn-north-1.amazonaws.com.cn/manual/special_sensitive%2Bdefinition.xlsx |
| product_url | string | string | Product url(Mandatory) |
| product_hs_code | string | string | Product HS Code |
| sender_ioss_vat_id | string | string | The sender's IOSS vat id, which is the unique number of the VAT payerregistered in the EU Member States. After 2021/6/15, required when 1）2）3） are met. 1) the destination countryis EU member; 2) the net selling price of goods in the invoice is less than 150 euro; 3) Non Wish order |
| intrinsic_value | money | Intrinsic Value (Euro),which is the totalproduct item intrinsic value of goods listed in the invoice of sales platform (unit price of goods * quantity of goods, excluding tax, freight, insurance, etc.).After 2021/6/15, required when 1) 2) are met: 1) destination country is EU member, 2) Non Wish order | |
| intrinsic_vat_amount | money | Intrinsic Vat Amount, Optional, default is 0 | |
| total_transport_value | money | Total Transport Value, Optional, default is 0 | |
| total_transport_vat_amount | money | Total Transport Vat Amount, Optional, default is 0 |
Response
| Parameter name | Description |
|---|---|
| Timestamp | Timestamp |
| Status | Status |
| wish_standard_tracking_id | WOSP Order Number |
| barcode | Waybill Number |
| warehouse | Combine Warehouse |
| mark | mark |
| PDF_10_EN_URL | PDF Label 10*10 English Version Download URL |
| PDF_10_LCL_URL | PDF Label 10*10 Recipient Country Download URL |
| error_message | Error message |
| PDF_15_EN_URL | PDF Label 10*5 Download URL |
| recipient_country | Recipient Country |
| recipient_country_short | Recipient Country Code |
| c_code | Product Code |
| q_code | Channel Code |
| y_ code | Verification Code |
| user_desc | User-defined Information |
| reference_qrcode | Sweden reference QRcode |
| error_ref_id | Error Reference Id |
Example Request
<?xml version="1.0" ?>
<orders>
<access_token>f06d703a71e4412aad8a579925aef656</access_token>
<mark/>
<bid>0</bid>
<order>
<guid>12345</guid>
<otype>0</otype>
<from>ZENG WEI</from>
<sender_addres>756 ROOM 2 DANYUAN MEILONGYUAN LONGHUA</sender_addres>
<sender_province>GUANGDONG</sender_province>
<sender_city>SHENZHEN</sender_city>
<sender_phone>18620352867</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kali West</to>
<to_local>Kali West</to_local>
<recipient_addres>20/37 Gerrale Street</recipient_addres>
<recipient_addres_local>20/37 Gerrale Street</recipient_addres_local>
<recipient_country>Germany</recipient_country>
<recipient_country_short>DE</recipient_country_short>
<recipient_country_local>Germany</recipient_country_local>
<recipient_province>Berlin</recipient_province>
<recipient_province_local>Berlin</recipient_province_local>
<recipient_city>Berlin</recipient_city>
<recipient_city_local>Berlin</recipient_city_local>
<recipient_postcode>2230</recipient_postcode>
<recipient_phone>11</recipient_phone>
<content>LED light</content>
<content_chinese>发光二极管</content_chinese>
<type_no>5</type_no>
<weight>0.15</weight>
<num>5</num>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<single_price>2</single_price>
<from_country>China</from_country>
<user_desc>asgfdgs</user_desc>
<trande_no>1534563462</trande_no>
<trade_amount>11.45</trade_amount>
<doorpickup>1</doorpickup>
<warehouse_code>1</warehouse_code>
<sender_ioss_vat_id>xxxxx</sender_ioss_vat_id>
<total_transport_value>12.02</total_transport_value>
<total_transport_vat_amount>3.03</total_transport_vat_amount>
<intrinsic_value>24.01</intrinsic_value>
<intrinsic_vat_amount>3.03</intrinsic_vat_amount>
</order>
<order>
<guid>12346</guid>
<otype>1</otype>
<from>ZENG WEI</from>
<sender_province>GUANGDONG</sender_province>
<sender_city>SHENZHEN</sender_city>
<sender_addres>756 ROOM 2 DANYUAN MEILONGYUAN LONGHUA</sender_addres>
<sender_phone>18620352867</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kali West</to>
<to_local>Kali West</to_local>
<recipient_addres>20/37 Gerrale Street</recipient_addres>
<recipient_addres_local>20/37 Gerrale Street</recipient_addres_local>
<recipient_country>Australia</recipient_country>
<recipient_country_short>AU</recipient_country_short>
<recipient_country_local>Australia</recipient_country_local>
<recipient_province>New South Wales</recipient_province>
<recipient_province_local>New South Wales</recipient_province_local>
<recipient_city>Cronulla</recipient_city>
<recipient_city_local>Cronulla</recipient_city_local>
<recipient_postcode>2230</recipient_postcode>
<recipient_phone>11</recipient_phone>
<content>LED light</content>
<content_chinese>发光二极管</content_chinese>
<type_no>5</type_no>
<weight>0.15</weight>
<num>5</num>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<single_price>2</single_price>
<from_country>China</from_country>
<user_desc>something</user_desc>
<trande_no>1534563462</trande_no>
<trade_amount>11.45</trade_amount>
<receive_from>许勤</receive_from>
<receive_province>广东</receive_province>
<receive_city>深圳</receive_city>
<receive_addres>福田区福中三路市民中心大楼</receive_addres>
<receive_phone>12345</receive_phone>
<doorpickup>1</doorpickup>
<warehouse_code>2</warehouse_code>
</order>
<order>
<guid>12347</guid>
<otype>9-0</otype>
<from>ZENG WEI</from>
<sender_province>GUANGDONG</sender_province>
<sender_city>SHENZHEN</sender_city>
<sender_addres>756 ROOM 2 DANYUAN MEILONGYUAN LONGHUA</sender_addres>
<sender_phone>18620352867</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kali West</to>
<to_local>Kali West</to_local>
<recipient_addres>20/37 Gerrale Street</recipient_addres>
<recipient_addres_local>20/37 Gerrale Street</recipient_addres_local>
<recipient_country>Australia</recipient_country>
<recipient_country_short>AU</recipient_country_short>
<recipient_country_local>Australia</recipient_country_local>
<recipient_province>New South Wales</recipient_province>
<recipient_province_local>New South Wales</recipient_province_local>
<recipient_city>Cronulla</recipient_city>
<recipient_city_local>Cronulla</recipient_city_local>
<recipient_postcode>2230</recipient_postcode>
<recipient_phone>11</recipient_phone>
<content>LED light</content>
<content_chinese>发光二极管</content_chinese>
<type_no>5</type_no>
<weight>0.15</weight>
<num>5</num>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<single_price>2</single_price>
<from_country>China</from_country>
<user_desc>something</user_desc>
<trande_no>1534563462</trande_no>
<trade_amount>11.45</trade_amount>
<doorpickup>1</doorpickup>
</order>
<order>
<guid>12348</guid>
<otype>10-0</otype>
<from>ZENG WEI</from>
<sender_province>GUANGDONG</sender_province>
<sender_city>SHENZHEN</sender_city>
<sender_addres>756 ROOM 2 DANYUAN MEILONGYUAN LONGHUA</sender_addres>
<sender_phone>18620352867</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kali West</to>
<to_local>Jaden Smith</to_local>
<recipient_addres>322 Edge Street</recipient_addres>
<recipient_addres_local>322 Edge Street</recipient_addres_local>
<recipient_country>United States</recipient_country>
<recipient_country_short>US</recipient_country_short>
<recipient_country_local>United States</recipient_country_local>
<recipient_province>South Carolina</recipient_province>
<recipient_province_local>South Carolina</recipient_province_local>
<recipient_city>Columbia</recipient_city>
<recipient_city_local>Columbia</recipient_city_local>
<recipient_postcode>29201</recipient_postcode>
<recipient_phone>11</recipient_phone>
<content>LED light</content>
<content_chinese>发光二极管</content_chinese>
<type_no>5</type_no>
<weight>0.15</weight>
<num>5</num>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<single_price>2</single_price>
<from_country>China</from_country>
<user_desc>something</user_desc>
<trande_no>1534563462</trande_no>
<trade_amount>11.45</trade_amount>
<doorpickup>1</doorpickup>
</order>
<order>
<guid>12349</guid>
<otype>11-0</otype>
<from>ZENG WEI</from>
<sender_province>GUANGDONG</sender_province>
<sender_city>SHENZHEN</sender_city>
<sender_addres>756 ROOM 2 DANYUAN MEILONGYUAN LONGHUA</sender_addres>
<sender_phone>18620352867</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kali West</to>
<to_local>Kali West</to_local>
<recipient_addres>20/37 Gerrale Street</recipient_addres>
<recipient_addres_local>20/37 Gerrale Street</recipient_addres_local>
<recipient_country>Australia</recipient_country>
<recipient_country_short>AU</recipient_country_short>
<recipient_country_local>Australia</recipient_country_local>
<recipient_province>New South Wales</recipient_province>
<recipient_province_local>New South Wales</recipient_province_local>
<recipient_city>Cronulla</recipient_city>
<recipient_city_local>Cronulla</recipient_city_local>
<recipient_postcode>2230</recipient_postcode>
<recipient_phone>11</recipient_phone>
<content>LED light</content>
<content_chinese>发光二极管</content_chinese>
<type_no>5</type_no>
<weight>0.15</weight>
<num>5</num>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<single_price>2</single_price>
<from_country>China</from_country>
<user_desc>something</user_desc>
<trande_no>1534563462</trande_no>
<trade_amount>11.45</trade_amount>
<doorpickup>1</doorpickup>
</order>
<order>
<guid>MGP1704200142254</guid>
<otype>21-1</otype>
<warehouse_code>27</warehouse_code>
<pickup_from_local>苏蕙</pickup_from_local>
<pickup_addres_local>鼓楼区 新三路987弄3号201室</pickup_addres_local>
<pickup_province_local>福建省</pickup_province_local>
<pickup_city_local>福州市</pickup_city_local>
<pickup_phone>13763813216</pickup_phone>
<from>subilong</from>
<sender_addres>GulouQu Darushijai</sender_addres>
<sender_province>Fujiansheng</sender_province>
<sender_city>Fuzhoushi</sender_city>
<sender_phone>13763813216</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kalynn Stiles</to>
<to_local />
<recipient_addres>25380 County Rd. 21A</recipient_addres>
<recipient_addres_local />
<recipient_country>United States</recipient_country>
<recipient_country_short>US</recipient_country_short>
<recipient_country_local />
<recipient_province>California</recipient_province>
<recipient_province_local />
<recipient_city>Esparto</recipient_city>
<recipient_city_local />
<recipient_postcode>95627</recipient_postcode>
<recipient_phone>(530)787-3999</recipient_phone>
<content>Geneva Fashion Women Small Steel Band Analog Quartz Wrist Watch Watches</content>
<content_chinese>手表</content_chinese>
<type_no>5</type_no>
<weight>0.6</weight>
<num>1</num>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<single_price>3.00</single_price>
<from_country>China</from_country>
<user_desc>手表 Deng21 1;</user_desc>
<trande_no>595db7cb723b301bb9013584</trande_no>
<trade_amount>3.00</trade_amount>
<receive_from>苏碧龙</receive_from>
<receive_province>福建省</receive_province>
<receive_city>福州市</receive_city>
<receive_addres>鼓楼区大儒世家</receive_addres>
<receive_phone>13763813216</receive_phone>
<doorpickup>1</doorpickup>
<product_url>https://www.wish.com/c/575d15bb51127360e5c56921</product_url>
<has_battery>0</has_battery>
<sensitivity_type>0</sensitivity_type>
</order>
<order>
<guid>12345</guid>
<otype>33-0</otype>
<from>ZENG WEI</from>
<sender_addres>756 ROOM 2 DANYUAN MEILONGYUAN LONGHUA</sender_addres>
<sender_province>GUANGDONG</sender_province>
<sender_city>SHENZHEN</sender_city>
<sender_phone>18620352867</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kali West</to>
<to_local>Kali West</to_local>
<recipient_addres>20/37 Gerrale Street</recipient_addres>
<recipient_addres_local>20/37 Gerrale Street</recipient_addres_local>
<recipient_country>Australia</recipient_country>
<recipient_country_short>AU</recipient_country_short>
<recipient_country_local>Australia</recipient_country_local>
<recipient_province>New South Wales</recipient_province>
<recipient_province_local>New South Wales</recipient_province_local>
<recipient_city>Cronulla</recipient_city>
<recipient_city_local>Cronulla</recipient_city_local>
<recipient_postcode>2230</recipient_postcode>
<recipient_phone>11</recipient_phone>
<content>LED light</content>
<content_chinese>发光二极管</content_chinese>
<type_no>5</type_no>
<weight>0.15</weight>
<num>5</num>
<single_price>2</single_price>
<from_country>China</from_country>
<user_desc>asgfdgs</user_desc>
<trande_no>1534563462</trande_no>
<trade_amount>11.45</trade_amount>
<doorpickup>1</doorpickup>
<warehouse_code>1</warehouse_code>
</order>
<order>
<guid>MGP1704200142254</guid>
<otype>300-1</otype>
<from>subilong</from>
<sender_addres>GulouQu Darushijai</sender_addres>
<sender_province>Fujiansheng</sender_province>
<sender_city>Fuzhoushi</sender_city>
<sender_phone>13763813216</sender_phone>
<sender_zipcode>310000</sender_zipcode>
<to>Kalynn Stiles</to>
<to_local />
<recipient_addres>25380 County Rd. 21A</recipient_addres>
<recipient_addres_local />
<recipient_country>United States</recipient_country>
<recipient_country_short>US</recipient_country_short>
<recipient_country_local />
<recipient_province>California</recipient_province>
<recipient_province_local />
<recipient_city>Esparto</recipient_city>
<recipient_city_local />
<recipient_postcode>95627</recipient_postcode>
<recipient_phone>(530)787-3999</recipient_phone>
<content>Candlestick Deng21</content>
<type_no>5</type_no>
<weight>0.300</weight>
<num>1</num>
<unit_measurement>item</unit_measurement>
<unit_measurement_chinese>个</unit_measurement_chinese>
<single_price>5.00</single_price>
<from_country>China</from_country>
<user_desc>烛台 Deng21 1;</user_desc>
<trande_no>58f797a22a600eb9455ae5e8</trande_no>
<trade_amount>3.00</trade_amount>
<receive_from>苏碧龙</receive_from>
<receive_province>福建省</receive_province>
<receive_city>福州市</receive_city>
<receive_addres>鼓楼区大儒世家</receive_addres>
<receive_phone>13763813216</receive_phone>
<warehouse_code />
<doorpickup>1</doorpickup>
<product_url>https://www.wish.com/c/
579726aa9a99900b221cb2dc</product_url>
<has_battery>0</has_battery>
<sensitivity_type>0</sensitivity_type>
</order>
</orders>
Success Response
<?xml version="1.0" ?>
<root>
<timestamp>2014-2-7 11:56:09</timestamp>
<status>0</status>
<wish_standard_tracking_id guid="12345" state="Created">WOSP000000022891AUS</wish_standard_tracking_id>
<barcode guid="12345" state="Created">PP001764319BJ</barcode>
<warehouse warehouse_code="1004">华东2仓</warehouse>
<mark>1e191d851b3b49a248f4ea62f6b06410</mark>
<PDF_10_EN_URL>https://www.wishpost.cn/api/v2/download_label?access_token
=f06d703a71e4412aad8a579925aef656&format=10&use_local=false&mark
=7fcb4b1c5aa611e6932260a44c5bad70</PDF_10_EN_URL>
<PDF_10_LCL_URL>https://www.wishpost.cn/api/v2/download_label
?access_token=f06d703a71e4412aad8a579925aef656&format=10&use_local=true
&mark=7fcb4b1c5aa611e6932260a44c5bad70</PDF_10_LCL_URL>
</root>
or
<?xml version="1.0" ?>
<root>
<timestamp>2014-2-7 11:56:09</timestamp>
<status>0</status>
<wish_standard_tracking_id guid="12345" state="Created">WOSP000000022891AUS</wish_standard_tracking_id>
<barcode guid="12345" state="Reviewing"></barcode>
<warehouse warehouse_code="1004">华东2仓</warehouse>
<mark>1e191d851b3b49a248f4ea62f6b06410</mark>
<PDF_10_EN_URL>https://www.wishpost.cn/api/v2/download_label?access_token
=f06d703a71e4412aad8a579925aef656&format=10&use_local=false&mark
=7fcb4b1c5aa611e6932260a44c5bad70</PDF_10_EN_URL>
<PDF_10_LCL_URL>https://www.wishpost.cn/api/v2/download_label
?access_token=f06d703a71e4412aad8a579925aef656&format=10&use_local=true
&mark=7fcb4b1c5aa611e6932260a44c5bad70</PDF_10_LCL_URL>
</root>
Error Response
<?xml version="1.0" ?>
<root>
<timestamp>2014-2-7 11:54:39</timestamp>
<status>1</status>
<error_message>Unauthorized Request</error_message>
<error_ref_id>c95b61820af911ec9bf20242ad102a67</error_ref_id>
</root>
or
<?xml version="1.0" encoding="utf-8"?>
<root>
<status>2</status>
<timestamp>2018/05/16 11:59:49</timestamp>
<error_message guid="0" code="1000" error_ref_id="5c7222b40af811ec8d220242ad102a67" wish_standard_tracking_id="">收件人邮编4501错误，印度的邮编是6位数字，如：456001</error_message>
<mark>9445c60a58bd11e880c90242ac110005</mark>
<PDF_10_EN_URL>https://www.wishpost.cn/api/v2/download_label?access_token=e7339bc2203f41fdbeaba7c78ba7e37e&format=10&use_local=false&mark=9445c60a58bd11e880c90242ac110005</PDF_10_EN_URL>
<PDF_10_LCL_URL>https://www.wishpost.cn/api/v2/download_label?access_token=e7339bc2203f41fdbeaba7c78ba7e37e&format=10&use_local=true&mark=9445c60a58bd11e880c90242ac110005</PDF_10_LCL_URL>
</root>
更新揽收方式
Confirm Collection Option
API endpoint: https://www.wishpost.cn/api/v3/order/collection_option/confirm
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| wish_standard_tracking_id | string | wishpost standard tracking id, must be provided | |
| doorpickup | int | 0,1 |
collcetion option, must be provided 0=Customer Drop Off 1=Door Pickup |
| pickup_service | string | 1-100 | Pick Up Service for EPC/A+, if choose Collection, must fill in 25-1(IVPX PICKUP) or 27-1(WISE PICKUP) or 42-0(YANWEN PICKUP), if choose self deliver, this field can be noneFor Other channels, wipe this field out |
| return_action_in_country | int | 0,2,3 | Return action in country: 0-abandon，2-return to pickup address，3-return to return address(return address info required) |
| reverse_logistics_mode | int | 1,3 | Return logistics mode: 1-return by pickup carrier，3-return via express prepaid |
| pickup_address | dictionary | Pickup address | |
| pickup_from_local | string | 1-100 | Sender Name to Collect Parcel From (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_phone | string | 1-250 | Sender Phone to contact for Collection (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_zipcode | string | 1-200 | Sender postal code to contact for Collection |
| pickup_address_local | string | 1-200 | Sender Address to Collect Parcel From (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_province_local | string | 1-1000 | Sender Province to Collect Parcel From (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_city_local | string | 1-1000 | Sender City to Collect Parcel From (Mandatory for Sinotrans, IB, EPC, YunExpress and Wiseexpresschannels) |
| pickup_district_local | string | 1-1000 | Sender District to Collect Parcel From |
| return_address | dictionary | Return address | |
| return_name_local | string | 1-100 | Return local name, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_phone | string | 1-20 | Return phone number, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_zipcode | string | 1-200 | Return zip code, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value contact for Collection |
| return_address_local | string | 1-200 | Return local address, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_province_local | string | 1-1000 | Return local province, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_city_local | string | 1-1000 | Return local city, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
| return_district_local | string | 1-1000 | Return local district, may go in http://www.wishpost.cn/home/#/user/fpl-return-plan set default value |
Response
| Parameter name | Description |
|---|---|
| timestamp | Timestamp |
| message | Message |
| code | Code |
Example Request
{
"access_token": "e7339bc2203f41fdbeaba7c78ba7e37e",
"wish_standard_tracking_id": "WOSP028349251703CHN",
"doorpickup": 1,
"pickup_service": "42-0",
"pickup_address": {
"pickup_from_local": "苏碧龙",
"pickup_province_local": "福建省",
"pickup_district_local": "鼓楼区",
"pickup_city_local": "福州市",
"pickup_phone": 1343234921,
"pickup_zipcode": 123456
},
"return_action_in_country": 3,
"reverse_logistics_mode": 1,
"return_address": {
"return_name_local": "苏碧龙",
"return_address_local": "鼓楼区大儒世家",
"return_province_local": "福建省",
"return_district_local": "鼓楼区",
"return_city_local": "福州市",
"return_phone": 1343234921,
"return_zipcode": 123456
}
}
Success Response
{
"timestamp": "2021-09-26 13:52:40",
"message": "揽收信息更新成功，可稍后查询该订单状态。",
"code": 0
}
Error Response
{
"timestamp": "2021-05-20 16:51:56",
"message": "Required Param 'warehouse_ids' Missing",
"code": 1001
}
{
"timestamp": "2021-05-20 16:35:05",
"message": "xyz is an invalid integer",
"code": 1000
}
{
"timestamp": "2021-05-20 16:46:41",
"message": "No valid warehouse id found.",
"code": 30
}
订单状态
Get order status
API endpoint: https://www.wishpost.cn/api/v3/order_status
Method: POST
Throttling
| Max Requests | Limit Period | Limit Level |
|---|---|---|
| 30 | 1 minute | IP + User |
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| wish_standard_tracking_ids | list | 1-500 | Wish Standard Tracking Id list, either wish standard tracking id list or wish transaction id List must be provided |
| wish_transaction_ids | list | 1-10 | Wish Transaction Id list, either wish standard tracking id list or wish transaction id List must be provided |
Response
| Parameter name | Description |
|---|---|
| timestamp | Timestamp |
| message | Message |
| code | Code |
| wish_standard_tracking_id | wish standard tracking id |
| logistics_order_code | Logistics Order Code |
| wish_transaction_ids | wish transaction ids |
| state_code | State Code |
| state_name | State Name |
| cancel_reason_code | Cancel Reason Code |
| cancel_fail_reason | Cancel Fail Reason |
| reference_qrcode | Sweden reference QRcode |
| message | Detail Information |
| PDF_10_EN_URL | PDF Label 10*10 English Version Download URL |
| PDF_10_LCL_URL | PDF Label 10*10 Recipient Country Download URL |
| dest_warehouse_code | Destination Warehouse Code |
| dest_warehouse_name | Destination Warehouse Name |
| dest_warehouse_address_cn | Destination Warehouse Address CN |
| hub_warehouse_code | Transfer Hub Warehouse code |
Appendix
| Status Code | State Name |
|---|---|
| 0 | Error |
| 1 | Created |
| 2 | Invalid |
| 3 | Rejected |
| 4 | Canceled |
| 5 | Reviewing |
| 6 | Accepted |
| 7 | Shipping |
| 8 | Completed |
Example Request
{
"access_token": "b1c18f0ba16b44c0bf6a16733da4a36f",
"wish_standard_tracking_ids": [
"WOSP000644993647IND",
"WOSP000644993649IND",
"WOSP000644993648IND",
"WOSP000000023915USA"
]
}
Success Response
{
"timestamp": "2019-07-19 10:27:12",
"message": "Some orders are not found. Some orders are not accepted. ",
"code": 0,
"orders": [
{
"wish_standard_tracking_id": "WOSP000000023915USA",
"logistics_order_code": "",
"wish_transaction_ids": ["5ebace9cbb9ef57e001c36a3"]
"state_name": "Rejected",
"state_code": 3,
"cancel_reason_code": "",
"cancel_fail_reason": "",
"message": "",
"reference_qrcode": "",
"PDF_10_LCL_URL": "",
"PDF_10_EN_URL": "",
"dest_warehouse_code": 27,
"dest_warehouse_name": "",
"hub_warehouse_code": "",
"dest_warehouse_address_cn": {
"province": "上海",
"city": "上海市",
"name": "Wish EPC华东1仓",
"district": "宝山区",
"zipcode": "201901",
"address": "上海市宝山区共悦路419号",
"phone_number": "+8613816792755",
"email": null
}
}
]
}
Error Response
{
"timestamp": "2018-03-09 12:24:17",
"message": "No valid wish_standard_tracking_ids is provided",
"code": 1001,
"orders": []
}
Cancel Orders
Cancel Orders
API endpoint: https://www.wishpost.cn/api/v3/cancel_orders
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| orders | list | 1-100 | List of order dict to cancel |
| tracking_id | string | 1-100 | Order tracking id, required |
| wish_standard_tracking_id | string | 1-100 | wish standard tracking id, required |
| cancel_reason_code | int | 40100-49999 | Order cancel reason code, required |
| invalid_reason | string | 1-200 | Order cancel reason, when cancel_reason_code is not 49999, not required; otherwise, required. |
Response
| Parameter name | Description |
|---|---|
| timestamp | Timestamp |
| message | Message |
| code | Code |
| is_cancelling_orders | Is Cancelling Orders |
| failed_cancel_orders | Failed Cancel Orders |
| tracking_id | Tracking id |
| wish_standard_tracking_id | Wish Standard Tracking id |
| cancel_result_code | Cancel Reason Code |
| cancel_result_message | Cancel Fail Reason |
Appendix
| Order Cancel Reason Code | Order Cancel Reason Message |
|---|---|
| 40101 | Error |
| 40102 | Created |
| 40103 | Invalid |
| 40104 | Rejected |
| 40105 | Canceled |
| 40106 | Reviewing |
| 40107 | Accepted |
| 40201 | Shipping |
| 40202 | Completed |
| 40203 | Completed |
| 40204 | Completed |
| 40205 | Completed |
| 40206 | Completed |
| 40301 | Completed |
| 40302 | Completed |
| 40303 | Completed |
| 40304 | Completed |
| 40305 | Completed |
| 40401 | Completed |
| 40402 | Completed |
| 40403 | Completed |
| 40404 | Completed |
| 40405 | Completed |
| 49999 | Completed |
Example Request
{
"access_token": "efb1825cf6114ab29ea34baace173881",
"orders": [
{
"tracking_id":"WI000000022037EPC",
"cancel_reason_code":40101
}
]
}
Success Response
{
"timestamp": "2020-05-20 18:57:33",
"message": "All the orders' cancel results are fetched.",
"code": 0,
"failed_cancel_orders": [
{
"cancel_result_code": 3,
"wish_standard_tracking_id": "WOSP000000333733CHN",
"cancel_result_message": "Failed. The order is already invalidated",
"user_id": "5ae3d0f1f5113220822a5c94",
"tracking_id": "WI000000022037EPC"
}
],
"is_cancelling_orders": []
}
Error Response
{
"timestamp": "2018-03-09 12:24:17",
"message": "tracking_id must be provided",
"code": 1001,
"is_cancelling_orders": [],
"failed_cancel_orders": []
}
EPC仓库
Get EPC warehouse table
API endpoint: https://www.wishpost.cn/api/v3/epc_warehouse_table
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
Response
| Parameter name | Description |
|---|---|
| epc_warehouse_code | EPC Warehouse Code |
| epc_warehouse_name | EPC Warehouse Name |
Example Request
{
"access_token": "e7339bc2203f41fdbeaba7c78ba7e37e"
}
Success Response
{
"timestamp": "2019-07-23 10:57:38",
"message": "",
"code": 0,
"epc_warehouse_table": [
{
"epc_warehouse_code": 1001,
"epc_warehouse_name": "华东1仓"
},
{
"epc_warehouse_code": 1003,
"epc_warehouse_name": "华南1仓"
},
{
"epc_warehouse_code": 1004,
"epc_warehouse_name": "华东2仓"
},
{
"epc_warehouse_code": 1005,
"epc_warehouse_name": "华南2仓"
},
{
"epc_warehouse_code": 1006,
"epc_warehouse_name": "华南4仓"
},
{
"epc_warehouse_code": 1007,
"epc_warehouse_name": "华南5仓"
},
{
"epc_warehouse_code": 1008,
"epc_warehouse_name": "华南3仓"
},
{
"epc_warehouse_code": 1009,
"epc_warehouse_name": "华南6仓"
},
{
"epc_warehouse_code": 1010,
"epc_warehouse_name": "华东3仓"
},
{
"epc_warehouse_code": 1011,
"epc_warehouse_name": "华东BLUE 1仓"
},
{
"epc_warehouse_code": 1012,
"epc_warehouse_name": "华南7仓"
},
{
"epc_warehouse_code": 1013,
"epc_warehouse_name": "华南8仓"
},
{
"epc_warehouse_code": 1014,
"epc_warehouse_name": "华南BLUE 1仓"
},
{
"epc_warehouse_code": 1015,
"epc_warehouse_name": "华南9仓"
},
{
"epc_warehouse_code": 1016,
"epc_warehouse_name": "华南10仓"
},
{
"epc_warehouse_code": 1017,
"epc_warehouse_name": "华南11仓"
},
{
"epc_warehouse_code": 1018,
"epc_warehouse_name": "华南BLUE 2仓"
},
{
"epc_warehouse_code": 1019,
"epc_warehouse_name": "华东4仓"
},
{
"epc_warehouse_code": 1020,
"epc_warehouse_name": "华东BLUE 2仓"
},
{
"epc_warehouse_code": 1021,
"epc_warehouse_name": "华东BLUE 3仓"
}
]
}
Error Response
{
"timestamp": "2019-07-23 10:57:38",
"message": "",
"code": 0
}
仓库
Get Warehouse
API endpoint: https://www.wishpost.cn/api/v3/warehouse
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| warehouse_ids | list | 1-500 | Warehouse ID list, must be provided |
Response
| Parameter name | Description |
|---|---|
| timestamp | Timestamp |
| code | Code |
| message | Message |
| warehouses | Warehouses |
Example Request
{
"access_token": "e7339bc2203f41fdbeaba7c78ba7e37e",
"warehouse_ids": [
1001,
1003
]
}
Success Response
{
"timestamp": "2021-04-27 15:57:33",
"warehouses": [
{
"official_name_en": "EPC WISE Shanghai Warehouse",
"warehouse_address_cn": {
"province": "上海",
"city": "上海市",
"name": "Wish EPC华东1仓",
"district": "宝山区",
"zipcode": "201901",
"address": "上海市宝山区共悦路419号",
"phone_number": "+8613816792755",
"email": null
},
"official_name_cn": "华东1仓",
"warehouse_address_en": {
"province": "Shanghai",
"city": "Shanghai",
"name": "Wish EPC East China Warehouse One",
"district": "Baoshan",
"zipcode": "201901",
"address": "No.419 Gongyue RD Baoshan District Shanghai",
"phone_number": "+8613816792755",
"email": null
},
"enum_value": 1001
},
{
"official_name_en": "EPC Shunfeng Dongguan Warehouse",
"warehouse_address_cn": {
"province": "广东省",
"city": "东莞市",
"name": "Wish EPC华南1仓",
"district": "东莞市",
"zipcode": "523346",
"address": "广东省东莞市石排镇石崇大道安博物流园18号门",
"phone_number": "076989226126",
"email": null
},
"official_name_cn": "华南1仓",
"warehouse_address_en": {
"province": "Guangdong",
"city": "Dongguan",
"name": "Wish EPC South China Warehouse One",
"district": "Dongguan",
"zipcode": "523346",
"address": "No.18 Gate Anbo Logistics Park Shichong Avenue Shipai Town Dongguan City Guangdong Province",
"phone_number": "076989226126",
"email": null
},
"enum_value": 1003
}
],
"code": 0,
"message": "All warehouses fetched."
}
Error Response
{
"timestamp": "2021-05-20 16:51:56",
"message": "Required Param 'warehouse_ids' Missing",
"code": 1001
}
{
"timestamp": "2021-05-20 16:35:05",
"message": "xyz is an invalid integer",
"code": 1000
}
{
"timestamp": "2021-05-20 16:46:41",
"message": "No valid warehouse id found.",
"code": 30
}
标签
Generate a Label
API endpoint: https://www.wishpost.cn/api/v2/generate_label
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| api_key | string | 83-84 | Used to verify the identity. Please use v1 instead of v2 in the url. |
| printlang | int | 1 | Label Language: 1=English, 2=Recipient Country Native Language |
| printcode | int | 1 | Label Format (Imperial Units): 2=4×4，3=4×2(Only for DLP) |
| barcode | string | 1-16 | Barcode |
Response
| Parameter name | Description |
|---|---|
| Timestamp | Timestamp |
| Status | Status |
| PDF_URL | PDF Label Download URL |
| error_message | Error message |
Example Request
<?xml version="1.0" ?>
<root>
<access_token>f06d703a71e4412aad8a579925aef656</access_token>
<printlang>2</printlang>
<printcode>1</printcode>
<barcodes>
<barcode>01922451085</barcode>
<barcode>RQ990073255CN</barcode>
</barcodes>
</root>
Success Response
<?xml version="1.0" ?>
<root>
<timestamp>2014-2-7 11:56:09</timestamp>
<status>0</status>
<PDF_URL>https://www.wishpost.cn/api/v2/download_label?access_token
=f06d703a71e4412aad8a579925aef656&use_local=False&api_orderid
=bfff4eb25aa731e6923260a44c5bad70&format=10</PDF_URL>
</root>
Error Response
<?xml version="1.0" ?>
<root>
<timestamp>2014-2-7 11:54:39</timestamp>
<status>1</status>
<error_message>Unauthorized Request</error_message>
</root>
订单追踪
Get tracking info
API endpoint: https://www.wishpost.cn/api/v2/tracking
Method: POST
Throttling
| Max Requests | Limit Period | Limit Level |
|---|---|---|
| 300 | 1 minute | IP + User |
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| api_key | string | 83-84 | Used to verify the identity. Please use v1 instead of v2 in the url. |
| barcode | string | 1-14 | Waybill Number |
| language | string | 2 | Language: CN or EN |
Response
| Parameter name | Description |
|---|---|
| Time stamp | Time stamp |
| Status | Status |
| barcode | Barcode |
| date | Date |
| status_number | Waybill Status Code |
| status_desc | Waybill Status Description |
| remark | Remark |
| city | City |
| state | State |
| country_code | Country Code |
| last_mile_tracking_id | Last Mile Tracking ID |
| last_mile_carrier | Last Mile Carrier |
Appendix
| Status number | Description |
|---|---|
| 1 | Wishpost order generated |
| 2 | Picked up |
| 3 | Arrived at the first mile sorting center |
| 4 | Processed at the first mile sorting center |
| 5 | Departed from the first mile sorting center |
| 6 | Returned from sorting center |
| 7 | Arrived at Carrier |
| 8 | Processed at Carrier |
| 9 | Departed from Carrier |
| 10 | Returned from Carrier |
| 11 | Arrived at customs of original country |
| 12 | Failed original country customs inspection |
| 13 | Departed from customs of original country |
| 14 | Plan to depart from airport to destination country |
| 15 | Arrived at airport of the original country |
| 16 | Departed from Airport to destination country |
| 17 | Arrived at customs of destination country |
| 18 | Failed destination country customs inspection |
| 19 | Departed from customs of destination country |
| 20 | Arrived at destination country |
| 21 | Arrived at Delivery Office |
| 22 | Attempt to delivery |
| 23 | Delivered |
| 24 | Sign off the parcel |
| 25 | Returned from overseas |
| 27 | Track end |
| 28 | Arrived at transit hub |
| 29 | Departed from transit hub |
| 30 | Arrived at destination airport |
| 31 | Arrived at Export Processing Center (EPC) warehouse |
| 32 | Departed from Export Processing Center (EPC) warehouse |
| 33 | In transit |
| 34 | Package assembled |
| 35 | Any other special exceptional checkpoints by each carrier |
| 36 | Awaiting recipient pickup |
| 37 | Delivery failed |
| 38 | Delivery delayed |
| 39 | Returned from Export Processing Center (EPC) warehouse |
| 40 | Arrived at HUB transit warehouse |
| 41 | Departed from HUB transit warehouse |
| 42 | Pickup completed by pickup carrier |
| 43 | Out for delivery |
| 44 | Returned to merchant by first-mile carrier |
| 45 | Delivered to Export Processing Center (EPC) warehouse |
| 46 | Returned to Export Processing Center (EPC) warehouse |
| 47 | Available for recipient pickup |
| 48 | Order is canceled |
| 49 | Departed from country/region of departure transit port |
| 50 | Arrived at destination transit port |
| 51 | Arrived at country/region of departure transit port |
| 52 | Departed from destination transit port |
| 53 | Departed FBWCN warehouse |
| 54 | Inspected by customs of country/region of departure |
| 55 | Inspected by destination customs |
| 56 | Delivered to destination processing center |
| 57 | First-mile carrier pickup failed |
| 60 | Handed over to distribution center by last-mile carrier |
| 61 | Departed from Uni-Inventory warehouse |
| 62 | Disposed |
| 63 | Returned to pickup carrier |
| 64 | Package is lost |
| 65 | Arrived at regional sorting center |
| 66 | Departed from regional sorting center |
| 67 | Arrived at final sorting center |
| 68 | Departed from final sorting center |
| 69 | Arrived at Uni-Freight warehouse |
| 70 | Returned by express carrier |
| 71 | Handed over to first-mile carrier by merchant |
| 72 | Returned by sorting center |
| 73 | Handed over to sorting center |
| 74 | Last-mile order placed |
| 75 | Last-mile Marked Shipped |
| 76 | Last-mile Tracking Changed |
| 77 | Last-mile Send Tracking Success |
| 78 | Last-mile Send Tracking Fail |
| 79 | Package in transit (last-mile) |
| 80 | Last-mile Expired |
| 81 | Last-mile Pending |
| 82 | Last-mile Info Received |
| 83 | Last-mile Alert |
| 84 | Last-mile Reactivate Success |
| 85 | Last-mile Reactivate Fail |
| 86 | Last-mile Delete Success |
| 87 | Last-mile Delete Fail |
| 88 | Last-mile Delete For Reuse API Success |
| 89 | Last-mile Delete For Reuse API Fail |
| 90 | Last-mile Recycled |
| 91 | Last-mile logistics canceled |
| 92 | First-mile Carrier Arrive Merchant |
| 93 | Sorting Center handover to LM carrier |
| 94 | Last Mile order had been accepted |
Example Request
<?xml version="1.0" ?>
<tracks>
<access_token>f06d703a71e4412aad8a579925aef656</access_token>
<language>cn</language>
<track>
<barcode>85632702094</barcode>
</track>
<track>
<barcode>RW022229594CN</barcode>
</track>
</tracks>
Success Response
<?xml version="1.0" encoding="utf-8"?>
<root>
<status>0</status>
<timestamp>2017/10/11 19:03:41</timestamp>
<tracks barcode="85632702094" last_mile_tracking_id="ZH563355" last_mile_carrier="344">
<track>
<date>2017-09-05 10:51:35</date>
<status_number>1</status_number>
<status_desc>Wishpost订单已生成</status_desc>
<remark></remark>
<city></city>
<state></state>
<country_code></country_code>
</track>
</tracks>
<tracks barcode="RW022229594CN">
<track>
<date>2017-09-07 15:30:34</date>
<status_number>1</status_number>
<status_desc>Wishpost订单已生成</status_desc>
<remark></remark>
<city></city>
<state></state>
<country_code></country_code>
</track>
</tracks>
</root>
Error Response
<?xml version="1.0" ?>
<root>
<timestamp>2014-2-7 11:54:39</timestamp>
<status>1</status>
<error_message>一次最多提交10个barcode</error_message>
</root>
<?xml version="1.0" ?>
<root>
<timestamp>2014-2-7 11:56:09</timestamp>
<status>0</status>
<tracks barcode="WS000000141SH" error_message="无此运单号"/>
<tracks barcode="RH091135288CN" error_message="">
<track>
<date>2014-2-5</date>
<status_number>1</status_number>
<status_desc>运单已生成</status_desc>
<remark/>
</track>
<track>
<date>2014-2-5</date>
<status_number>2</status_number>
<status_desc>货物入库扫描</status_desc>
<remark/>
</track>
</tracks>
</root>
渠道
Get Channels
API endpoint: https://www.wishpost.cn/api/v3/get_channels
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| channels | list | 1-100 | Wishpost Channel otype List |
Response
| Parameter name | Description |
|---|---|
| otype | Channel otype |
| channel_name | Channel Name |
| channel_name_en | Channel English Name |
| is_only_online_payment | Only Support Online Payment |
| allow_battery | Allow Battery |
| sensitivity_types | Sensitivity Types: 0=General Cargo, 1=Has Battery, 2=Sensitive |
| is_registered | Is Registered |
| pickup_service | Pickup Service |
| support_warehouses | Support Warehouse |
| warehouses | Warehouse List |
| warehouses_return_address | Warehouse Return Address |
Example Request
{
"access_token": "b1c18f0ba16b44c0bf6a16733da4a36f",
"channels": []
}
Success Response
{
"channels": [
{
"support_warehouses": true,
"channel_name": "WISH邮中国邮政",
"channel_name_en": "Wishpost - China Post",
"is_only_online_payment": false,
"otype": "0",
"allow_battery": false,
"sensitivity_types": [0],
"pickup_service": {},
"is_registered": false,
"warehouses": {
"1": "Shanghai Warehouse",
"2": "Guangzhou Warehouse",
"3": "Shenzhen Warehouse",
"4": "Yiwu Warehouse",
"5": "Beijing Warehouse",
"6": "Nanjing Warehouse",
"7": "Fuzhou Warehouse",
"8": "Qingdao Warehouse",
"9": "Wuhan Warehouse",
"10": "Dongguan Warehouse",
"11": "Hangzhou Warehouse",
"12": "Jinhua Warehouse",
"13": "Ningbo Warehouse",
"14": "Wenzhou Warehouse",
"15": "Xiamen Warehouse",
"16": "Chongqing Warehouse",
"17": "Tianjin Warehouse",
"18": "Suzhou Warehouse",
"19": "Hefei Warehouse",
"20": "Changsha Warehouse",
"21": "Zhengzhou Warehouse",
"22": "Chengdu Warehouse",
"23": "Xuchang Warehouse",
"24": "Quanzhou Warehouse",
"25": "Foshan Warehouse",
"26": "Zhangpu Warehouse",
"29": "Wuxi Warehouse",
"30": "Nanyang Warehouse",
"31": "Shijiazhuang Warehouse",
"32": "Jingzhou Warehouse",
"33": "Nanchang Warehouse",
"34": "Dalian Warehouse",
"35": "Jinan Warehouse",
"36": "Yichang Warehouse",
"37": "Nantong Warehouse",
"38": "Zhongshan Warehouse"
},
"warehouses_return_address": {
"1": "中国邮政集团公司上海市广商局国际小包业务收寄点",
"2": "广州小包大宗收寄处理中心",
"3": "深圳市国际大宗邮件处理中心",
"4": "中国邮政集团公司浙江省义乌市邮购配送公司",
"5": "北京快速直封中心",
"6": "中国邮政集团公司南京市邮政函件局",
"7": "福州中转仓",
"8": "青岛市邮政局函件广告局销售部受理中心",
"9": "武汉大宗收寄中心",
"10": "东莞市邮政局电商包裹局国际小包处理组",
"11": "中国邮政集团公司杭州市分公司包裹快递部",
"12": "金华市小包分局",
"13": "中国邮政集团公司宁波市电商包裹局",
"14": "温州市两包集中收寄中心",
"15": "厦门市大宗邮件集中处理中心",
"16": "中国邮政集团公司重庆市万盛经济技术开发区万东支局",
"17": "天津大宗邮件收寄处理中心",
"18": "中国邮政集团公司苏州市大宗邮件处理中心",
"19": "合肥大宗处理中心",
"20": "中国邮政集团公司湖南省长沙县函件班",
"21": "郑州帐单处理中心",
"22": "成都市邮政局大宗邮件处理中心",
"23": "许昌市分公司大宗邮件集中收寄处理中心",
"24": "泉州市邮政函件局",
"25": "中国邮政集团公司佛山市函件集邮局",
"26": "漳浦县盘陀邮政支局",
"29": "中国邮政集团公司无锡市大宗邮件处理中心",
"30": "南阳市大宗邮件集中收寄处理中心",
"31": "中邮石家庄仓",
"32": "荆州区荆中支局",
"33": "南昌市函件局",
"34": "大连大宗收寄中心",
"35": "中国邮政集团公司济南市函件广告局大宗业务中心",
"36": "宜昌包裹快递部",
"37": "南通邮政局函件局",
"38": "中山市邮政局函件集邮局商函广告公司"
},
"channel": 1
},
]
}
Error Response
{
"timestamp": "2018-06-06 13:56:00",
"message": "API key is unauthorized",
"code": 4000
}
公告
Get Announcements
API endpoint: https://www.wishpost.cn/api/v3/announcements
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| start_date | string | %Y-%m-%d | Announcement start date range |
| end_date | string | %Y-%m-%d | Announcement end date range |
| offset | int | 1-100 | Fetch announcement start position |
| limit | int | 1-50 | Fetch announcement count |
Response
| Parameter name | Description |
|---|---|
| announcement | Announcement List |
| title | Announcement Title |
| url | Announcement URL |
| text | Announcement Text |
| publish_time | Announcement Publish Time |
| pagination | Pagination Dict |
| total | Total Count |
| next | Next Page |
| limit | Next Page Count |
| offset | Next Page Offset |
| previous | Previous Page |
| limit | Previous Page Count |
| offset | Previous Page Offset |
| start_date | Announcement start date |
| end_date | Announcement end date |
Example Request
{
"access_token": "b1c18f0ba16b44c0bf6a16733da4a36f",
"offset": 3,
"limit": 3,
"start_date": "2018-09-17",
"end_date": "2018-10-17"
}
Success Response
{
"timestamp": "2018-10-22 15:28:36",
"message": "All success",
"code": 0,
"data": {
"announcements": [
{
"url": "https://www.wishpost.cn/announcement?announcement_id=5b8507913691176b431368b7",
"text": [
"Both cn and en"
],
"publish_time": "2018-08-28",
"title": "Create test"
},
{
"url": "https://www.wishpost.cn/announcement?announcement_id=5b023ebe04ba544051210e9d",
"text": [
"
尊敬的Wish平台商户：
您好！
近期部分商户在使用Wish官方物流渠道－中邮小包时出现了一些不合规的操作，请各商户进行自查，避免出现类似问题，影响包裹的正常运输。
1、包裹面单打印不规范
主要存在邮件条码打印精度过低、面单过小、收件人名址不全等问题。当操作人员发现邮件条码扫描困难、面单小于10cm*10cm的邮件时，会将包裹退回商户，最终会影响订单的整体配送时效，请相应不合规的商户尽快进行调整。
2、 包装封装不规范
超小邮件必须包装包装后邮件最大面积不小于10cm*10cm，封装时严禁使用玻璃胶覆盖面单条码部分，对于圆柱形、圆球形、细条尖锐等异形邮件，请使用矩形硬皮包装。
3、禁运产品
严禁使用Wish官方物流产品配送粉末类产品、牙签弩等武器类产品。
近期出现的禁运品的寄送，造成航空安检整票扣留，影响67个邮政大包，900KG、约9000+个Wish邮商户包裹运输，请各位商户知晓此类事件的严重性。
感谢您使用Wish邮！
Wish Post
"
],
"publish_time": "2018-05-21",
"title": "History data No.4"
},
{
"url": "https://www.wishpost.cn/announcement?announcement_id=5b023ebe04ba544051210e9e",
"text": [
"
尊敬的Wish平台商户：
从2017年6月23日起，中国邮政将停止接收寄往南极、喀麦隆、加那利群岛、关岛、几内亚比绍、马约特岛、密克罗尼西亚、黑山、纽埃岛、帕劳、圣马丁、斯瓦尔巴群岛、叙利亚、托克劳群岛、美国本土外小岛屿、也门、桑给巴尔、布韦岛、赫德岛和麦克唐纳群岛、英属印度洋领地、法属南部和南极领地、圣巴泰勒米岛、库拉索、圣马丁岛等24个地区的邮件。
在6月22日及之前已经交给中国邮政的邮件不受影响，会正常寄送。6月23日及之后接收的邮件，中国邮政将会联系商户安排退回。
感谢使用Wish邮！
Wish Post
"
],
"publish_time": "2018-05-21",
"title": "History data No.5"
},
],
"pagination": {
"total": 66,
"next": {
"limit": 3,
"offset": 6
},
"previous": {
"limit": 3,
"offset": 0
}
},
"extra_data": null,
"start_date": "2017-09-17",
"end_date": "2018-10-17"
}
}
Error Response
{
"timestamp": "2018-10-22 15:06:04",
"message": "End date should be later than start date.",
"code": 1000
}
{
"timestamp": "2018-10-22 15:27:17",
"message": "Start date should not be earlier than 30 days ago.",
"code": 1000
}
Scopes
Get Scopes
API endpoint: https://www.wishpost.cn/api/v3/scopes
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| scope_names | list | 1-50 | Scope Name List |
Response
| Parameter name | Description |
|---|---|
| resource | Scope Resource |
| name | Scope Name |
| chinese_name | Scope Chinese Name |
| english_name | Scope English Name |
| role | Scope Role |
| attribute | Scope Attribute |
| action | Scope Action |
| apis | Scope Api List |
Example Request
{
"access_token": "e7339bc2203f41fdbeaba7c78ba7e37e",
"scope_names": []
}
Success Response
{
"scopes": [
{
"resource": "order",
"name": "user.order.read",
"apis": [
"/api/v2/generate_label",
"/api/v3/order_status",
"/api/v3/epc_warehouse_table",
"/api/v3/get_channels"
],
"chinese_name": "读取订单",
"role": "USER",
"english_name": "Read Order Info",
"attribute": "PUBLIC",
"action": "READ"
},
{
"resource": "order",
"name": "user.order.write",
"apis": [
"/api/v2/create_order",
"/api/v2/generate_label",
"/api/v3/create_order"
],
"chinese_name": "创建订单",
"role": "USER",
"english_name": "create order",
"attribute": "PUBLIC",
"action": "WRITE"
},
{
"resource": "tracking",
"name": "user.tracking.read",
"apis": [
"/api/v2/auth_test",
"/api/v2/tracking"
],
"chinese_name": "读取轨迹",
"role": "USER",
"english_name": "Read Tracking",
"attribute": "PUBLIC",
"action": "READ"
}
],
"message": "Success",
"code": 0,
"timestamp": "2018-12-15 14:17:59"
}
Error Response
{
"scopes": [],
"message": "Success",
"code": 0,
"timestamp": "2018-12-15 14:26:17"
}
付款
Get Account Info
API endpoint: https://www.wishpost.cn/api/v3/account_info
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
Response
| Parameter name | Description |
|---|---|
| total | Total Balance |
| unavailable | Unavailable |
| debt_frozen | Frozen Debt |
| debt_remaining | Remaining Debt |
| debt_limit | Debt Limit |
| currency | Currency |
| withdrawable | Withdrawable Amount |
| debt | Debt |
| remaining | Remaining Cash |
Example Request
{
"access_token": "e7339bc2203f41fdbeaba7c78ba7e37e"
}
Success Response
{
"timestamp": "2019-03-14 15:55:38",
"message": "",
"code": 0,
"data": {
"total": "99294.25",
"unavailable": "60112.67",
"debt_frozen": "-140.54",
"debt_remaining": "无上限的",
"debt_limit": "无上限的",
"currency": "人民币",
"withdrawable": "39181.58",
"debt": "-1636.97",
"remaining": "39181.58"
}
}
Error Response
{
"timestamp": "2019-03-14 17:43:26",
"message": "API key is unauthorized",
"code": 4000
}
Order Payment
Get Order Payment
API endpoint: https://www.wishpost.cn/api/v3/get_order_payment
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| tracking_ids | list | 1-100 | Tracking id List |
Response
| Parameter name | Description |
|---|---|
| created_time | Created Time |
| tracking_id | Tracking ID |
| state | State |
| bill_type | Bill Type |
| fee_type | Fee Type |
| amount | Amount |
| type | Type |
| currency | Currency |
| wishpost_order_type | Wishpost Order Type |
| remark | Remark |
| prid | Payment Request ID |
| charge_complete_ts | Charge Complete Time |
| ready_payment_ts | Payment Ready Time |
| actual_parcel_fee | Merchant paid parcel fee |
| actual_weight_fee | Merchant paid weight fee |
| actual_discount | Parcel fee discount |
Appendix
| State code | Description |
|---|---|
| state.EMPTY | empty |
| state.INIT | init |
| state.PROCESS_PAYMENT | process payment |
| state.PROCESS_REVIEW | process review |
| state.PROCESS_3RD | 3rd party system process |
| state.PROCESS_ERP | ERP process |
| state.SUCCESS | success |
| state.REFUNDED | refunded |
| state.FAILED | failed |
| state.DECLINE | decline |
| state.CANCEL | cancelled |
| state.INVALID | invalid |
| state.TIMEOUT | timeout |
| state.OTHER | other |
| type.RECHARGE | recharge |
| type.REFUND | refund |
| type.CHARGE | refund |
| type.COMPENSATE | compensate |
| type.WITHDRAW | withdraw |
| type.REPAYMENT | repayment |
| type.OTHER | other |
Example Request
{
"access_token": "bb3d856d0ce84739a2ca8efc42ecd87e",
"tracking_ids": [
"UH303390759CN",
"Y12727955206",
"WI000181645046EPC"
]
}
Success Response
{
"timestamp": "2019-05-05 18:35:24",
"data": [
{
"created_time": "2019-04-28 17:22:39",
"tracking_id": "WI000181645046EPC",
"ready_payment_ts": "2019-04-26 15:56:05",
"payment_requests": [
{
"remark": "物流费",
"type": "收款",
"bill_type": null,
"state": "SUCCESS",
"wishpost_order_type": "WOSP订单",
"prid": "WI000508800478PR",
"currency": "人民币",
"amount": "5.97",
"fee_type": "LOGISTICS",
"charge_complete_ts": "2019-04-28 17:22:40",
"flat_rate_shipping": {
"actual_weight_fee": 3.17,
"actual_parcel_fee": 2.8,
"actual_discount": 0.17
},
}
]
}
]
}
Error Response
{
"timestamp": "2019-03-14 17:43:26",
"message": "API key is unauthorized",
"code": 4000
}
Download Payment Statement
Download Payment Statement
API endpoint: https://www.wishpost.cn/api/v3/payment_statement/download
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| start_date | string | %Y-%m-%d | Announcement start date range |
| end_date | string | %Y-%m-%d | Announcement end date range |
Response
| Parameter name | Description |
|---|---|
| url | url |
| job_id | Job ID |
| job_token | Job Token |
| message | Message |
Example Request
{
"access_token": "e7339bc2203f41fdbeaba7c78ba7e37e",
"start_date": "2018-11-20",
"end_date" : "2018-11-20"
}
Success Response
{
"url": "https:\/\/wishpost-stage-tmp-uploads.s3.cn-north-1.amazonaws.com.cn\/2018-11-20_2018-11-20_5a1521753b19ca4e6dd05cc4.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=259200&X-Amz-SignedHeaders=host&X-Amz-Signature=a1c293813304b49038f27bb330b14da1b35437fd24b61244507c569230b67c27&X-Amz-Date=20190506T075551Z&X-Amz-Credential=AKIAOXCT5QVXIS663DKQ%2F20190506%2Fcn-north-1%2Fs3%2Faws4_request",
"timestamp": "2019-05-06 15:55:51",
"job_token": null,
"job_id: null,
"message": "Success"
}
Error Response
{
"timestamp": "2019-03-14 17:43:26",
"message": "API key is unauthorized",
"code": 4000
}
Download Payment Statement Check Status
Payment Statement Check Status
API endpoint: https://www.wishpost.cn/api/v3/payment_statement/check-status
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| job_id | string | 32 | Job ID |
| job_token | int | 1-50 | Job Token |
Response
| Parameter name | Description |
|---|---|
| perc | percentage |
| complete | complete |
Example Request
{
"access_token": "d76814f4205f42788db6e369f274d3ea",
"job_id": "3762b2e66fd111e9819c0242ad10f210",
"job_token" : 1
}
Success Response
{
"perc": 100,
"timestamp": "2019-05-06 15:45:59",
"complete": true
}
Error Response
{
"timestamp": "2019-05-13 11:15:29",
"message": "unknown error",
"code": "No such Job [0e845c2e752d11e98a6a0242ad10f210]"
}
Create Orders Bag
Create Orders Bag
API endpoint: https://www.wishpost.cn/api/v3/orders_bag/create
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| X-API-Key | string | 1-50 | Optional for user. Required for carrier |
| pickup_service | int | %d |
Pickup service code, which means the delivery method for the bag to be sent to hub. Choices: 2801 (STO pickup) 9999 (self-delivery) |
| hub_warehouse_code | int | 3001-3002 |
Hub warehouse code. Get latest all hub warehouses by hub_warehouse_table api Choices: Hub East China warehouse 1 = 3001 Hub South China warehouse 1 = 3002 |
| logistics_order_codes | list | 1-1000 |
Logistics order codes(Not WOSP ID), at most 1000 codes. All logistics order codes must be craeted in WishPost. Invalid or non-wishpost order will result in error |
Response
| Parameter name | Description |
|---|---|
| code | HTTP 200, code=0: success; HTTP 400, code=1000: invalid parameter; HTTP 400, code=1001: missing parameter; HTTP 400, code=1002: refused by business logic |
| message | Message |
| timestamp | YYYY-MM-DD HH:mm:ss, Beijing time |
| bag_number | WI+<16 digitals>+BAG |
| label_url | Label url |
| failed_logistics_orders | Dict {error message: list of invalid logistic order codes} |
Example Request
Headers:
{
Content-Type:application/json
X-API-Key:JHBia2RmMixxxxxxxxxxx
}
Or
{
Content-Type:application/json
Authorization:Bearer e7339bc2203f41fxxxxxxxxxxxxxxxxxxx
}
Body:
{
"hub_warehouse_code": 1001,
"pickup_service": "9999",
"logistics_order_codes": [
"WI00000001EPC",
"WI00000002EPC",
"Invalid code 1",
"Invalid code 2”
]
}
Success Response
{
"code": 0,
"bag_number": "WI2019110400000123BAG",
"timestamp": "2019-06-24 17:37:33",
"label_url": "https://<hostname>/api/v3/orders_bag/download_label?access_token=<access_token>&bag_numbers[]=WI2019110400000123BAG",
"message": "successful",
"failed_logistics_orders": []
}
Error Response
{
"code": 1000,
"bag_number": "",
"timestamp": "2019-03-11 11:47:18",
"label_url": "",
"message": "Failed due to business reason",
"failed_logistics_orders": {
"某些订单被选用了不同的揽收服务": [
"WI000000017947EPC",
"WI000000017955EPC"
]
}
}
{
"code": 1001,
"bag_number": "",
"timestamp": "2019-03-11 12:03:06",
"label_url": "",
"message": "Required Param 'pickup_service' Missing",
"failed_logistics_orders": []
}
{
"code": 1000,
"bag_number": "",
"timestamp": "2019-03-11 12:04:28",
"label_url": "",
"message": "Failed due to business reason",
"failed_logistics_orders": {
"某些订单不属于WishPost平台": [
"WI000000017955EPC"
]
}
}
Query Orders Bag
Query Orders Bag
API endpoint: https://www.wishpost.cn/api/v3/orders_bag
Method: GET
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| X-API-Key | string | 1-50 | Optional for user. Required for carrier |
| bag_numbers | list | 1-100 |
List of bag number At least one of bag_numbers(E.g WI***BAG) and logistics_order_codes(NOT WOSP ID) should be provided. When both parameters are provided, the result is the union of the results of querying two parameters separately |
| logistics_order_codes | list | 1-100 |
List of logistics order codes At least one of bag_numbers(E.g WI***BAG) and logistics_order_codes(NOT WOSP ID) should be provided. When both parameters are provided, the result is the union of the results of querying two parameters separately |
Response
| Parameter name | Description |
|---|---|
| code | HTTP 200, code=0 success; HTTP 400, code=1000 invalid parameter; HTTP 400, code=1001 missing parameter; HTTP 400, code=1002 refused by business logic |
| message | Message |
| timestamp | YYYY-MM-DD HH:mm:ss, Beijing time |
| bag_number | Bag number |
| state | Bag state code |
| state_name | Bag state name |
| logistics_order_codes | List of logistics orders in the bag |
Appendix
| Bag state code | Bag state name |
|---|---|
| 0 | Created |
| 1 | Shipping |
| 2 | Cancelled |
| 3 | Terminated |
| 4 | Abnormal |
Example Request
Headers:
{
Content-Type:application/json
X-API-Key:JHBia2RmMixxxxxxxxxxx
}
Or
{
Content-Type:application/json
Authorization:Bearer e7339bc2203f41fxxxxxxxxxxxxxxxxxxx
}
GET https://<hostname>/api/v3/orders_bag?bag_numbers[]=WI2019110400000123BAG,WI2019110400000223BAG
Or
GET https://<hostname>/api/v3/orders_bag?logistics_order_codes[]=WI000000017947EPC,WI000000017955EPC
Success Response
{
"timestamp": "2019-03-11 13:10:34",
"message": "All success",
"code": 0,
"bags": [
{
"logistics_order_codes": [
"WI000000017947EPC",
"WI000000017955EPC"
],
"state": 2,
"bag_number": "WI2019110400000123BAG",
"state_name": "已取消"
},
{
"logistics_order_codes": [
"WI000000017947EPC",
"WI000000017955EPC"
],
"state": 2,
"bag_number": "WI2019110400000223BAG",
"state_name": "已取消"
}
]
}
Error Response
{
"timestamp": "2019-06-27 14:41:10",
"message": "Missing bag_numbers or logistics_order_codes parameter",
"code": 1001
}
Download Bag Label
Download Bag Label
API endpoint: https://www.wishpost.cn/api/v3/orders_bag/download_label
Method: GET
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| bag_numbers | list | 1-100 | List of bag numbers to download label |
Response
| Parameter name | Description |
|---|---|
| <user_name>_Label_<timestamp>.pdf | PDF label |
Example Request
GET https://＜hostname＞/api/v3/orders_bag/download_label?access_token=<access_token>&bag_numbers[]=XXXXXX,XXXXXX
Success Response
username_Label_20190626141055.pdf
Error Response
{
"timestamp": "2019-06-27 15:22:38",
"message": "API key is unauthorized",
"code": 4000
}
Cancel Orders Bag
Cancel Orders Bag
API endpoint: https://www.wishpost.cn/api/v3/orders_bag/cancel
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| X-API-Key | string | 1-50 | Optional for user. Required for carrier |
| bags | list | 1-100 |
List of bag dict to cancel [{bag_number: cancel_reason}] Only bags in 'Created' state can be cancelled. If bag is in 'Shipping' state, the logistics orders bound with the bag must be cancelled first. |
| bag_number | string | 23 | Bag number to cancel |
| cancel_reason | string | 0-100 | Cancel reason |
Response
| Parameter name | Description |
|---|---|
| code | HTTP 200, code=0 success; HTTP 400, code=1000 invalid parameter; HTTP 400, code=1001 missing parameter; HTTP 400, code=1002 refused by business logic |
| message | Message |
| timestamp | YYYY-MM-DD HH:mm:ss, Beijing time |
| failed_bags | List of dict [{fail_code: <code>, bag_numbers: <fail-cancel bag numbers>, fail_message: reason}] |
Example Request
Headers:
{
Content-Type:application/json
X-API-Key:JHBia2RmMixxxxxxxxxxx
}
Or
{
Content-Type:application/json
Authorization:Bearer e7339bc2203f41fxxxxxxxxxxxxxxxxxxx
}
Body:
{
"bags": [
{
"bag_number": "WI2019110400000123BAG",
"cancel_reason":"cancel reason..."
}
]
}
Success Response
{
"failed_bags": [],
"timestamp": "2019-03-11 13:52:12",
"message": "successful",
"code": 0
}
Error Response
{
"timestamp": "2019-03-11 13:52:12",
"message": "Failed due to business reason",
"code": 1000，
“failed_bags”: [
{
"fail_code": 0,
"fail_message": "The bag does not belong to Wishpost platform",
"bag_number": “WI2019110400000123BAG”
}
]
}
{
"timestamp": "2019-03-11 13:52:12",
"message": "Failed due to business reason",
"code": 1000,
“failed_bags”: [
{
"fail_code": 0,
"fail_message": "The bag is already shipped, please cancel its logistics order first",
"bag_number": “WI2019110400000123BAG”
}
]
}
Query Hub Information
Query Hub Info
API endpoint: https://www.wishpost.cn/api/v3/hub_warehouse_table
Method: POST
Parameters
| Parameter name | Type | Length | Description |
|---|---|---|---|
| access_token | string | 1-50 | Access token |
| X-API-Key | string | 1-50 | Optional for user. Required for carrier |
| trande_ids | list | 0-100 | List of Wish transaction ids |
Response
| Parameter name | Description |
|---|---|
| code | HTTP 200, code=0 success; HTTP 400, code=1000 invalid parameter; HTTP 400, code=1001 missing parameter; HTTP 400, code=1002 refused by business logic |
| message | Message |
| timestamp | YYYY-MM-DD HH:mm:ss, Beijing time |
| all_hub_table | All hub informatoon, List of dict [{hub_warehouse_code: <code>, hub_warehouse_name: <warehouse cn name>}] |
| query_hub_table | the hubs that queried wish transaction orders can be sent to. List of dict [{trande_id: <trande_id>, hub_warehouse_name: <warehouse cn name>, hub_warehouse_name: <code>}] |
Example Request
Headers:
{
Content-Type:application/json
X-API-Key:JHBia2RmMixxxxxxxxxxx
}
Or
{
Content-Type:application/json
Authorization:Bearer e7339bc2203f41fxxxxxxxxxxxxxxxxxxx
}
Body:
{
"access_token": "6c98f73e63a741eaad4807072abf5xxx",
"trande_ids": [
"590aca048b4f8d129819b123",
"5a80417edf3b162557f66123"
]
}
Success Response
{
"query_hub_table": [
{
"trande_id": "590aca048b4f8d129819b123",
"hub_warehouse_name": "华东HUB 1仓",
"hub_warehouse_code": 3001
},
{
"trande_id": "5a80417edf3b162557f66123",
"hub_warehouse_name": "NA",
"hub_warehouse_code": "NA"
}
],
"timestamp": "2019-11-13 15:29:55",
"message": "successful",
"code": 0,
"all_hub_table": [
{
"hub_warehouse_code": 3002,
"hub_warehouse_name": "华南HUB 1仓"
},
{
"hub_warehouse_code": 3001,
"hub_warehouse_name": "华东HUB 1仓"
}
]
}
Error Response
{
"timestamp": "2019-11-13 16:37:29",
"message": "Required Param 'access_token' Missing",
"code": 1001
}