海外仓API文档说明-易境通海外仓

MENU

接口功能

API 对接文档说明

1,提供给合作伙伴及用户使用，用户可以方便的集成到网站或系统，实现信息无缝对接。

2,技术支持-易境通海外仓。

如何使用

1,首先您需要拥有我们的系统的账号，如果没有请联系客服人员或首页注册

2,联系客服生成唯一的秘钥 秘钥格式：e10adc3949ba59abbe56e057f20f883e

3,格式如本页显示为准-如需技术支持请联系提供您本链接的销售或客服

一，创建产品

1.使用场景: 创建产品接口

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/add_products.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

{"token":"xxxxxx","list":[{"ck_sku":"K0425","pname":"iphone12","pname_en":"iphone12-en","pt_sku":"K0425","hsnums":"123456","pvalue":"11","country":"中国","description":"描述","guige":"规格","weight":"1","cc":"2","kk":"3","gg":"5","colour":"红色","url":"","dc":"1","img_web":""}]}

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 秘钥
2 list 产品数据段 数组 以下参数均为数组里边
3 ck_sku Sku 是 产品sku
4 pname 中文品名 是 产品中文名称
5 pname_en 英文品名 否 产品英文名称
6 pt_sku 平台sku 否
7 hsnums 海外编码 否
8 pvalue 货值 否 产品货值单价
9 country 原产地 否 产品原产地
10 description 描述 否 产品描述
11 guige 规格 否 产品规格
12 weight 产品重量 是 产品重量
13 cc 尺寸长 否 尺寸长
14 kk 尺寸宽 否 尺寸长
15 gg 尺寸高 否 尺寸高
16 colour 颜色 否 产品颜色
17 url 网络链接 否 产品网络链接
18 dc 是否带电 否 默认为0，1为带电
19 img_web 图片链接 否 产品图片链接

3，返回示例-Json

{"error":"F","content":"没有数据"}

4,返回子段说明

序号 参数 参数说明
1 error T为下单成功，F为下单失败
2 content 描述

二，产品查询

1.使用场景: 创建产品接口

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/hwc_products_api.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

{"token":"xxxxx","ck_sku":""}

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 联系客服获取
2 ck_sku SKU 否 查询的sku
3 page 分页 否 查询页数 默认1
4 limit 每页大小 否 默认为50条，最大300

3，返回示例-Json

{"error":"T","content":"获取成功","data":[{"ck_sku":"cs11111111","code":"cs11111111","pname":"11","pname_en":"1","pvalue":"1.00", "weight":"0.70","cc":"0.39","kk":"0.39","gg":"0.39","id":"2343","pt_sku":[]}]}

4,返回字段说明

序号 参数 参数说明
1 error T为成功，F为失败
2 content 描述
3 page 下一页参数
4 data 数据列表

5,data数据列表

序号 参数 参数说明
1 ck_sku Fnsku (可以用来生成产品条码)
2 code Seller sku
3 pname 产品名称
4 pname_en 英文名称
5 pvalue 产品货值
6 weight 重量
7 cc 长
8 kk 宽
9 gg 高
10 pb 0待审核，1已审核,2审核不通过,3停用

三,创建头程订单

1.使用场景: 创建头程订单

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/add_order_tc.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

{"token":"d504cc7416cd43bc907637807694887f","order_list":[{"waybill":"2021050601","jhfs":"693","tcck":"SZ1","mdck":"MO-1","chqd":"","beizhu":"","country":"韩国","order_types":"718","order_products":[{"ck_sku":"A0426","zxh":"1","nums":"1","weight":"2","cc":"2","kk":"2","gg":"2"},{"ck_sku":"A0426","zxh":"2","nums":"1","weight":"2","cc":"2","kk":"2","gg":"2"}]}]}

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 秘钥
2 order_list 订单数据段 数组 以下参数均为数组里边
3 waybill 参考单号 是 参考单号
4 jhfs 交货方式 是 693-自寄海外仓,731-自寄国内仓
5 tcck 头程仓库 否 仓库编码，731类型为必填
6 mdck 目的仓库 是 目的仓库编码
7 chqd 出货渠道 否 渠道编码，731类型必填
8 beizhu 备注 否 订单备注
9 country 寄往国家 是 寄往国家
10 order_types 订单类型 是 717 为海外中转，718为一件代发
11 is_mx 是否返回头程箱唛 否 0不返回，1需要返回(建议是只是查询状态不需要返回箱唛)
order_products 订单商品数组 是 以下参数在数组此数组里边
1 ck_sku SKU 是 产品SKU编码
2 nums 产品数量 是 产品数量
3 zxh 箱号 是 箱号-同一个箱号表示商品在同一箱，建议用1，2，3罗马数字来标识箱号
4 weight 箱子重量 是 箱子重量
5 cc 箱子长 是 箱子长
6 kk 箱子宽 是 箱子宽
7 gg 箱子高 是 箱子高

