Wish邮API文档
Order(New)
Create an order(New)
API端点: https://archive.wishpost.cn/api/v2/create_order
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌, API key和access_token二选一 |
api_key | string | 83-84 | 用来验证身份, 请在url中使用v1代替v2 |
mark | string | 0-50 | 如果需要多个标签在一个PDF文件中, 请提交前一次返回的mark |
bid | int | 0-99999 | 用户提供的单次提交唯一标识 |
guid | string | 100 | 用户提供的运单唯一标识,将跟随运单号返回 |
otype | string | 1-50 |
中邮小包平邮=0 中邮小包挂号=1 中邮简易小包平邮=33-0 -------------------------------------- DLE=10-1 E邮宝=11-1 英伦速邮=14-0 IB快速服务=21-1 IB标准服务=22-1 Sinotrans(中外运)=23-1 DHLe经济小包=30-0 DHLe标准小包=31-1 Wishpost EPC=36-1 Wishpost YunExpress 专线=37-1 Wishpost WiseExpress 专线=44-1 顺友国际小包(挂号)=49-1(线上结算) 顺友国际小包(平邮)=54-0(线上结算) 飞特挂号小包=55-1 飞特经济小包=56-0 TopYou平邮小包-普货=77-0(线上结算) TopYou平邮小包-特货=78-0(线上结算) TopYou挂号小包-普货=79-1(线上结算) TopYou挂号小包-特货=80-1(线上结算) 欧洲经济小包=200-0 欧洲标准小包=201-1 Wish达=300-1 更多渠道otype 请调用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 | 商户店铺名称 |
non_wish_transaction_id | string | 0-100 | 其他平台订单ID |
store_id | string | 0-100 | 收货店铺ID |
from | string | 0-100 | 寄件人姓名(不能包含中文字符,留空将使用地址簿默认信息) |
sender_province | string | 0-100 | 寄件人省名(不能包含中文字符,留空将使用地址簿默认信息) |
sender_city | string | 0-100 | 寄件人城市名(不能包含中文字符,留空将使用地址簿默认信息) |
sender_district | string | 0-100 | 寄件人区/县名(不能包含中文字符,留空将使用地址簿默认信息) |
sender_addres | string | 0-100 | 寄件人地址(不能包含中文字符,留空将使用地址簿默认信息) |
sender_phone | string | 0-20 | 寄件人电话(留空将使用地址簿默认信息. 号码可以以一个+开头,可以以-连接或以()围住. 不可以包含其他符号或其他语言字符) |
sender_zipcode | string | 1-200 | 寄件人邮编(留空将使用地址簿默认信息,地址簿寄件人邮编为空将使用310000) |
sender_tax_id | string | 1-200 | 发件人税号,目的国为英国的非Wish订单必填;2021/6/15以后下单,目的国为欧盟VAT成员国,且总商品净售价大于等于150欧元的订单,选填,具体的:如卖家付进口关税,填写该字段;如买家付进口关税,则可不填或不传该字段。 |
sender_eori | string | 1-200 | 寄件人EORI(英国订单非Wish订单是必填的) |
pickup_service | string | 1-100 | 揽收服务,针对于EPC/A+/Smart/Nile渠道,如果doorpickup选择1(上门揽收),则必填25-1(4PX揽收)或者27-1(WISE揽收)或者42-0(燕文揽收),如果doorpickup选择0(自寄),则可不填,对于其他渠道,均不填写此字段 |
pickup_from_local | string | 1-100 | 揽收人姓名(当地国语言),Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_phone | string | 1-250 | 揽收人电话,Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_zip_code | string | 1-200 | 揽收人邮编 |
pickup_addres_local | string | 1-200 | 揽收人地址(当地国语言),Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_province_local | string | 1-1000 | 揽收人省名(当地国语言),Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_city_local | string | 1-1000 | 揽收人城市名(当地国语言),Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_district_local | string | 1-1000 | 揽收人区/县名(当地国语言) |
pickup_from | string | 1-100 | 揽收人姓名英文 |
pickup_addres | string | 1-200 | 揽收人地址英文 |
pickup_province | string | 1-1000 | 揽收人省名英文 |
pickup_city | string | 1-1000 | 揽收人城市名英文 |
pickup_district | string | 1-1000 | 揽收人区/县名英文 |
pickup_country_local | string | 1-500 | 揽收人国家(当地国语言) |
pickup_country | string | 1-500 | 揽收人国家英文 |
pickup_country_code | string | 3 | 揽收人国家代码 |
return_action_in_country | int | 0,2,3 | 退货处理方式:0-销毁,2-退回揽收地址,3-退回退货地址(退货地址信息必填) |
reverse_logistics_mode | int | 1,3 | 退回方式:1-揽收商退回,3-快递预付退回 |
return_name_local | string | 1-100 | 退货收件人姓名(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_phone | string | 1-20 | 退货收件人电话,可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_zipcode | string | 1-200 | 退货收件人邮编,可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_address_local | string | 1-200 | 退货收件人地址(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_province_local | string | 1-1000 | 退货收件人省份(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_city_local | string | 1-1000 | 退货收件人城市(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_district_local | string | 1-1000 | 退货收件人区/县(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
to | string | 1-100 | 收件人姓名(必须是英文),Wishpost EPC 选填 |
recipient_country | string | 1-50 | 收件人国家(英文),Wishpost EPC 选填 |
recipient_country_short | string | 1-3 | 收件人国家简码(如:US,GB,UK),Wishpost EPC 选填 |
recipient_province | string | 1-100 | 收件人州名(英文),Wishpost EPC 选填 |
recipient_city | string | 1-100 | 收件人城市名(英文),Wishpost EPC 选填 |
recipient_district | string | 1-100 | 收件人区/县名(英文),选填 |
recipient_addres | string | 1-100 | 收件人地址(英文),Wishpost EPC 选填 |
recipient_postcode | string | 1-10 | 收件人邮编,Wishpost EPC 选填 |
recipient_phone | string | 1-20 | 收件人电话(号码可以以一个+开头,可以以-连接或以()围住。不可以包含其他符号或其他语言字符),Wishpost EPC 选填 |
recipient_email | string | 1-50 | 收件人邮箱(中间必须包含@,Wishpost Nile 必填) |
to_local | string | 1-100 | 收件人姓名(到达国语言, 留空将使用英文信息) |
recipient_country_local | string | 0-50 | 收件人国家(到达国语言, 留空将使用英文信息) |
recipient_province_local | string | 0-100 | 收件人州名(到达国语言, 留空将使用英文信息) |
recipient_city_local | string | 0-100 | 收件人城市名(到达国语言, 留空将使用英文信息) |
recipient_district_local | string | 0-100 | 收件人区/县名(到达国语言, 留空将使用英文信息) |
recipient_addres_local | string | 0-100 | 收件人地址(到达国语言, 留空将使用英文信息) |
receive_from | string | 0-100 | 揽收信息联系人(必须中文) |
receive_province | string | 0-100 | 揽收信息省名(必须中文) |
receive_city | string | 0-100 | 揽收信息城市名(必须中文) |
receive_district | string | 0-100 | 揽收信息区/县名(必须中文) |
receive_addres | string | 0-100 | 揽收信息(必须中文) |
receive_phone | string | 0-20 | 揽收信息电话 |
type_no | int | 1 |
内件类型代码 5=销售品 |
unit_measurement | string | 0-20 | 英文计量单位 |
unit_measurement_chinese | string | 0-20 | 中文计量单位 |
user_desc | string | 0-500 | 商户自定义信息,例如商户订单号, 商品编号,库位号等 |
trade_amount | money | 0-99999.00 | WISH网站的交易金额,单位为美元, 包含物品价值和物流费用 |
currency | string | 1-200 | 申报价值货币单位,该字段非必须(英国申报价值货币单位是gbp,2021/7/1之后下的订单,目的国为欧盟VAT成员国申报货币单位系统自动默认为eur,其余是usd) |
warehouse_code | int | 0-10 |
分仓代码(中邮小包、IB必填) ----------------------------------------------------- 以下为中邮小包平邮、挂号支持仓库: 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=中山仓 ---------------------------------------------------- 以下为IB标准、快速服务支持仓库: 27=华东仓 28=华南仓 |
doorpickup | int | 1 |
揽收方式 0=自送 1=上门揽收 2=揽收方式待定 |
product_item_from_country | string | string | 此种产品原产国(英文) |
product_item_name | string | 1-100 | 此种产品的详细名称(英文), 必须包含至少一个英文字母 |
product_item_name_chinese | string | 1-50 | 此种产品的详细中文名称(必填,必须包含中文) |
product_item_num | int | 1-99999 | 此种产品数量 |
product_item_weight | float | 0-2.000 | 此种产品的重量(此种产品的总重,非单件重量,是此种产品单重*此种产品数量),千克(三位小数) |
product_item_single_price | money | 0-99999.00 | 单件货品申报价值。英国需要填写英镑数值;2021/6/15-2021/6/30之间下的订单,目的国为欧盟VAT成员国,申报价值仍旧填写美元数值,2021/7/1之后下的订单,目的国为欧盟VAT成员国,申报价值需要填写欧元数值 |
wish_order_id | string | 1-499 |
在Wish订单ID,所有渠道必填。 该字段必须是英文字母、数字、或英文逗号字符(分割多个交易单号时使用)中间不得有空格。 如不属于Wish平台交易,请填写默认值NonWishOrder,注意此类物流订单的跟踪号无法回填到Wish商户后台; 如属于Wish平台交易号,请正确填写Wish商户后台显示的24位字符串(API接口中对应字段:order_id)。 该字段仅支持单个ID,如:56f1205a44dc6fb51631f26f。 |
product_item_has_battery | int | 1 |
是否带电, 必填 0=不带电, 1=带电, EPC订单包含特货此项也须传1,EPC特货清单链接: https://s3.cn-north-1.amazonaws.com.cn/wishpost-production-wishpost-announcement/EPC特货清单.xlsx |
product_item_sensitivity_type | int | 2 |
货物敏感类型, 0=普货, 1=带电, 2=敏感货, 若此字段值小于product_item_has_battery字段值,将使用product_item_has_battery字段中的值。敏感类型清单链接: https://wishpost-data.s3.cn-north-1.amazonaws.com.cn/manual/special_sensitive%2Bdefinition.xlsx |
product_item_product_url | string | string | 产品网页链接(必填) |
product_item_hs_code | string | string | 产品HS Code |
sender_ioss_vat_id | string | string | 发件人IOSS识别号,为VAT交税人在欧盟成员国注册的唯一识别号。2021/6/15以后下的订单,且同时满足1)2)3)时为必填:1)目的国为欧盟VAT成员国,2)发票中商品净售价(欧元)低于150欧,3)非Wish订单。 |
product_item_intrinsic_value | money | 当前商品净售价(欧元),为销售平台发票中所列商品净售价总和(商品单价*商品数量,且不包含税,运费,保险等)。2021/6/15以后下的订单,且同时满足1)2)时必填:1)目的国为欧盟VAT成员国,2)非Wish订单 | |
product_item_intrinsic_vat_amount | money | 当前商品净售价所需缴纳的VAT金额(欧元),选填,不填时默认为0 | |
total_transport_value | money | 包裹内商品总运费(欧元),为销售平台发票中所列所有商品运费总和。 选填,不填时默认为0 | |
total_transport_vat_amount | money | 包裹内商品总运费所需缴纳的VAT金额(欧元)。选填,不填时默认为0 |
响应
参数名称 | 描述 |
---|---|
Timestamp | 时间 |
Status | 状态码 |
wish_standard_tracking_id | 物流订单号 |
barcode | 物流跟踪单号 |
warehouse | 合并仓 |
mark | 标识字符串 |
PDF_10_EN_URL | PDF标签10*10英文版下载地址 |
PDF_10_LCL_URL | PDF标签10*10到达国版下载地址 |
error_message | 错误说明 |
PDF_15_EN_URL | PDF标签10*5下载地址 |
recipient_country | 到达国家(如:法国) |
recipient_country_short | 国家简码(如:FR) |
c_code | 产品代码(如:C02 ) |
q_code | 渠道代码(如:Q03) |
y_ code | 验证码(如:9709) |
user_desc | 用户自定义信息 |
reference_qrcode | 瑞典渠道二维码 |
error_ref_id | 错误识别码,用于Wishpost端定位异常(异常情况下需提供) |
示例请求
<?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>
响应成功
<?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>
错误响应
<?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端点: https://archive.wishpost.cn/api/v2/create_order
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌, API key和access_token二选一 |
api_key | string | 83-84 | 用来验证身份, 请在url中使用v1代替v2 |
mark | string | 0-50 | 如果需要多个标签在一个PDF文件中, 请提交前一次返回的mark |
bid | int | 0-99999 | 用户提供的单次提交唯一标识 |
guid | string | 100 | 用户提供的运单唯一标识,将跟随运单号返回 |
otype | string | 1-50 |
中邮小包平邮=0 中邮小包挂号=1 中邮简易小包平邮=33-0 -------------------------------------- DLE=10-1 E邮宝=11-1 英伦速邮=14-0 IB快速服务=21-1 IB标准服务=22-1 Sinotrans(中外运)=23-1 DHLe经济小包=30-0 DHLe标准小包=31-1 Wishpost EPC=36-1 Wishpost YunExpress 专线=37-1 Wishpost WiseExpress 专线=44-1 顺友国际小包(挂号)=49-1(线上结算) 顺友国际小包(平邮)=54-0(线上结算) 飞特挂号小包=55-1 飞特经济小包=56-0 TopYou平邮小包-普货=77-0(线上结算) TopYou平邮小包-特货=78-0(线上结算) TopYou挂号小包-普货=79-1(线上结算) TopYou挂号小包-特货=80-1(线上结算) 欧洲经济小包=200-0 欧洲标准小包=201-1 Wish达=300-1 更多渠道otype 请调用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 | 其他平台订单ID |
store_id | string | 0-100 | 收货店铺ID |
from | string | 0-100 | 寄件人姓名(不能包含中文字符,留空将使用地址簿默认信息) |
sender_province | string | 0-100 | 寄件人省名(不能包含中文字符,留空将使用地址簿默认信息) |
sender_city | string | 0-100 | 寄件人城市名(不能包含中文字符,留空将使用地址簿默认信息) |
sender_district | string | 0-100 | 寄件人区/县名(不能包含中文字符,留空将使用地址簿默认信息) |
sender_addres | string | 0-100 | 寄件人地址(不能包含中文字符,留空将使用地址簿默认信息) |
sender_phone | string | 0-20 | 寄件人电话(留空将使用地址簿默认信息. 号码可以以一个+开头,可以以-连接或以()围住. 不可以包含其他符号或其他语言字符) |
sender_zipcode | string | 1-200 | 寄件人邮编(留空将使用地址簿默认信息,地址簿寄件人邮编为空将使用310000) |
sender_tax_id | string | 1-200 | 发件人税号,目的国为英国的非Wish订单必填;2021/6/15以后下单,目的国为欧盟VAT成员国,且总商品净售价大于等于150欧元的订单,选填,具体的:如卖家付进口关税,填写该字段;如买家付进口关税,则可不填或不传该字段。 |
sender_eori | string | 1-200 | 寄件人EORI(英国订单非Wish订单是必填的) |
pickup_service | string | 1-100 | 揽收服务,针对于EPC/A+/Smart/Nile渠道,如果doorpickup选择1(上门揽收),则必填25-1(4PX揽收)或者27-1(WISE揽收)或者42-0(燕文揽收),如果doorpickup选择0(自寄),则可不填,对于其他渠道,均不填写此字段 |
pickup_from_local | string | 1-100 | 揽收人姓名(当地国语言),Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_phone | string | 1-250 | 揽收人电话,Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_zip_code | string | 1-200 | 揽收人邮编 |
pickup_addres_local | string | 1-200 | 揽收人地址(当地国语言),Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_province_local | string | 1-1000 | 揽收人省名(当地国语言),Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_city_local | string | 1-1000 | 揽收人城市名(当地国语言),Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_district_local | string | 1-1000 | 揽收人区/县名(当地国语言) |
pickup_from | string | 1-100 | 揽收人姓名英文 |
pickup_addres | string | 1-200 | 揽收人地址英文 |
pickup_province | string | 1-1000 | 揽收人省名英文 |
pickup_city | string | 1-1000 | 揽收人城市名英文 |
pickup_district | string | 1-1000 | 揽收人区/县名英文 |
pickup_country_local | string | 1-500 | 揽收人国家(当地国语言) |
pickup_country | string | 1-500 | 揽收人国家英文 |
pickup_country_code | string | 3 | 揽收人国家代码 |
return_action_in_country | int | 0,2,3 | 退货处理方式:0-销毁,2-退回揽收地址,3-退回退货地址(退货地址信息必填) |
reverse_logistics_mode | int | 1,3 | 退回方式:1-揽收商退回,3-快递预付退回 |
return_name_local | string | 1-100 | 退货收件人姓名(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_phone | string | 1-20 | 退货收件人电话,可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_zipcode | string | 1-200 | 退货收件人邮编,可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_address_local | string | 1-200 | 退货收件人地址(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_province_local | string | 1-1000 | 退货收件人省份(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_city_local | string | 1-1000 | 退货收件人城市(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_district_local | string | 1-1000 | 退货收件人区/县(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
to | string | 1-100 | 收件人姓名(必须是英文),Wishpost EPC 选填 |
recipient_country | string | 1-50 | 收件人国家(英文),Wishpost EPC 选填 |
recipient_country_short | string | 1-3 | 收件人国家简码(如:US,GB,UK),Wishpost EPC 选填 |
recipient_province | string | 1-100 | 收件人州名(英文),Wishpost EPC 选填 |
recipient_city | string | 1-100 | 收件人城市名(英文),Wishpost EPC 选填 |
recipient_district | string | 1-100 | 收件人区/县名(英文),选填 |
recipient_addres | string | 1-100 | 收件人地址(英文),Wishpost EPC 选填 |
recipient_postcode | string | 1-10 | 收件人邮编,Wishpost EPC 选填 |
recipient_phone | string | 1-20 | 收件人电话(号码可以以一个+开头,可以以-连接或以()围住。不可以包含其他符号或其他语言字符),Wishpost EPC 选填 |
recipient_email | string | 1-50 | 收件人邮箱(中间必须包含@,Wishpost Nile 必填) |
to_local | string | 1-100 | 收件人姓名(到达国语言, 留空将使用英文信息) |
recipient_country_local | string | 0-50 | 收件人国家(到达国语言, 留空将使用英文信息) |
recipient_province_local | string | 0-100 | 收件人州名(到达国语言, 留空将使用英文信息) |
recipient_city_local | string | 0-100 | 收件人城市名(到达国语言, 留空将使用英文信息) |
recipient_district_local | string | 0-100 | 收件人区/县名(到达国语言, 留空将使用英文信息) |
recipient_addres_local | string | 0-100 | 收件人地址(到达国语言, 留空将使用英文信息) |
type_no | int | 1 |
内件类型代码 Sample 5=Sale of Good |
from_country | string | string | 货物原产国(英文) |
content | string | 1-100 | 内件物品的详细名称(英文), 必须包含至少一个英文字母 |
content_chinese | string | 1-50 | 内件物品的详细中文名称(必填,必须包含中文) |
num | int | 1-99999 | 内件数量 |
unit_measurement | string | 0-20 | 英文计量单位 |
unit_measurement_chinese | string | 0-20 | 中文计量单位 |
weight | float | 0-2.000 | 货品重量,千克(三位小数) |
single_price | money | 0-99999.00 | 单件货品申报价值。英国需要填写英镑数值;2021/6/15-2021/6/30之间下的订单,目的国为欧盟VAT成员国,申报价值仍旧填写美元数值,2021/7/1之后下的订单,目的国为欧盟VAT成员国,申报价值需要填写欧元数值 |
currency | string | 1-200 | 申报价值货币单位,该字段非必须(英国申报价值货币单位是gbp,2021/7/1之后下的订单,目的国为欧盟VAT成员国申报货币单位系统自动默认为eur,其余是usd) |
trande_no | string | 1-499 |
在Wish订单ID,所有渠道必填。 该字段必须是英文字母、数字、或英文逗号字符(分割多个交易单号时使用)中间不得有空格。 如不属于Wish平台交易,请填写默认值NonWishOrder,注意此类物流订单的跟踪号无法回填到Wish商户后台; 如属于Wish平台交易号,请正确填写Wish商户后台显示的24位字符串(API接口中对应字段:order_id)。 该字段支持单个ID,如:56f1205a44dc6fb51631f26f;也支持最多20个ID,如:56f1205a44dc6fb51631f26f,56f1205a44dc6fb51631f26f。 |
trade_amount | money | 0-99999.00 | WISH网站的交易金额,单位为美元, 包含物品价值和物流费用 |
orders_bag_number | string | 21 |
WishPost大包号, 通过'Create Orders Bag'接口获得, 如 WI2019110400000123BAG. STO渠道(2801-1)必填, 其余渠道无需填写. |
user_desc | string | 0-500 | 商户自定义信息,例如商户订单号, 商品编号,库位号等 |
receive_from | string | 0-100 | 揽收信息联系人(必须中文) |
receive_province | string | 0-100 | 揽收信息省名(必须中文) |
receive_city | string | 0-100 | 揽收信息城市名(必须中文) |
receive_district | string | 0-100 | 揽收信息区/县名(必须中文) |
receive_addres | string | 0-100 | 揽收信息(必须中文) |
receive_phone | string | 0-20 | 揽收信息电话 |
warehouse_code | int | 0-10 |
分仓代码(中邮小包、IB必填) ----------------------------------------------------- 以下为中邮小包平邮、挂号支持仓库: 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=中山仓 ---------------------------------------------------- 以下为IB标准、快速服务支持仓库: 27=华东仓 28=华南仓 |
doorpickup | int | 1 |
揽收方式 0=自送 1=上门揽收 2=揽收方式待定 |
has_battery | int | 1 |
是否带电, 必填 0=不带电, 1=带电, EPC订单包含特货此项也须传1,EPC特货清单链接: https://s3.cn-north-1.amazonaws.com.cn/wishpost-production-wishpost-announcement/EPC特货清单.xlsx |
sensitivity_type | int | 2 |
货物敏感类型, 0=普货, 1=带电, 2=敏感货, 若此字段值小于has_battery字段的值,将使用has_battery字段中的值。否则,将返回错误。敏感类型清单链接: https://wishpost-data.s3.cn-north-1.amazonaws.com.cn/manual/special_sensitive%2Bdefinition.xlsx |
product_url | string | string | 产品网页链接(必填) |
product_hs_code | string | string | 产品HS Code |
sender_ioss_vat_id | string | string | 发件人IOSS识别号,为VAT交税人在欧盟成员国注册的唯一识别号。2021/6/15以后下的订单,且同时满足1)2)3)时为必填:1)目的国为欧盟VAT成员国,2)发票中商品净售价(欧元)低于150欧,3)非Wish订单。 |
intrinsic_value | money | 当前商品净售价(欧元),为销售平台发票中所列商品净售价总和(商品单价*商品数量,且不包含税,运费,保险等)。2021/6/15以后下的订单,且同时满足1)2)时必填:1)目的国为欧盟VAT成员国,2)非Wish订单 | |
intrinsic_vat_amount | money | 当前商品净售价所需缴纳的VAT金额(欧元),选填,不填时默认为0 | |
total_transport_value | money | 包裹内商品总运费(欧元),为销售平台发票中所列所有商品运费总和。 选填,不填时默认为0 | |
total_transport_vat_amount | money | 包裹内商品总运费所需缴纳的VAT金额(欧元)。选填,不填时默认为0 |
响应
参数名称 | 描述 |
---|---|
Timestamp | 时间 |
Status | 状态码 |
wish_standard_tracking_id | 物流订单号 |
barcode | 物流跟踪单号 |
warehouse | 合并仓 |
mark | 标识字符串 |
PDF_10_EN_URL | PDF标签10*10英文版下载地址 |
PDF_10_LCL_URL | PDF标签10*10到达国版下载地址 |
error_message | 错误说明 |
PDF_15_EN_URL | PDF标签10*5下载地址 |
recipient_country | 到达国家(如:法国) |
recipient_country_short | 国家简码(如:FR) |
c_code | 产品代码(如:C02 ) |
q_code | 渠道代码(如:Q03) |
y_ code | 验证码(如:9709) |
user_desc | 用户自定义信息 |
reference_qrcode | 瑞典渠道二维码 |
error_ref_id | 错误识别码,用于Wishpost端定位异常(异常情况下需提供) |
示例请求
<?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>
响应成功
<?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>
错误响应
<?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端点: https://archive.wishpost.cn/api/v3/order/collection_option/confirm
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
wish_standard_tracking_id | string | wishpost 订单号,必需 | |
doorpickup | int | 0,1 |
揽收方式,必需。 0=自送 1=上门揽收 |
pickup_service | string | 1-100 | 揽收服务,针对于EPC/A+/Smart/Nile渠道,如果doorpickup选择1(上门揽收),则必填25-1(4PX揽收)或者27-1(WISE揽收)或者42-0(燕文揽收),如果doorpickup选择0(自寄),则可不填,对于其他渠道,均不填写此字段 |
return_action_in_country | int | 0,2,3 | 退货处理方式:0-销毁,2-退回揽收地址,3-退回退货地址(退货地址信息必填) |
reverse_logistics_mode | int | 1,3 | 退回方式:1-揽收商退回,3-快递预付退回 |
pickup_address | dictionary | 揽收地址 | |
pickup_from_local | string | 1-100 | 揽收人姓名(当地国语言),Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_phone | string | 1-250 | 揽收人电话,Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_zipcode | string | 1-200 | 揽收人邮编 |
pickup_address_local | string | 1-200 | 揽收人地址(当地国语言),Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_province_local | string | 1-1000 | 揽收人省名(当地国语言),Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_city_local | string | 1-1000 | 揽收人城市名(当地国语言),Sinotrans、IB、EPC、YunExpress和Wiseexpress必填 |
pickup_district_local | string | 1-1000 | 揽收人区/县名(当地国语言) |
return_address | dictionary | 退货地址 | |
return_name_local | string | 1-100 | 退货收件人姓名(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_phone | string | 1-20 | 退货收件人电话,可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_zipcode | string | 1-200 | 退货收件人邮编,可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_address_local | string | 1-200 | 退货收件人地址(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_province_local | string | 1-1000 | 退货收件人省份(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_city_local | string | 1-1000 | 退货收件人城市(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
return_district_local | string | 1-1000 | 退货收件人区/县(当地国语言),可进入http://www.wishpost.cn/home/#/user/fpl-return-plan 设置默认值,或单独指定该字段 |
响应
参数名称 | 描述 |
---|---|
timestamp | 时间 |
message | 接口返回消息 |
code | 接口返回状态码 |
示例请求
{ "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 } }
响应成功
{ "timestamp": "2021-09-26 13:52:40", "message": "揽收信息更新成功,可稍后查询该订单状态。", "code": 0 }
错误响应
{ "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端点: https://archive.wishpost.cn/api/v3/order_status
Method: POST
Throttling
Max Requests | Limit Period | Limit Level |
---|---|---|
30 | 1 minute | IP + User |
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
wish_standard_tracking_ids | list | 1-500 | Wish 运单号, Wish运单号和交易订单号二选一填写 |
wish_transaction_ids | list | 1-10 | Wish 交易订单号, Wish运单号和交易订单号二选一填写 |
响应
参数名称 | 描述 |
---|---|
timestamp | 时间 |
message | 接口返回消息 |
code | 接口返回状态码 |
wish_standard_tracking_id | Wish 运单号 |
logistics_order_code | 运单物流单号 |
wish_transaction_ids | 交易订单号 |
state_code | 订单状态码 |
state_name | 订单状态名字 |
cancel_reason_code | 订单取消原因代码 |
cancel_fail_reason | 订单取消失败原因 |
reference_qrcode | 瑞典渠道二维码 |
message | 订单详情 |
PDF_10_EN_URL | PDF标签10*10英文版下载地址 |
PDF_10_LCL_URL | PDF标签10*10到达国版下载地址 |
dest_warehouse_code | 前往的目的仓库编码(数值0代表该渠道不支持仓库) |
dest_warehouse_name | 前往的目的仓库 |
dest_warehouse_address_cn | 前往的目的仓库地址 |
hub_warehouse_code | 中转仓代号 |
附录
订单状态码 | 订单状态名字 |
---|---|
0 | 错误 |
1 | 已创建 |
2 | 无效 |
3 | 拒绝 |
4 | 取消 |
5 | 审核中 |
6 | 已接受 |
7 | 运输中 |
8 | 已完成 |
示例请求
{ "access_token": "b1c18f0ba16b44c0bf6a16733da4a36f", "wish_standard_tracking_ids": [ "WOSP000644993647IND", "WOSP000644993649IND", "WOSP000644993648IND", "WOSP000000023915USA" ] }
响应成功
{ "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 } } ] }
错误响应
{ "timestamp": "2018-03-09 12:24:17", "message": "No valid wish_standard_tracking_ids is provided", "code": 1001, "orders": [] }
Cancel Orders
Cancel Orders
API端点: https://archive.wishpost.cn/api/v3/cancel_orders
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
orders | list | 1-100 | 物流订单 dict 列表 |
tracking_id | string | 1-100 | 物流订单追踪号,二选一必需 |
wish_standard_tracking_id | string | 1-100 | 物流订单wish号,二选一必需 |
cancel_reason_code | int | 40100-49999 | 物流订单取消原因代码,必需 |
invalid_reason | string | 1-200 | 物流订单取消具体原因,当取消原因代码非49999时,非必需,否则,必需 |
响应
参数名称 | 描述 |
---|---|
timestamp | 时间 |
message | 接口返回消息 |
code | 接口返回状态码 |
is_cancelling_orders | 正在尝试取消订单列表 |
failed_cancel_orders | 取消失败订单列表 |
tracking_id | 物流订单追踪号 |
wish_standard_tracking_id | 物流订单wish订单号 |
cancel_result_code | 订单取消原因代码 |
cancel_result_message | 订单取消失败原因 |
附录
订单取消原因代码 | 订单取消原因代码含义 |
---|---|
40101 | 需更换渠道 |
40102 | 需更换揽收方式 |
40103 | 需更换物流商 |
40104 | 需更换仓库 |
40105 | 需更换地址 |
40106 | 需更换重量 |
40107 | 需更换申报价格 |
40201 | 单号已被使用 |
40202 | 无法获取单号 |
40203 | ERP无法获取单号 |
40204 | 无法打印面单 |
40205 | 无效面单 |
40206 | 订单过期 |
40301 | 物流商未取货 |
40302 | 不在揽收范围 |
40303 | 物流商需更换单号 |
40304 | 物流商无法收款 |
40305 | 物流商未收到包裹 |
40401 | 买家要求退货 |
40402 | 寄错货物 |
40403 | 需合并发货 |
40404 | 需拆分发货 |
40405 | 重复下单 |
49999 | 其他原因 |
示例请求
{ "access_token": "efb1825cf6114ab29ea34baace173881", "orders": [ { "tracking_id":"WI000000022037EPC", "cancel_reason_code":40101 } ] }
响应成功
{ "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": [] }
错误响应
{ "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端点: https://archive.wishpost.cn/api/v3/epc_warehouse_table
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
响应
参数名称 | 描述 |
---|---|
epc_warehouse_code | EPC仓库编码 |
epc_warehouse_name | EPC仓库名称 |
示例请求
{ "access_token": "e7339bc2203f41fdbeaba7c78ba7e37e" }
响应成功
{ "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仓" } ] }
错误响应
{ "timestamp": "2019-07-23 10:57:38", "message": "", "code": 0 }
仓库
Get Warehouse
API端点: https://archive.wishpost.cn/api/v3/warehouse
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
warehouse_ids | list | 1-500 | Warehouse ID 列表,必需 |
响应
参数名称 | 描述 |
---|---|
timestamp | 返回时间戳 |
code | 返回状态码 |
message | 接口返回消息 |
warehouses | 仓库列表 |
示例请求
{ "access_token": "e7339bc2203f41fdbeaba7c78ba7e37e", "warehouse_ids": [ 1001, 1003 ] }
响应成功
{ "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." }
错误响应
{ "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端点: https://archive.wishpost.cn/api/v2/generate_label
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌, API key和access_token二选一 |
api_key | string | 83-84 | 用来验证身份, 请在url中使用v1代替v2 |
printlang | int | 1 | 标签语言:1=英语,2=到达国语 |
printcode | int | 1 | 标签格式(英寸): 2=4×4,3=4×2(DLP专用) |
barcode | string | 1-16 | 运单号 |
响应
参数名称 | 描述 |
---|---|
Timestamp | 时间 |
Status | 状态码 |
PDF_URL | PDF标签下载地址 |
error_message | 错误说明 |
示例请求
<?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>
响应成功
<?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>
错误响应
<?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端点: https://archive.wishpost.cn/api/v2/tracking
Method: POST
Throttling
Max Requests | Limit Period | Limit Level |
---|---|---|
300 | 1 minute | IP + User |
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌, API key和access_token二选一 |
api_key | string | 83-84 | 用来验证身份, 请在url中使用v1代替v2 |
barcode | string | 1-14 | 运单号 |
language | string | 2 | 跟踪信息语言:cn或en |
响应
参数名称 | 描述 |
---|---|
Time stamp | 时间 |
Status | 状态码 |
barcode | 运单号 |
date | 日期 |
status_number | 运单状态码 |
status_desc | 运单状态描述 |
remark | 备注 |
city | 城市 |
state | 州 |
country_code | 国家代码 |
附录
状态码 | 描述 |
---|---|
1 | Wishpost订单已生成 |
2 | 揽件 |
3 | 到达头程分拣中心 |
4 | 在头程分拣中心处处理 |
5 | 离开头程分拣中心 |
6 | 头程分拣中心退回 |
7 | 到达物流服务商处 |
8 | 在物流服务商处处理 |
9 | 从物流服务商处发出 |
10 | 物流服务商退回 |
11 | 到达始发国海关 |
12 | 始发国海关清关失败 |
13 | 离开始发国海关 |
14 | 计划交航 |
15 | 到达始发国机场 |
16 | 从机场发往目的国 |
17 | 到达目的国海关 |
18 | 目的国海关清关失败 |
19 | 离开目的国海关 |
20 | 到达目的国 |
21 | 到达收寄站 |
22 | 尝试投递 |
23 | 妥投 |
24 | 签收 |
25 | 海外退回 |
27 | 跟踪结束 |
28 | 到达中转中心 |
29 | 离开中转中心 |
30 | 到达目的国机场 |
示例请求
<?xml version="1.0" ?> <tracks> <access_token>f06d703a71e4412aad8a579925aef656</access_token> <language>cn</language> <track> <barcode>85632702094</barcode> </track> <track> <barcode>RW022229594CN</barcode> </track> </tracks>
响应成功
<?xml version="1.0" encoding="utf-8"?> <root> <status>0</status> <timestamp>2017/10/11 19:03:41</timestamp> <tracks barcode="85632702094"> <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>
错误响应
<?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端点: https://archive.wishpost.cn/api/v3/get_channels
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
channels | list | 1-100 | WishPost渠道otype的第一位数字,例如:E邮宝otype=11-1,E邮宝对应的channels值即为11;中邮挂号小包otype=1,中邮对应的channels值即为1 |
响应
参数名称 | 描述 |
---|---|
otype | 渠道otype |
channel_name | 渠道名称 |
channel_name_en | 渠道英文名称 |
is_only_online_payment | 是否仅支持线上结算 |
allow_battery | 允许电池 |
sensitivity_types | 敏感类型:0=普货, 1=带电, 2=敏感货 |
is_registered | 是否挂号 |
pickup_service | 揽收服务 |
support_warehouses | 是否分仓 |
warehouses | 仓库列表 |
warehouses_return_address | 退件单位 |
示例请求
{ "access_token": "b1c18f0ba16b44c0bf6a16733da4a36f", "channels": [] }
响应成功
{ "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 }, ] }
错误响应
{ "timestamp": "2018-06-06 13:56:00", "message": "API key is unauthorized", "code": 4000 }
公告
Get Announcements
API端点: https://archive.wishpost.cn/api/v3/announcements
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
start_date | string | %Y-%m-%d | 获取公告的起始时间,最早不得早于2016年4月4日 |
end_date | string | %Y-%m-%d | 获取公告的终止时间,最晚比起始时间晚30天 |
offset | int | 1-100 | 获取公告的起始位置 |
limit | int | 1-50 | 获取公告每页条数,最多一次50条 |
响应
参数名称 | 描述 |
---|---|
announcement | 公告列表 |
title | 公告标题 |
url | 公告链接 |
text | 公告文本,最长为500个字符,如需完整的请点击url |
publish_time | 公告发布时间 |
pagination | 分页详情 |
total | 所有页面总数 |
next | 下一页,如果是最后一页,则为空 |
limit | 下一页公告总数 |
offset | 下一页公告起始位置 |
previous | 上一页,如果是第一页,则为空 |
limit | 上一页公告总数 |
offset | 上一页公告起始位置 |
start_date | 公告起始时间 |
end_date | 公告截止时间 |
示例请求
{ "access_token": "b1c18f0ba16b44c0bf6a16733da4a36f", "offset": 3, "limit": 3, "start_date": "2018-09-17", "end_date": "2018-10-17" }
响应成功
{ "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" } }
错误响应
{ "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端点: https://archive.wishpost.cn/api/v3/scopes
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
scope_names | list | 1-50 | Scope名字列表,若为空列表[],返回全部Scope |
响应
参数名称 | 描述 |
---|---|
resource | Scope 资源 |
name | Scope 名字 |
chinese_name | Scope 中文名字 |
english_name | Scope 英文名字 |
role | Scope 使用的用户角色 |
attribute | Scope 属性 |
action | Scope 的操作 |
apis | Scope 管理的api列表 |
示例请求
{ "access_token": "e7339bc2203f41fdbeaba7c78ba7e37e", "scope_names": [] }
响应成功
{ "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" }
错误响应
{ "scopes": [], "message": "Success", "code": 0, "timestamp": "2018-12-15 14:26:17" }
付款
Get Account Info
API端点: https://archive.wishpost.cn/api/v3/account_info
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
响应
参数名称 | 描述 |
---|---|
total | 全部余额 |
unavailable | 不可用金额 |
debt_frozen | 冻结债务 |
debt_remaining | 剩余债务 |
debt_limit | 债务上限 |
currency | 币种 |
withdrawable | 可提现金额 |
debt | 债务 |
remaining | 剩余余额 |
示例请求
{ "access_token": "e7339bc2203f41fdbeaba7c78ba7e37e" }
响应成功
{ "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" } }
错误响应
{ "timestamp": "2019-03-14 17:43:26", "message": "API key is unauthorized", "code": 4000 }
Order Payment
Get Order Payment
API端点: https://archive.wishpost.cn/api/v3/get_order_payment
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
tracking_ids | list | 1-100 | Tracking id 列表 |
响应
参数名称 | 描述 |
---|---|
created_time | 创建时间 |
tracking_id | Tracking ID |
state | 状态 |
bill_type | 订单类型 |
fee_type | 收费类型 |
amount | 金额 |
type | 类型 |
currency | 币种 |
wishpost_order_type | Wishpost 订单类型 |
remark | 备注 |
prid | 付款请求 ID |
charge_complete_ts | 付款请求完成时间 |
ready_payment_ts | 订单完成时间 |
附录
状态码 | 描述 |
---|---|
state.EMPTY | 空 |
state.INIT | 初始 |
state.PROCESS_PAYMENT | 准备付款 |
state.PROCESS_REVIEW | 人工校验中 |
state.PROCESS_3RD | 第三方处理中 |
state.PROCESS_ERP | ERP 处理中 |
state.SUCCESS | 成功 |
state.REFUNDED | 退还 |
state.FAILED | 请求失败 |
state.DECLINE | 拒绝 |
state.CANCEL | 用户取消 |
state.INVALID | 无效 |
state.TIMEOUT | 未准时完成 |
state.OTHER | 其他 |
type.RECHARGE | 充值 |
type.REFUND | 退还 |
type.CHARGE | 收款 |
type.COMPENSATE | 补偿 |
type.WITHDRAW | 提现 |
type.REPAYMENT | 还款 |
type.OTHER | 其他 |
示例请求
{ "access_token": "bb3d856d0ce84739a2ca8efc42ecd87e", "tracking_ids": [ "UH303390759CN", "Y12727955206", "WI000181645046EPC" ] }
响应成功
{ "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": "2.60", "fee_type": "LOGISTICS", "charge_complete_ts": "2019-04-28 17:22:40" } ] } ] }
错误响应
{ "timestamp": "2019-03-14 17:43:26", "message": "API key is unauthorized", "code": 4000 }
Download Payment Statement
Download Payment Statement
API端点: https://archive.wishpost.cn/api/v3/payment_statement/download
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
start_date | string | %Y-%m-%d | 获取Payment Statement的起始时间,最早不得早于2018年10月1日 |
end_date | string | %Y-%m-%d | 获取Payment Statement的终止时间,最晚比起始时间晚30天 |
响应
参数名称 | 描述 |
---|---|
url | 下载链接,首先校验此字段,若为空则校验master_id,不为空则可以直接下载 |
job_id | 任务 ID,若不为空则调用 /api/v3/payment_statement/check-status 查看进度 |
job_token | 任务监视 Token |
message | 消息 |
示例请求
{ "access_token": "e7339bc2203f41fdbeaba7c78ba7e37e", "start_date": "2018-11-20", "end_date" : "2018-11-20" }
响应成功
{ "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" }
错误响应
{ "timestamp": "2019-03-14 17:43:26", "message": "API key is unauthorized", "code": 4000 }
Download Payment Statement Check Status
Payment Statement Check Status
API端点: https://archive.wishpost.cn/api/v3/check-status
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
job_id | string | 32 | 任务 ID |
job_token | int | 1-50 | 任务监视 Token |
响应
参数名称 | 描述 |
---|---|
perc | 进度百分比 |
complete | 是否已完成,已完成则调用 /api/v3/payment_statement/download 获取结果 |
示例请求
{ "access_token": "d76814f4205f42788db6e369f274d3ea", "job_id": "3762b2e66fd111e9819c0242ad10f210", "job_token" : 1 }
响应成功
{ "perc": 100, "timestamp": "2019-05-06 15:45:59", "complete": true }
错误响应
{ "timestamp": "2019-05-13 11:15:29", "message": "unknown error", "code": "No such Job [0e845c2e752d11e98a6a0242ad10f210]" }
Create Orders Bag
Create Orders Bag
API端点: https://archive.wishpost.cn/api/v3/orders_bag/create
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
X-API-Key | string | 1-50 | 商户使用无需填写,物流商使用时必填 |
pickup_service | int | %d |
揽收服务代号,表示打包后的包裹送到中转仓的寄送方式 可选值: 2801 (申通揽收), 9999 (用户自送) |
hub_warehouse_code | int | 3001-3002 |
中转仓代号, 可通过hub_warehouse_table接口及时获取最新所有中转仓代号 可选值: 华东Hub 1仓 = 3001 华南Hub 1仓 = 3002 |
logistics_order_codes | list | 1-1000 |
物流商跟踪单号(不是WOSP ID),小包数量最多为1000个 (所有跟踪号必须是平台内创建的的物流跟踪号, 其中填写非法跟踪单号或平台内没有的物流单号将直接报错) |
响应
参数名称 | 描述 |
---|---|
code | HTTP 200, code=0: 标识打包成功; HTTP 400, code=1000: 标识参数错误; HTTP 400, code=1001: 丢失参数; HTTP 400, code=1002: 校验通过后,系统或者业务逻辑操作被拒绝或失败 |
message | 下单结果 |
timestamp | YYYY-MM-DD HH:mm:ss, 北京时间 |
bag_number | WI+<16位数字>+BAG. |
label_url | 面单下载链接 |
failed_logistics_orders | Dict {报错原因: 对应的无效单号} |
示例请求
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” ] }
响应成功
{ "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": [] }
错误响应
{ "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端点: https://archive.wishpost.cn/api/v3/orders_bag
Method: GET
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
X-API-Key | string | 1-50 | 商户使用无需填写,物流商使用时必填 |
bag_numbers | list | 1-100 |
大包号列表 bag_numbers(例如 WI***BAG) 与 logistics_order_codes(不是WOSP ID) 至少提供一项, 两项都提供时, 返回单独查询两项的结果并集 |
logistics_order_codes | list | 1-100 |
小包物流跟踪号列表 bag_numbers(例如 WI***BAG) 与 logistics_order_codes(不是WOSP ID) 至少提供一项, 两项都提供时, 返回单独查询两项的结果并集 |
响应
参数名称 | 描述 |
---|---|
code | HTTP 200, code=0 标识成功; HTTP 400, code=1000 标识参数错误; HTTP 400, code=1001 丢失参数; HTTP 400, code=1002 校验通过后,系统或者业务逻辑操作被拒绝或失败 |
message | 处理消息 |
timestamp | YYYY-MM-DD HH:mm:ss, 北京时间 |
bag_number | 所查询的大包号, 或包含所查询的EPC小包物流单号的大包号 |
state | 大包状态代号 |
state_name | 大包状态信息 |
logistics_order_codes | EPC小包物流单号列表 |
附录
大包状态代号 | 大包状态信息 |
---|---|
0 | 已创建 |
1 | 运输中 |
2 | 取消 |
3 | 终止 |
4 | 异常 |
示例请求
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
响应成功
{ "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": "已取消" } ] }
错误响应
{ "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端点: https://archive.wishpost.cn/api/v3/orders_bag/download_label
Method: GET
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
bag_numbers | list | 1-100 | 大包号列表 |
响应
参数名称 | 描述 |
---|---|
<user_name>_Label_<timestamp>.pdf | PDF面单 |
示例请求
GET https://<hostname>/api/v3/orders_bag/download_label?access_token=<access_token>&bag_numbers[]=XXXXXX,XXXXXX
响应成功
username_Label_20190626141055.pdf
错误响应
{ "timestamp": "2019-06-27 15:22:38", "message": "API key is unauthorized", "code": 4000 }
Cancel Orders Bag
Cancel Orders Bag
API端点: https://archive.wishpost.cn/api/v3/orders_bag/cancel
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
X-API-Key | string | 1-50 | 商户使用无需填写,物流商使用时必填 |
bags | list | 1-100 |
大包 dict 列表 [{大包号: 取消原因}] 只能取消 '已创建' 状态的大包. 如果大包处于”正在配送“状态, 必须先取消大包绑定的物流订单 |
bag_number | string | 23 | 大包号 |
cancel_reason | string | 0-100 | 取消原因 |
响应
参数名称 | 描述 |
---|---|
code | HTTP 200, code=0 标识成功; HTTP 400, code=1000 标识参数错误; HTTP 400, code=1001 丢失参数; HTTP 400, code=1002 校验通过后,系统或者业务逻辑操作被拒绝或失败 |
message | 处理消息 |
timestamp | YYYY-MM-DD HH:mm:ss,北京时间 |
failed_bags | List of dict [{fail_code: <代号>, bag_numbers: <无法取消的大包单号列表>, fail_message: 无法取消的原因}] |
示例请求
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..." } ] }
响应成功
{ "failed_bags": [], "timestamp": "2019-03-11 13:52:12", "message": "successful", "code": 0 }
错误响应
{ "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端点: https://archive.wishpost.cn/api/v3/hub_warehouse_table
Method: POST
参数
参数名称 | 类型 | 长度 | 描述 |
---|---|---|---|
access_token | string | 1-50 | 用户认证后生成的访问令牌 |
X-API-Key | string | 1-50 | 商户使用无需填写,物流商使用时必填 |
trande_ids | list | 0-100 | Wish平台交易号列表 |
响应
参数名称 | 描述 |
---|---|
code | HTTP 200, code=0 标识成功; HTTP 400, code=1000 标识参数错误; HTTP 400, code=1001 丢失参数; HTTP 400, code=1002 校验通过后,系统或者业务逻辑操作被拒绝或失败 |
message | 处理消息 |
timestamp | YYYY-MM-DD HH:mm:ss,北京时间 |
all_hub_table | 所有仓库信息, List of dict [{hub_warehouse_code: <代号>, hub_warehouse_name: <Hub仓库中文码>}] |
query_hub_table | Wish平台交易订单对应的Hub仓库. List of dict [{trande_id: <trande_id>, hub_warehouse_name: <Hub仓库中文码>, hub_warehouse_name: <代号>}] |
示例请求
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" ] }
响应成功
{ "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仓" } ] }
错误响应
{ "timestamp": "2019-11-13 16:37:29", "message": "Required Param 'access_token' Missing", "code": 1001 }