3，返回示例-Json

{"msg":"\u7b2c1\u884c\u8ba2\u5355\u7528\u6237\u540d\u6216\u79d8\u94a5\u4e0d\u5b58\u5728,"error":"T"}

4,返回字段说明

序号 参数 参数说明
1 error T为下单成功，F为下单失败
2 content 描述

四，查询头程订单

1.使用场景: 创建产品接口

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/hwc_order_tc.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

{"token":"d504cc7416cd43bc907637807694887f","order_status":"0","waybill":"","start_time":"","end_time":"","page":"","limit":""}

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 秘钥
2 order_status 订单状态 否 0,待确认,1头程待入库,2头程已入库,3海外仓待入库
,4海外仓已入库,5,异常订单,6确认未通过,7回收站
3 waybill 参考号 否 头程参考号
3 start_time 订单开始时间 否 格式:2019-05-18 20:00:00
4 end_time 订单结束时间 否 格式:2019-05-18 20:00:00
5 page 分页 否 查询页数 默认1
6 limit 每页大小 否 默认为50条，最大300

3，返回示例-Json

{"error":"T","content":"\u83b7\u53d6\u6210\u529f","page":2,"data":[{"id":"37439","waybill":"1620888150","order_no":"20210513024230472","order_pb":"0","addtime":"1620888150","order_products":[{"zxh":"1","pwaybill":"1620888150-1","weight":"2.00","cc":"2.00","kk":"2.00","gg":"2.00","nums":"1","md_time":"0","mu_nums":"0","ck_sku":"A0426","pname":"A0426","order_id":"37439","pb":"0","status":"\u5f85\u5165\u5e93"},{"zxh":"2","pwaybill":"1620888150-2","weight":"2.00","cc":"2.00","kk":"2.00","gg":"2.00","nums":"1","md_time":"0","mu_nums":"0","ck_sku":"A0426","pname":"A0426","order_id":"37439","pb":"0","status":"\u5f85\u5165\u5e93"}]}]}

4,返回字段说明

序号 参数 参数说明
1 error T为成功，F为失败
2 content 描述
3 page 下一页参数
4 data 数据列表

5,data数据列表

序号 参数 参数说明
1 waybill 参考单号
2 order_pb 0,待确认,1头程待入库,2头程已入库,3海外仓待入库,4海外仓已入库,5,异常订单,6确认未通过,7回收站
3 pdf_url 装箱单文件,pdf格式
4 addtime 订单时间：时间戳
5 order_products 包裹数组
6 zxh 装箱单号
7 pwaybill 批次号
8 weight 箱子重量
9 cc 箱子长
10 kk 箱子宽
11 gg 箱子高
12 nums 产品数量(预报数量)
13 md_time 海外仓入库时间
14 mu_nums 海外仓入库数量
15 ck_sku Sku
16 pname 产品名称
17 pb 状态编码
18 status 状态文字

五，海外仓仓库查询

1.使用场景: 海外仓仓库查询

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/hwc_storage_list.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

{"token":"","storage":"","country":""}

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 联系客服获取
2 storage 仓库编码 否 仓库编码
3 country 国家 否 仓库所属国家 如 美国
4 is_tc 仓库类型 否 0为海外仓，1为头程仓,2为其他仓

3，返回示例-Json

{"error":"T","content":"\u83b7\u53d6\u6210\u529f","data":[{"pname":"\u5e7f\u5dde\u4ed3\u5e93","country":"","nums":"001"},{"pname":"\u65b0\u52a0\u5761","country":"\u65b0\u52a0\u5761","nums":"001"},{"pname":"\u7f8e\u56fd\u4ed3\u5e93","country":"\u7f8e\u56fd","nums":"USCA"}]}

4,返回字段说明

序号 参数 参数说明
1 error T为成功，F为失败
2 content 描述
3 data 数据列表

5,data数据列表

序号 参数 参数说明
1 pname 仓库名称
2 country 国家
3 nums 仓库编码
4 is_tc 0为海外仓，1为头程仓,2为其他仓

六，海外仓物流查询接口

1.使用场景: 海外仓物流查询接口

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/hwc_paisongx.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

{"token":"e10adc3949ba59abbe56e057f20f883e","storage":"USCA","country":"\u7f8e\u56fd"}

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 秘钥
2 storage 仓库编码 是 仓库编码
3 country 渠道国家 否 仓库所属国家 如 美国

3，返回示例-Json

{"error":"T","content":"\u83b7\u53d6\u6210\u529f","data":[{"pname":"\u5e7f\u5dde\u4ed3\u5e93","country":"","nums":"001"},{"pname":"\u65b0\u52a0\u5761","country":"\u65b0\u52a0\u5761","nums":"001"},{"pname":"\u7f8e\u56fd\u4ed3\u5e93","country":"\u7f8e\u56fd","nums":"USCA"}]}

4,返回字段说明

序号 参数 参数说明
1 error T为成功，F为失败
2 content 描述
3 data 数据列表

5,data数据列表

序号 参数 参数说明
1 pname 派送渠道名称
2 nums 渠道编码
3 area 派送区域
4 storage 仓库编码

七，库存查询接口

1.使用场景: 库存查询接口

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/hwc_stock.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

{"token":"xxx","storage":"USCA","sku":"A0011","page":"1","limit":"100"}

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 秘钥
2 storage 仓库编码 是 仓库编码
3 sku sku 否
4 page 页数 否 不填默认为第一页
5 limit 分页大小 否 默认为50条，最大300条

3，返回示例-Json

{"error":"T","content":"\u83b7\u53d6\u6210\u529f","page":"","data":[{"products_id":"17","stock":"3","ck_sku":"A0011","pname":"\u8863\u670d","pname_en":"\u8863\u670d","guige":"","colour":"","weight":"5.00","cc":"0.00","kk":"0.00","gg":"0.00"}]}

4,返回字段说明

序号 参数 参数说明
1 error T为成功，F为失败
2 content 描述
3 page 下一页参数
4 data 数据列表

5,data数据列表

序号 参数 参数说明
1 stock 库存数量
2 lock_stock 冻结库存数量
3 ck_sku Sku名称
4 pname 产品名称

八，创建派送订单

1.使用场景: 创建派送订单

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/add_order.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

[{"zip":"92551","country":"美国","deliver_products":[{"sku":"A2022","nums":1}],"address":"rfr34 mp Moreno Valley","city":"Alaska","deliver_no":"2022070101","mobile":"123","ck_nums":"MO-1","platform":"ebay","token":"d504cc7416cd43bc907637807694887f","province":"GD","phone":"","api_type":"","chqd":"UPS001","contact":"OrisvaldoSousa","email":"92551","waybill":"20220711-01","pda_url":""}]

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 秘钥
2 ck_nums 仓库编码 是 仓库编码
3 deliver_no 发货单号 是 发货单号
4 chqd 渠道编码 是 渠道编码
5 country 国家 是
6 city 州 是
7 district 城市 是
8 zip 邮编 是
9 address 详细地址 是
10 address2 详细地址2 是
11 contact 联系人 是
12 mobile 电话 是
13 phone 手机 是
14 email 收件邮编 是
15 house_number 门牌号 否 20240912后系统支持,如需使用请联系客服核实
16 address_type 地址类型 否 默认空,1商业地址,2住宅地址,20240912后系统支持,如需使用请联系客服核实
17 qmfw 签名服务 否 默认NoSignature不做签名,AdultSignature成人签名,DirectSignature直接签收,20240912后系统支持,如需使用请联系客服核实
15 platform 订单类型 是 填写订单来源 如ebay
16 api_type ApiID 否 如无特殊说明留空
17 waybill 出货单号 否 自打单获得自己提供面单使用
18 pda_url 发货面单 否 面单链接,Pdf格式
19 beizhu 订单备注 否
deliver_products 产品列表 是 下面的是数组
1 nums 发货数量 是
2 sku 发货sku 是

3，返回示例-Json

{"msg":"\u7b2c1\u884c\u8ba2\u5355\u7528\u6237\u540d\u6216\u79d8\u94a5\u4e0d\u5b58\u5728,","html":"2019-06-27 18:22:29","error":1,"nextToken":null}

4,返回字段说明

序号 参数 参数说明
1 error T为成功，F为失败
2 content 描述

九，查询派送订单

1.使用场景: 查询代发订单

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/hwc_order.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

{"token":"xxxxx","order_status":"0","deliver_no":"","waybill":"","start_time":"","end_time":"","page":"","limit":""}

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 联系客服获取
2 order_status 订单状态 否 1,待确认,2,待发货,3,已打包,
4,已发货,5,审核不通过,
6,已签收,0,草稿箱
3 deliver_no 发货单号 否
4 waybbill 跟踪号 否
5 start_time 订单开始时间 否 格式:2019-05-18 20:00:00
6 end_time 订单结束时间 否 格式:2019-06-18 20:00:00
6 page 订单开始时间 否 不填默认为1
7 limit 每页大小 否 默认为50条，最大300

3，返回示例-Json

{"error":"T","content":"\u83b7\u53d6\u6210\u529f","page":"","data":[{"waybill":"9405511899564780726891","deliver_no":"k2019062501","pb":"2","addtime":"1561454476","country":"\u7f8e\u56fd","city":"CA","district":"LOS ANGELES","zip":"90405","address":"12959 CORAL TREE PL","contact":"chenwei","mobile":"13751857028","phone":""},{"waybill":"","deliver_no":"k2019062401","pb":"1","addtime":"1561357069","country":"\u7f8e\u56fd","city":"CA","district":"LOS ANGELES","zip":"90405","address":"12959 CORAL TREE PL","contact":"chenwei","mobile":"13751857028","phone":""}]}

4,返回字段说明

序号 参数 参数说明
1 error T为成功，F为失败
2 content 描述
3 data 数据列表

5,data数据列表

序号 参数 参数说明
1 waybill 跟踪号
2 deliver_no 发货单号
3 pb 1,待确认,2,待发货,3,已打包,4,已发货,
5,审核不通过,6,已签收,0,草稿箱 – 状态
4 addtime 订单时间：时间戳
5 country 国家
6 city 州
7 district 地区
8 zip 邮编
9 address 详细地址
10 contact 收货人
11 mobile 手机
12 yunfei 订单运费
13 weight 订单重量
14 jf_weight 计费重量

十，打印派送订单

1.使用场景: 打印派送订单

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/order_print.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

{"token":"xxxxxx","deliver_no":["kk2019073006","d2019073001"]}

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 秘钥
2 deliver_no 发货单号 是 发货单号

3，返回示例-Json

{"error":"T","content":"\u64cd\u4f5c\u6210\u529f","page":"","data":[{"waybill":"","pda_url":"http:\/\/www.haiwaicang.com","deliver_no":"d2019073001"},{"waybill":"156471017341","pda_url":"","deliver_no":"kk2019073006"}]}

4,返回子段说明

序号 参数 参数说明
1 error T为下单成功，F为下单失败
2 content 描述
3 data 数据列表

5,data数据列表

序号 参数 参数说明
1 waybill 跟踪号
2 deliver_no 发货单号
3 pda_url 面单URl

十一，取消派送接口

1.使用场景: 取消派送接口

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/hwc_deliver_del.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

{"token":"","deliver_list":["PS1012876","PS1012875"]}

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 秘钥
2 deliver_list 订单参考号 是 订单参考考号

3，返回示例-Json

{"error":"T","content":"请求成功","succ_array":[],"error_array":{"PS1012876":"订单不存在,或已删除","PS1012875":"订单不存在,或已删除"}}

4,返回子段说明

序号 参数 参数说明
1 error T为成功，F为失败
2 content 描述
3 succ_array 取消成功的数据
4 error_array 取消失败的数据

十二，更新发货单号

1.使用场景: 更新代发出货单号

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/hwc_order_hc.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

[{"token":"xxxxxx","deliver_no":"PS1012073","waybill":"PS1012073_1","pda_url":""}]

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 秘钥
2 deliver_no 参考单号 是 订单参考单号
3 waybill 出货单号 是 出货单号
4 pda_url 面单 是 出货面单(PDF文件流)

3，返回示例-Json

{"error":"T","content":"\u83b7\u53d6\u6210\u529f"}

4,返回子段说明

序号 参数 参数说明
1 error T为成功，F为失败
2 content 描述

十三，海外仓轨迹查询接口

1.使用场景: 海外仓轨迹查询接口

2.请求方式: 以application/json的形式,采用POST方法提交数据

3.请求URL: http://xxxx.com/hwc_api/hwc_guiji_list.php

4.token: 需要秘钥

5.返回格式: json

1，创建示例Json

{"token":"xxxxxxx","waybilll":["9400128206335411556481","9400128206335411556535 "]}

2，字段说明

序号 参数 参数说明 是否必填 参数描述
1 token 秘钥 是 秘钥
2 waybilll 出货单号 是 出货单号或发货单号

3，返回示例-Json

{"error":"F","content":"没有数据"}

4,返回子段说明

序号 参数 参数说明
1 error T为成功，F为失败
3 list 数据列表
4 list 轨迹物流信息
5 isqs 是否签收，0 未签收，1已签收
6 qs_time 签收时间