深圳EMS跨境e
微信公众号
首页 > API > 开发者必读 > 更新日志
2015年5月12日
新建API对接资料。
2015年7月8日
createOrder, modifyOrder 接口,增加forceVerify属性,用于强制审核。
2015年8月5日
新建getOrderByRefCode 接口。
2016年4月28日
新建入库单增加transit_type字段。
getOrderByCode接口支持参考编号请求
2016年11月14日
getProductInventory接口增加stocking字段
2020年5月28日
新建getWarehouseOfAge 接口。
2020年6月18日
新建getReturnOrders 接口。
接入API对接平台开发,开发者需要按照如下步骤完成:
1、注册测试环境的OMS用户。
OMS测试环境地址: http://106.3.224.246:6280 ,请自行注册用户。
2、获取appToken和appKey。
登录OMS后,右上角找到个人中心,打开用户中心后在页面左侧即可获取appToken和appKey。
3、WSDL地址
测试线:http://106.3.224.246:6280/default/svc/wsdl
正式线:http://cpws.ems.com.cn/default/svc/wsdl
4、service地址(curl数据)
测试线:http://106.3.224.246:6280/default/svc/web-service
正式线:http://cpws.ems.com.cn/default/svc/web-service
请求公共参数
序号 | 参数 | 类型 | 必填项 | 描述 |
---|---|---|---|---|
1 | appToken | String | √ | API密钥 |
2 | appKey | String | √ | API标识 |
3 | language | String | 错误信息语言(zh_CN、en_US) | |
4 | service | String | √ | 接口方法,参考接口方法列表 |
5 | paramsJson | String | 请求的数据内容,json格式 |
response公共参数
参数 | 类型 | 必填项 | 描述 |
---|---|---|---|
ask | string | √ | 响应标志,Success表示成功,Failure表示失败 |
message | String | √ | 消息提示 |
error | object | 错误信息 |
error格式
参数 | 类型 | 必填项 | 描述 |
---|---|---|---|
errMessage | string | √ | 错误信息内 |
errCode | String | √ | 错误码 |
pagination格式
参数 | 类型 | 必填项 | 描述 |
---|---|---|---|
pageSize | string | √ | 分页大小 |
page | String | √ | 当前页 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
pageSize | Int | Option | 每页数据长度,不传值表示查询所有 |
page | Int | Option | 当前页,不传值表示查询所有 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
pagination | Object | 参考pagination格式 |
count | Int | 总数量 |
nextPage | String | 是否有下一页,true表示有,false表示没有 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
country_code | string | 国家/地区二字码 |
country_name | string | 国家/地区中文名 |
country_name_en | string | 国家/地区英文名 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
pageSize | Int | Option | 每页数据长度,不传值表示查询所有 |
page | Int | Option | 当前页,不传值表示查询所有 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
pagination | Object | 参考pagination格式 |
count | Int | 总数量 |
nextPage | String | 是否有下一页,true表示有,false表示没有 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
region_id | Int | 区域ID |
parent_region_id | Int | 父区域关联ID |
region_name | string | 区域名称 |
region_level | Int | 区域级别,0中国,1省,2市,3区/县 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
pageSize | Int | Option | 每页数据长度,不传值表示查询所有 |
page | Int | Option | 当前页,不传值表示查询所有 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
pagination | Object | 参考pagination格式 |
count | Int | 总数量 |
nextPage | String | 是否有下一页,true表示有,false表示没有 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
warehouse_code | string | 仓库代码 |
warehouse_name | string | 仓库名称 |
country_code | string | 仓库所在国家/地区二字码 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
warehouseCode | string | Option | 尾程仓库代码 |
fl_warehousecode | string | Option | 头程仓库代码 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
code | string | 运输方式代码 |
name | string | 运输方式中文名称 |
name_en | string | 运输方式英文名称 |
warehouse_code | string | 尾程仓库代码 |
fl_warehouse_code | string | 头程仓库代码 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
pageSize | Int | Option | 每页数据长度,不传值表示查询所有 |
page | Int | Option | 当前页,不传值表示查询所有 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
pagination | Object | 参考pagination格式 |
count | Int | 总数量 |
nextPage | String | 是否有下一页,true表示有,false表示没有 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
category_id | Int | 品类ID |
parent_category_id | string | 品类父ID |
category_name | string | 品类中文名 |
category_name_en | string | 品类英文名 |
category_level | Int | 品类级别 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
company_code | string | 公司代码 |
company_name | string | 公司名称 |
account_balance | string | 账户可用金额 |
freeze_amount | string | 账户冻结金额 |
currency | string | 币种 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
product_sku | string(40) | Require | SKU |
reference_no | string(25) | Option | 客户参考代码 |
product_title | string(255) | Require | 产品标题 |
product_weight | float | Require | 重量,单位KG |
product_length | float | Require | 长,单位CM |
product_width | float | Require | 宽,单位CM |
product_height | float | Require | 高,单位CM |
contain_battery | int | Require | 是否含电池,0不含,1含电池 |
product_declared_value | float | Require | 申报价值,币种为USD |
product_declared_name | string(50) | Require | 申报名称 (英文) |
product_declared_name_zh | string(150) | Option | 申报名称 (中文) |
cat_lang | string | Option | 品类语言,zh中文,en英文,默认为en |
cat_id_level0 | int | Option | 一级品类 |
cat_id_level1 | int | Option | 二级品类 |
cat_id_level2 | int | Require | 三级品类 |
verify | int | Option | 不传或者传0,创建草稿产品,传1,创建正式产品 默认为0, 产品审核通过之后,不可编辑 |
hs_code | int(10) | Require | 海关编码 |
country_code | string(50) | Require | 进口国,国家/地区简称,多个参数用英文逗号隔开,可填写AU,CZ,ES,FR,IT,RU,GB,US |
product_classify | int | Option |
商品类型(默认为1) 1普通商品,2FBA商品 |
product_url | string | Required | 商品链接 |
is_brand | string | Required |
是否品牌 必填,填写Y或N |
product_brand | string | Option |
品牌名称 当商品为品牌商品时必填 |
product_model | string | Required | 型号 |
product_material | string | Required | 材质 |
product_transaction_unit | string | Required | 成交单位(英文) |
sku_map | string(40) | Require | 商品映射编码客户开启商品映射权限之后,可编辑 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
product_sku | String | SKU |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
product_sku | string(40) | Require | SKU |
reference_no | string(25) | Option | 客户参考代码 |
product_title | string(255) | Require | 产品标题 |
product_weight | float | Require | 重量,单位KG |
product_length | float | Require | 长,单位CM |
product_width | float | Require | 宽,单位CM |
product_height | float | Require | 高,单位CM |
contain_battery | int | Require | 是否含电池,0不含,1含电池 |
product_declared_value | float | Require | 申报价值,币种为USD |
product_declared_name | string(50) | Require | 申报名称 (英文) |
product_declared_name_zh | string(150) | Option | 申报名称 (中文) |
cat_lang | string | Option | 品类语言,zh中文,en英文,默认为en |
cat_id_level0 | int | Option | 一级品类 |
cat_id_level1 | int | Option | 二级品类 |
cat_id_level2 | int | Require | 三级品类 |
verify | int | Option | 不传或者传0,创建草稿产品,传1,创建正式产品 默认为0, 产品审核通过之后,不可编辑 |
hs_code | int(10) | Require | 海关编码 |
country_code | string(50) | Require | 进口国,国家/地区简称,多个参数用英文逗号隔开,可填写AU,CZ,ES,FR,IT,RU,GB,US |
product_classify | int | Option |
商品类型(默认为1) 1普通商品,2FBA商品 |
product_url | string | Required | 商品链接 |
is_brand | string | Required |
是否品牌 必填,填写Y或N |
product_brand | string | Option |
品牌名称 当商品为品牌商品时必填 |
product_model | string | Required | 型号 |
product_material | string | Required | 材质 |
product_transaction_unit | string | Required | 成交单位(英文) |
sku_map | string(40) | Require | 商品映射编码客户开启商品映射权限之后,可编辑 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
product_sku | String | SKU |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
data | Object(100) | Require | 对象数组 |
product_sku | string(40) | Require | SKU |
country_code | string(50) | Require | 国家/地区简称,多个参数用英文逗号隔开,可填写AU,CZ,ES,FR,IT,RU,GB,US |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
product_sku | String | SKU |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
pageSize | Int | Option | 每页数据长度,不传值表示查询所有 |
page | Int | Option | 当前页,不传值表示查询所有 |
product_sku | string | Option | SKU |
product_sku_arr | Object | Option | 多个SKU,数组格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
pagination | Object | 参考pagination格式 |
count | Int | 总数量 |
nextPage | String | 是否有下一页,true表示有,false表示没有 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
product_sku | string | SKU |
reference_no | string | 客户参考代码 |
product_status | string | 产品状态 X:废弃 D:草稿 S:可用 |
product_title | string | 产品标题 |
product_weight | float | 重量,单位KG |
product_length | float | 长,单位CM |
product_width | float | 宽,单位CM |
product_height | float | 高,单位CM |
contain_battery | int | 是否含电池,0不含,1含电池 |
product_declared_value | float | 申报价值,币种为USD |
product_declared_name | string | 申报名称 (英文) |
cat_lang | string | 品类语言,zh中文,en英文,默认为en |
cat_id_level0 | int | 一级品类 |
cat_id_level1 | int | 二级品类 |
cat_id_level2 | int | 三级品类 |
product_add_time | date | 添加时间 |
product_modify_time | date | 修改时间 |
sku_map | Object | 商品对应的映射(返回数组类型) |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
print_size | Int | Require | 打印尺寸(1:60*20,2:70*30,3:100*30) |
print_code | Int | Require | 打印编码(1:产品名称,2:made in china,3:1和2,4:都不选) |
product_sku_arr | Array | Require | SKU(一次不能超过300个) |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
Error | Object | 参考Error格式 |
data | Object | 数据内容 |
参数名 | 数据类型 | 说明 |
---|---|---|
label_image | string | 返回图片 |
image_type | Int | 图片类型 1:png,2:pdf |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
pageSize | Int | Option | 每页数据长度,不传值表示查询所有 |
page | Int | Option | 当前页,不传值表示查询所有 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
pagination | Object | 参考pagination格式 |
count | Int | 总数量 |
nextPage | String | 是否有下一页,true表示有,false表示没有 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
material | string | 材质值 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
pageSize | Int | Option | 每页数据长度,不传值表示查询所有 |
page | Int | Option | 当前页,不传值表示查询所有 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
pagination | Object | 参考pagination格式 |
count | Int | 总数量 |
nextPage | String | 是否有下一页,true表示有,false表示没有 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
en_name | string | 成交单位英文值 |
zh_name | string | 成交单位中文值 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
reference_no | string(32) | Require | 入库单参考号 |
transit_type | Int | Option | 0:中转代发;1:自发头程 |
income_type | Int | Option | 交货方式,0自送,1揽收 |
warehouse_code | string | Require | 目的仓 |
transit_warehouse_code | string | Require | 交货仓,交货方式为自送时,必填 |
shipping_method | string | Option | 运输方式,交货方式为自送时,必填 |
receiving_shipping_type | string | Require | 交货方式:0:空运(默认),2:快递,4:海运整柜,5:海运散货,6:铁运整柜,7:铁运散货 |
tracking_number | string(64) | Option | 跟踪号,交货方式为自送时,必填 |
receiving_desc | string(500) | Option | 入库单描述 |
eta_date | date | Require | 预计到达日期 |
verify | Int | Option | 是否审核,0新建不审核(草稿状态),1新建并审核, 默认为0, 审核通过之后,不可编辑 |
is_box_product | int | Option | 是否仓库装箱商品 1否2是,默认为否,为2时items参数需要新增参数 |
items | Object | Require | 入库单明细 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
product_sku | string | Require | SKU |
quantity | int | Require | 数量 |
box_no | int | Require | 箱号 |
fba_product_code | string | Option | FBA商品编码 |
fba_box_no | string | Option | 箱唛号,is_box_product=2时为必填 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
receiving_code | String | 系统生成的入库单号 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
receiving_code | string | Require | 入库单号 |
reference_no | string(32) | Require | 入库单参考号 |
transit_type | Int | Option | 0:中转代发;1:自发头程 |
income_type | Int | Option | 交货方式,0自送,1揽收 |
warehouse_code | string | Require | 目的仓 |
transit_warehouse_code | string | Require | 交货仓,交货方式为自送时,必填 |
shipping_method | string | Option | 运输方式,交货方式为自送时,必填 |
receiving_shipping_type | string | Require | 交货方式:0:空运(默认),2:快递,4:海运整柜,5:海运散货,6:铁运整柜,7:铁运散货 |
tracking_number | string(64) | Option | 跟踪号,交货方式为自送时,必填 |
receiving_desc | string(500) | Option | 入库单描述 |
eta_date | date | Require | 预计到达日期 |
verify | Int | Option | 是否审核,0新建不审核(草稿状态),1新建并审核, 默认为0, 审核通过之后,不可编辑 |
is_box_product | int | Option | 是否仓库装箱商品 1否2是,默认为否,为2时items参数需要新增参数 |
items | Object | Require | 入库单明细 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
product_sku | string | Require | SKU |
quantity | int | Require | 数量 |
box_no | int | Require | 箱号 |
fba_product_code | string | Option | FBA商品编码 |
fba_box_no | string | Option | 箱唛号,is_box_product=2时为必填 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
receiving_code | String | 系统生成的入库单号 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
pageSize | Int | Require | 每页数据长度,最大值为20 |
page | Int | Require | 当前页 |
receiving_code | string | Option | 入库单号 |
receiving_code_arr | Object | Option | 多个入库单号,数组格式 |
create_date_from | date | Option | 创建开始日期 |
create_date_to | date | Option | 创建结束日期 |
modify_date_from | date | Option | 修改开始时间 |
modify_date_to | date | Option | 修改结束时间 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
pagination | Object | 参考pagination格式 |
count | Int | 总数量 |
nextPage | String | 是否有下一页,true表示有,false表示没有 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
receiving_code | string | 入库单号 |
reference_no | string | 入库单参考号 |
income_type | Int | 交货方式,0自送,1揽收 |
warehouse_code | string | 目的仓库 |
transit_warehouse_code | string | 交货仓库 |
shipping_method | string | 运输方式 |
tracking_number | string | 跟踪号 |
receiving_status | string | 跟入库单状态 C:新建 W:头程在途 P:头程收货中 Z:转运中 G:目的仓库收货中 F:目的仓收货完成 X:废弃踪号 |
receiving_desc | string | 入库单说明 |
eta_date | date | 预计到达日期 |
receiving_add_time | date | 创建日期 |
receiving_modify_time | date | 修改日期 |
box_total | int | 总箱数 |
sku_total | int | 产品总数 |
sku_species | int | SKU种类 |
items | Object | 入库单明细 |
参数名 | 数据类型 | 说明 |
---|---|---|
product_sku | string | SKU |
quantity | int | 数量 |
box_no | int | 箱号 |
fba_product_code | string | FBA商品编码 |
package_type | string | 包装类型 |
received_qty | int | 收货数量 |
putaway_qty | int | 上架数量 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
pageSize | Int | Require | 每页数据长度,最大值为100 |
page | Int | Require | 当前页 |
product_sku | string | Option | SKU |
product_sku_arr | Object | Option | 多个SKU,数组格式 |
warehouse_code | string | Option | 仓库代码 |
warehouse_code_arr | Object | Option | 多个仓库代码,数组格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
pagination | Object | 参考pagination格式 |
count | Int | 总数量 |
nextPage | String | 是否有下一页,true表示有,false表示没有 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
product_sku | string | SKU |
warehouse_code | string | 仓库代码 |
onway | int | 在途数量 |
pending | int | 待上架数量 |
sellable | int | 可售数量 |
unsellable | int | 不合格数量 |
reserved | int | 待出库数量 |
shipped | int | 历史出库数量 |
product_barcode | string | 商品条码(客户代码-商品编码) |
sold_shared | int | 已销售的共享数量 |
product_sales_value | int | 商品销售价值 |
warehouse_desc | int | 仓库描述 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
reference_no | string(32) | Require | 订单参考号(建议使用平台单号) |
platform | string | Option | 平台, EBAY, AMAZON, WISH, ALIEXPRESS OTHER 默认OTHER |
shipping_method | string(32) | Option | 配送方式,参考getShippingMethod |
order_desc | string(512) | Option | 备注 |
warehouse_code | string | Require | 配送仓库,参考getWarehouse |
country_code | string | Require | 收件人国家/地区,参考getCountry |
province | string(64) | Require | 省 |
city | string(32) | Require | 城市 |
address1 | string(216) | Require | 地址1 |
address2 | string(216) | Require | 地址2 |
zipcode | string(64) | Require | 邮编 |
doorplate | string(32) | Option | 门牌号 |
name | string(128) | Require | 收件人姓名 |
phone | string(64) | Require | 收件人联系方式 |
string(64) | Option | 收件人邮箱 | |
verify | Int | Option | 是否审核,0新建不审核(草稿状态),1新建并审核, 默认为0, 审核通过之后,不可编辑 |
is_signature | int | Option | 签名服务 1:签名服务 0:b不选择签名服务, 不填默认为0 |
is_insurance | int | Option | 保险服务, 不填为0 |
insurance_value | int | Option | 保额, 不填为0 |
fba_shipment_id | string | Option | FBA Shipment ID |
fba_shipment_id_suffix | int | Option | FBA Shipment ID后缀 1:是 0:否, 不填默认为1 |
fba_shipment_id_create_time | string | Option | FBA Shipment ID创建时间 |
box_qty | int | Option | 箱数 |
is_box_product | int | Option | 是否仓库装箱商品 1否2是,默认为否,为2时items参数需要更换 |
ioss_code | string(100) | Option |
IOSS号码
①所有从欧盟境外进入欧盟境内且销售价格≤150EUR的B2C包裹,在平台代扣代缴后,卖家将会获得IOSS号码。 ②DPD国际件非必填,但是若未填则仍需使用DDU的付税模式且只能发以下7个国家:Germany, France, Netherlands, Ireland, Spain, Austria & Italy。 ③Hermes国际非必填,但是若未填则仍需使用DDU的付税模式且只能发Ireland and the Netherlands。 ④发往北爱尔兰的包裹暂时不需要IOSS。 |
sender_vat | string(100) | Option |
发件人VAT
①DPD国际件暂时非必填。 ②hermes国际件暂时非必填。 |
sender_eori | string(100) | Option |
发件人EORI
①DPD国际件必填。 ②hermes国际件必填。 |
recipient_vat | string(100) | Option |
收件人VAT
①DPD国际发B2C包裹,则收件人的VAT暂时非必填;DPD国际发B2B包裹,则收件人的VAT必填。 ②hermes国际件暂时非必填。 |
recipient_eori | string(100) | Option |
收件人EORI
①DPD国际发B2C包裹,则收件人的VAT暂时非必填;DPD国际发B2B包裹,则收件人的VAT必填。 ②hermes国际暂时非必填。 |
pid_number | string(100) | Option |
PID号码
①该号码为收件人的身份证号码。 ②发往西班牙(150€以上)意大利的DPD国际件需必填,其他国家暂时非必填。 |
items | Object | Require | 订单明细 |
fileToUpload | string(base64) | Option | data:application/msword;base64,UEsDBAo...... |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
product_sku | string | Require | SKU |
quantity | int | Require | 数量 |
fba_product_code | string | Option | FBA商品编码 |
op_ref_tnx | string | Option | Transaction ID(明细ID) |
op_ref_item_id | string | Option | Item ID(挂单Id) |
box_no | string | Option | 箱唛号,装箱列表接口获取,is_box_product=2时为必填 |
fba_box_label | string | Option | FBA箱唛号 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
order_code | String | 系统生成的订单号 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
order_code | string | Require | 订单号 |
reference_no | string(32) | Require | 订单参考号(建议使用平台单号) |
order_desc | string(512) | Require | 订单备注 |
platform | string | Option | 平台, EBAY, AMAZON, WISH, ALIEXPRESS OTHER 默认OTHER |
shipping_method | string(32) | Option | 配送方式,参考getShippingMethod |
warehouse_code | string | Require | 配送仓库,参考getWarehouse |
country_code | string | Require | 收件人国家/地区,参考getCountry |
province | string(64) | Require | 省 |
city | string(32) | Require | 城市 |
address1 | string(216) | Require | 地址1 |
address2 | string(216) | Require | 地址2 |
zipcode | string(64) | Require | 邮编 |
doorplate | string(32) | Option | 门牌号 |
name | string(128) | Require | 收件人姓名 |
phone | string(64) | Require | 收件人联系方式 |
string(64) | Option | 收件人邮箱 | |
verify | Int | Option | 是否审核,0新建不审核(草稿状态),1新建并审核, 默认为0, 审核通过之后,不可编辑 |
is_signature | int | Option | 签名服务 1:签名服务 0:b不选择签名服务, 不填默认为0 |
is_insurance | int | Option | 保险服务, 不填为0 |
insurance_value | int | Option | 保额, 不填为0 |
fba_shipment_id | string | Option | FBA Shipment ID |
fba_shipment_id_suffix | int | Option | FBA Shipment ID后缀 1:是 0:否, 不填默认为1 |
fba_shipment_id_create_time | string | Option | FBA Shipment ID创建时间 |
box_qty | int | Option | 箱数 |
is_box_product | int | Option | 是否仓库装箱商品 1否2是,默认为否,为2时items参数需要更换 |
ioss_code | string(100) | Option |
IOSS号码
①所有从欧盟境外进入欧盟境内且销售价格≤150EUR的B2C包裹,在平台代扣代缴后,卖家将会获得IOSS号码。 ②DPD国际件非必填,但是若未填则仍需使用DDU的付税模式且只能发以下7个国家:Germany, France, Netherlands, Ireland, Spain, Austria & Italy。 ③Hermes国际非必填,但是若未填则仍需使用DDU的付税模式且只能发Ireland and the Netherlands。 ④发往北爱尔兰的包裹暂时不需要IOSS。 |
sender_vat | string(100) | Option |
发件人VAT
①DPD国际件暂时非必填。 ②hermes国际件暂时非必填。 |
sender_eori | string(100) | Option |
发件人EORI
①DPD国际件必填。 ②hermes国际件必填。 |
recipient_vat | string(100) | Option |
收件人VAT
①DPD国际发B2C包裹,则收件人的VAT暂时非必填;DPD国际发B2B包裹,则收件人的VAT必填。 ②hermes国际件暂时非必填。 |
recipient_eori | string(100) | Option |
收件人EORI
①DPD国际发B2C包裹,则收件人的VAT暂时非必填;DPD国际发B2B包裹,则收件人的VAT必填。 ②hermes国际暂时非必填。 |
pid_number | string(100) | Option |
PID号码
①该号码为收件人的身份证号码。 ②发往西班牙(150€以上)意大利的DPD国际件需必填,其他国家暂时非必填。 |
items | Object | Require | 订单明细 |
fileToUpload | string(base64) | Option | data:application/msword;base64,UEsDBAo...... |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
product_sku | string | Require | SKU |
quantity | int | Require | 数量 |
fba_product_code | string | Option | FBA商品编码 |
op_ref_tnx | string | Option | Transaction ID(明细ID) |
op_ref_item_id | string | Option | Item ID(挂单Id) |
box_no | string | Option | 箱唛号,装箱列表接口获取,is_box_product=2时为必填 |
fba_box_label | string | Option | FBA箱唛号 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
order_code | String | 系统生成的订单号 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
order_code | string | Require | 订单号 |
reason | string | Option | 截单原因 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
order_code | String | 系统生成的订单号 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
order_code | string | Require | 订单号 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
order_code | string | 订单号 |
reference_no | string | 客户参考号 |
platform | string | 平台 |
order_status | string | 订单状态
C:待发货审核 W:待发货 D:已发货 H:暂存 N:异常订单 P:问题件 X:废弃 |
shipping_method | string | 配送方式 |
tracking_no | string | 跟踪号 |
warehouse_code | string | 配送仓库代码 |
order_weight | float | 订单重量 |
order_desc | string | 订单说明 |
date_create | datetime | 创建时间 |
date_release | datetime | 审核时间 |
date_shipping | datetime | 出库时间 |
date_modify | datetime | 修改时间 |
consignee_country_code | string | 收件人国家/地区二字码 |
consignee_country_name | string | 收件人国家/地区 |
consignee_state | string | 省 |
consignee_city | string | 城市 |
consignee_district | string | 区域 |
consignee_address1 | string | 地址1 |
consignee_address2 | string | 地址2 |
consigne_zipcode | string | 邮编 |
consignee_doorplate | string | 门牌号 |
consignee_company | string | 公司 |
consignee_name | string | 收件人姓名 |
consignee_phone | string | 收件人电话 |
consignee_email | string | 收件人邮箱 |
items | Object | 订单明细 |
fee_details | Object | 订单费用 |
orderBoxInfo | Object | 一票多箱装箱明细,一票一箱则返回空 |
参数名 | 数据类型 | 说明 |
---|---|---|
product_sku | string | SKU |
quantity | int | 数量 |
参数名 | 数据类型 | 说明 |
---|---|---|
totalFee | float | 总费用 |
SHIPPING | float | 运输费 |
OPF | float | 操作费用 |
FSC | float | 燃油附加费 |
DT | float | 关税 |
RSF | float | 挂号 |
WHF | float | 仓租 |
OTF | float | 其它费用 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
reference_no | string | Require | 参考号,仅返回有效订单数据 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
order_code | string | 订单号 |
reference_no | string | 客户参考号 |
platform | string | 平台 |
order_status | string | 订单状态
C:待发货审核 W:待发货 D:已发货 H:暂存 N:异常订单 P:问题件 X:废弃 |
shipping_method | string | 配送方式 |
tracking_no | string | 跟踪号 |
warehouse_code | string | 配送仓库代码 |
order_weight | float | 订单重量 |
order_desc | string | 订单说明 |
date_create | datetime | 创建时间 |
date_release | datetime | 审核时间 |
date_shipping | datetime | 出库时间 |
date_modify | datetime | 修改时间 |
consignee_country_code | string | 收件人国家/地区二字码 |
consignee_country_name | string | 收件人国家/地区 |
consignee_state | string | 省 |
consignee_city | string | 城市 |
consignee_district | string | 区域 |
consignee_address1 | string | 地址1 |
consignee_address2 | string | 地址2 |
consigne_zipcode | string | 邮编 |
consignee_doorplate | string | 门牌号 |
consignee_company | string | 公司 |
consignee_name | string | 收件人姓名 |
consignee_phone | string | 收件人电话 |
consignee_email | string | 收件人邮箱 |
items | Object | 订单明细 |
fee_details | Object | 订单费用 |
orderBoxInfo | Object | 一票多箱装箱明细,一票一箱则返回空 |
参数名 | 数据类型 | 说明 |
---|---|---|
product_sku | string | SKU |
quantity | int | 数量 |
参数名 | 数据类型 | 说明 |
---|---|---|
totalFee | float | 总费用 |
SHIPPING | float | 运输费 |
OPF | float | 操作费用 |
FSC | float | 燃油附加费 |
DT | float | 关税 |
RSF | float | 挂号 |
WHF | float | 仓租 |
OTF | float | 其它费用 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
pageSize | Int | Require | 每页数据长度,最大值100 |
page | Int | Require | 当前页 |
order_code | string | Option | 订单号 |
order_code_arr | Object | Option | 多个订单号,数组格式 |
shipping_method | string | Option | 运输方式代码 |
create_date_from | datetime | Option | 订单创建开始时间, 格式YYYY-MM-DD HH:II:SS 订单号传值时,该参数无效 |
create_date_to | datetime | Option | 订单创建结束时间, 格式YYYY-MM-DD HH:II:SS 订单号传值时,该参数无效 |
modify_date_from | datetime | Option | 订单修改开始时间, 格式YYYY-MM-DD HH:II:SS 订单号传值时,该参数无效 |
modify_date_to | datetime | Option | 订单修改结束时间, 格式YYYY-MM-DD HH:II:SS 订单号传值时,该参数无效 |
date_shipping_from | datetime | Option | 订单物流开始时间, 格式YYYY-MM-DD HH:II:SS 订单号传值时,该参数无效 |
date_shipping_to | datetime | Option | 订单物流结束时间, 格式YYYY-MM-DD HH:II:SS 订单号传值时,该参数无效 |
Order_status | datetime | String | 订单状态 C:待发货审核 W:待发货 D:已发货 H:暂存 N:异常订单 P:问题件 X:废弃 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
pagination | Object | 参考pagination格式 |
count | Int | 总数量 |
nextPage | String | 是否有下一页,true表示有,false表示没有 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
order_code | string | 订单号 |
reference_no | string | 客户参考号 |
platform | string | 平台 |
order_status | string | 订单状态
C:待发货审核 W:待发货 D:已发货 H:暂存 N:异常订单 P:问题件 X:废弃 |
shipping_method | string | 配送方式 |
tracking_no | string | 跟踪号 |
warehouse_code | string | 配送仓库代码 |
order_weight | float | 订单重量 |
order_desc | string | 订单说明 |
date_create | datetime | 创建时间 |
date_release | datetime | 审核时间 |
date_shipping | datetime | 出库时间 |
date_modify | datetime | 修改时间 |
consignee_country_code | string | 收件人国家/地区二字码 |
consignee_country_name | string | 收件人国家/地区 |
consignee_state | string | 省 |
consignee_city | string | 城市 |
consignee_district | string | 区域 |
consignee_address1 | string | 地址1 |
consignee_address2 | string | 地址2 |
consigne_zipcode | string | 邮编 |
consignee_doorplate | string | 门牌号 |
consignee_company | string | 公司 |
consignee_name | string | 收件人姓名 |
consignee_phone | string | 收件人电话 |
consignee_email | string | 收件人邮箱 |
items | Object | 订单明细 |
fee_details | Object | 订单费用 |
orderBoxInfo | Object | 一票多箱装箱明细,一票一箱则返回空 |
参数名 | 数据类型 | 说明 |
---|---|---|
product_sku | string | SKU |
quantity | int | 数量 |
参数名 | 数据类型 | 说明 |
---|---|---|
totalFee | float | 总费用 |
SHIPPING | float | 运输费 |
OPF | float | 操作费用 |
FSC | float | 燃油附加费 |
DT | float | 关税 |
RSF | float | 挂号 |
WHF | float | 仓租 |
OTF | float | 其它费用 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
warehouse_code | stringstring | Require | 发货仓库代码 |
country_code | string | Require | 目的国家/地区代码 |
shipping_method | string | Require | 配送方式 |
postcode | string | Option | 邮政编码 |
type | int | Require | 查询类型,type=1时为重量查询方式,type=2时为sku查询方式 |
weight | float | Require | 包裹重量,type=1时必填 |
length | float | Option | 包裹长 |
width | float | Option | 包裹宽 |
height | float | Option | 包裹高 |
pieces | int | Option | 订单内件数 |
sku | Object | Option | type=2时,sku对象必填,可多维,例:sku[{"product_barcode":"000028-MTLL","quantity":1}] |
product_barcode | string | Require | 产品名称,所属sku参数 |
quantity | int | Require | 数量,所属sku参数 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | Success查询成功,Failure查询错误 |
message | string | 返回信息 |
data | object | 数据内容 |
参数名 | 数据类型 | 说明 |
---|---|---|
totalFee | float | 总费用 |
SHIPPING | float | 运输费 |
OPF | float | 操作费用 |
FSC | float | 燃油附加费 |
DT | float | 关税 |
RSF | float | 挂号 |
WHF | float | 仓租 |
OTF | float | 其它费用 |
LLSC | float | 超长附加费 |
LLF | float | 超长费 |
LOC | float | 超长超大费 |
ODAR | float | 偏远费 |
ODASR | float | 超偏远费 |
WHOSCOW | float | 仓储操作附加费按重量 |
WHOSCOP | float | 仓储操作附加费按件数 |
OWF | float | 超重费 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
warehouse_code | String | Require | 发货仓库代码 |
country_code | string | Require | 目的国家/地区代码 |
shipping_method | string | Require | 配送方式(多个以逗号隔开,最多15个) |
postcode | string | Option | 邮政编码 |
weight | float | Require | 包裹重量 |
length | float | Option | 包裹长 |
width | float | Option | 包裹宽 |
height | float | Option | 包裹高 |
pieces | int | Option | 订单内件数 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
shipping_method | String | 配送方式 |
ask | String | 运算结果,Success表示成功,Failure表示失败 |
Error | Object | 参考Error格式 |
data | Object | 数据内容,ask为Success才返回 |
├─totalFee | float | 总费用 |
├─SHIPPING | float | 运输费 |
├─OPF | float | 操作费用 |
├─FSC | float | 燃油附加费 |
├─DT | float | 关税 |
├─RSF | float | 挂号 |
├─WHF | float | 仓租 |
├─OTF | float | 其它费用 |
├─LLSC | float | 超长附加费 |
├─LLF | float | 超长费 |
├─LOC | float | 超长超大费 |
├─ODAR | float | 偏远费 |
├─ODASR | ├─float | 超偏远费 |
├─WHOSCOW | float | 仓储操作附加费按重量 |
├─WHOSCOP | float | 仓储操作附加费按件数 |
├─OWF | float | 超重费 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
address | object | Require | 地址信息 |
shipping_method | string | Require | 配送方式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
oab_firstname | string | Require | 收件人名字 |
oab_company | string | option | 收件人姓 |
oab_street_address1 | string | Require | 收件人地址 1 |
oab_state | string | option | 州 |
oab_city | string | Require | 城市 |
oab_postcode | string | Require | 邮编 |
country_code | string | Require | 国家/地区简称 |
oab_phone | string | option | 联系电话 |
oab_street_address2 | string | option | 地址 2 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
address | Object | 校验后的地址信息 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
oab_firstname | string | 收件人名字 |
oab_company | string | 公司 |
oab_street_address1 | string | 地址 1 |
oab_state | string | 州 |
oab_city | string | 城市 |
oab_postcode | string | 邮编 |
country_code | string | 国家/地区简称 |
oab_phone | string | 联系电话 |
oab_street_address2 | string | 地址 2 |
is_residential | string | 0-非住宅,1-住宅 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
receiving_code | string | Option | 入库单号 |
print_size | Int | Require | 打印尺寸(1:60*20,2:70*30, 3:100*30) |
print_code | Int | Require | 打印编码(1:产品名称,2:made in china,3:1 和 2,4:都不选) |
product_barcode_arr | Array | Option | SKU(一次不能超过 50 个) |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
label_image | string | 返回图片 |
image_type | Int | 图片类型 1:png,2:pdf |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
receiving_code | string | Option | 入库单号 |
print_size | Int | Require | 打印尺寸(1:60*20,2:70*30, 3:100*30) |
print_type | Int | Require | 打印编码(1:产品名称,2:made in china,3:1 和 2,4:都不选) |
product_barcode_arr | Array | Option | SKU(一次不能超过 50 个) |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
label_iamge | string | 返回图片 |
image_type | Int | 图片类型 1:png,2:pdf |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
warehouse | string | Require | 仓库名称 |
product_barcode | string | Option | 产品代码 |
product_title | string | Option | 产品名称 |
part_time_start | int | Option | 库龄分段开始时间(单位天) |
part_time_end | int | Option | 库龄分段结束时间(单位天) |
dateFor | string | Option | 上架开始时间 |
dateTo | string | Option | 上架结束时间 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
product_barcode | string | 产品代码 |
receiving_code | string | 入库单号 |
ib_quantity | string | 可用数量 |
ib_add_time | string | 上架时间 |
ib_update_time | string | 更新时间 |
age | int | 库龄 |
product_title | string | 产品名称 |
warehouse_desc | string | 仓库名称 |
warehouse_code | string | 仓库代码 |
ageGroup | string | 库龄分段 |
ig_name | string | 品类名称 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
order_code | string | Require | 订单号 |
ref_no | string | 参考号 | |
is_verify | string | 是否审核 0-否 1-是 | |
logistics | string | Require | 派送方式 0代选,1自选 |
warehouse_code | string | Require | 退件收货仓库 |
courier | string | Require | 物流产品(代选物流必须填写) |
tracking_no | string | Require | 跟踪号(自选物流必须填写) |
is_auth | string | 是否授权 0 未授权1 授权 默认授权 | |
photo_no | Int | 拍照数量 | |
ro_desc | string | 退件原因 | |
op_quantity | Object | Require | 退件产品明细 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
product_barcode | string | Require | 产品编码 |
num | int | Require | 数量 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
Asro_code | String | 系统生成的售后单号 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
return_code | string | Require | 退件号 |
logistics | string | Require | 派送方式 0代选,1自选 |
warehouse_code | string | Require | 退件收货仓库 |
courier | string | Require | 物流产品(代选物流必须填写) |
tracking_no | string | Require | 跟踪号(自选物流必须填写) |
is_auth | string | 是否授权 0 未授权1 授权 默认授权 | |
photo_no | Int | 拍照数量 | |
ro_desc | string | 退件原因 | |
op_quantity | Object | Require | 退件产品明细 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
product_barcode | string | Require | 产品编码 |
num | int | Require | 数量 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
Asro_code | String | 售后单号 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
ro_code | string | Require | 退件号 |
new_desc | string | 退件原因 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
result | String | 1表示成功,2表示失败 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
pageSize | string | Require | 每页数据长度, 最大值100 |
currentPage | string | Require | 当前页 |
startTime | string | 创建时间 | |
endTime | string | 结束时间 | |
asroStatus | string | 退件状态 (0-待审核,1-待处理,2-待确认,3-已确认,4-收货完成,5-处理完成,6-废弃,7-销毁) | |
cassType | string | 退件类型 0-服务商退件,1-客户退件,2-未预报退件 | |
asroCodes | string | 退件单号 | |
reference_no | string | 参考号 | |
order_code | string | 关联订单号 | |
tracking_no | string | 跟踪号 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
asro_code | string | 退件单号 |
reference_no | string | 参考号 |
asro_status | string | 退件状态 |
cass_type | string | 退件类型0-服务商退件,1-客户退件,2-未预报退件 |
asro_add_time | string | 创建时间 |
asro_audit_time | string | 审核时间 |
asro_putaway_time | string | 上架完成时间 |
warehouse_code | string | 退件收货仓库 |
sm_type | string | 派送方式 0-代选物流,1-自选物流 |
tracking_no | string | 跟踪号 |
asro_reason | string | 退件原因 |
is_auth | string | 0-未授权,1-授权 |
product_detail | Object | 退件产品明细 |
参数名 | 数据类型 | 说明 |
---|---|---|
product_barcode | string | 产品编号 |
quantity | Int | 退件数量 |
sellable_qty | Int | 良品数量 |
unsellable_qty | Int | 不良品数量 |
return_replacement_sku | string | 换标产品代码 |
ro_pd_quantity | Int | 上架数量 |
destruction_qty | Int | 销毁数量 |
pas_codes | Object | 售后码集合 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
reference_no | string | 参考号 | |
asroCodes | string | 退件单号 | |
order_code | string | 关联订单号 | |
tracking_no | string | 跟踪号 | |
以上参数四选一 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
asro_code | string | 退件单号 |
reference_no | string | 参考号 |
asro_status | string | 退件状态 (0-待审核,1-待处理,2-待确认,3-已确认,4-收货完成,5-处理完成,6-废弃,7-销毁) |
cass_type | string | 退件类型0-服务商退件,1-客户退件,2-未预报退件 |
asro_add_time | string | 创建时间 |
asro_audit_time | string | 审核时间 |
asro_putaway_time | string | 上架完成时间 |
warehouse_code | string | 退件收货仓库 |
sm_type | string | 派送方式 0-代选物流,1-自选物流 |
tracking_no | string | 跟踪号 |
asro_reason | string | 退件原因 |
is_auth | string | 0-未授权,1-授权 |
product_detail | Object | 退件产品明细 |
参数名 | 数据类型 | 说明 |
---|---|---|
product_barcode | string | 产品编号 |
quantity | Int | 退件数量 |
sellable_qty | Int | 良品数量 |
unsellable_qty | Int | 不良品数量 |
return_replacement_sku | string | 换标产品代码 |
ro_pd_quantity | Int | 上架数量 |
destruction_qty | Int | 销毁数量 |
pas_codes | Object | 售后码集合 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
warehouse | string | option | 收货仓库 |
ro_process_type | string | option | 处理方式(:0:未指定,1:退件入库) |
ro_create_type | string | option | 退件类型(0:买家退件,1:服务商退件) |
ro_status | string | option | 退件状态(0:已作废,1:待确认,2:待处理,3:到货异常,4:收货完成,5:上架完成) |
refrence_no_platform | string | option | 订单号 |
ro_code | string | option | 退件单号 |
tracking_number | string | option | 跟踪号 |
dateFor | string | option | 创建开始时间 |
dateTo | string | option | 创建结束时间 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
refrence_no_platform | string | 订单号 |
warehouse | string | 仓库 |
ro_code | string | 退件单号 |
tracking_number | string | 跟踪号 |
status_name | string | 状态 |
type_name | string | 退件类型 |
process_type_name | string | 处理方式 |
ro_add_time | string | 添加时间 |
ro_receiving_time | string | 收货时间 |
ro_first_shelve_time | string | 上架时间 |
ro_desc | string | 备注 |
product | string | 产品数据内容 |
参数名 | 数据类型 | 说明 |
---|---|---|
product_barcode | string | 产品代码 |
rop_quantity | string | 数量 |
received_qty | string | 实收数量 |
quantity_unsellable | string | 不良品数量 |
ro_pd_quantity | string | 上架数量 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
ref_no | string | Require | 参考号 |
asro_code | string | Require | 退件单号 |
pas_codes | object | Require | 需要处理的售后码 |
退件号(退件号/参考号二选一,退件号不为空时,以退件号为准),处理时,该订单下所有的售后码都需要处理 |
参数名 | 数据类型 | 说明 |
---|---|---|
pas_code | string | 售后码 |
product_type | string | 产品类型:0-良品,1-不良品 |
deal_type | string |
处理方式0-重新上架(良品) 1- 销毁(不良品) 2-不良品上架(不良品) |
new_sku | string | 新sku |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
page | int | option | 分页页码,默认1 |
pageSize | int | option | 每页数量,默认20 |
order_status_type | string | option | 查询类型【'order'=>计划单号,'reference_no'=>参考号,'sku'=>商品编码,'box'=>箱唛号】 |
search_key | string | option | 查询传值 |
order_status | string | option | 订单状态【1待审核、2待装箱、3待作业、4已完成、5异常、6废弃】 |
warehouse_code | string | option | 仓库代码 |
is_mark | string | option | 换标服务 1是2否 |
mark_type | string | option | 换标要求 2外箱3内箱 |
create_time_for | string | option | 大于创建时间 |
create_time_to | string | option | 小于创建时间 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
data | Object | 数据内容 |
error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
fpo_id | int | 计划单ID |
fba_plan_order_code | string | 计划单号 |
customer_code | string | 客户代码 |
reference_no | string | 参考号 |
warehouse_code | int | 仓库ID |
warehouse_code | string | 仓库代码 |
is_mark | string | 换标服务 1是2否 |
mark_type | string | 换标要求 2外箱3内箱 |
order_status | string | FBA计划单状态【1待审核、2待装箱、3待作业、4已完成、5异常、6废弃】 |
order_status_text | string | FBA计划单状态 |
abnormal_status | string | 标记异常 0否1是 |
abnormal_cause | string | 异常原因 |
abnormal_cause_time | string | 标记异常时间 |
create_type | int | 0手动创建,1api创建 |
order_product | object | 计划单产品信息 |
参数名 | 数据类型 | 说明 |
---|---|---|
fba_plan_order_code | string | 所属计划单号 |
product_id | int | 产品ID |
op_category | int | 产品分类ID |
product_barcode | string | 产品SKU |
fnsku | string | fnsku |
product_name | string | 产品名称 |
product_name_en | string | 产品英文名 |
qty | int | 产品数量 |
mark_qty | int | 换标数量 |
length | string | 长 |
width | string | 宽 |
height | string | 高 |
weight | string | 重 |
declared_value | string | 产品价值 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
warehouse_code | string | Require | 仓库代码 |
dest_warehouse | string | Require | 目的仓库,当前仅FBA仓 |
is_mark | string | Require | 换标服务 1是2否 |
mark_type | string | Require | 换标要求 2外箱3内箱 |
verify | string | Option | 是否审核 0否1是 |
items | Object | Require | 计划单产品SKU明细 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
sku | string | Require | 产品编码 |
fnsku | string | Require | FNSKU,如果换标服务is_mark为1时,fnsku为必填 |
num | int | Require | 数量 |
mark_num | int | Require | 换标数量 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
data | Object | 数据内容 |
error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
fba_plan_order_code | string | 计划单号 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
fba_plan_order_code | string | Require | 计划单号 |
warehouse_code | string | Require | 仓库代码 |
dest_warehouse | string | Require | 目的仓库,当前仅FBA仓 |
is_mark | string | Require | 换标服务 1是2否 |
mark_type | string | Require | 换标要求 2外箱3内箱 |
items | Object | Require | 计划单产品SKU明细 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
sku | string | Require | 产品编码 |
fnsku | string | Require | FNSKU,如果换标服务is_mark为1时,fnsku为必填 |
num | int | Require | 数量 |
mark_num | int | Require | 换标数量 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
data | Object | 数据内容 |
error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
fba_plan_order_code | string | 计划单号 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
fba_plan_order_code | string | Require | 计划单号 |
reason | string | Require | 取消原因 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
fba_plan_order_code | string | 计划单号 |
参数名 | 数据类型 | 是否必填 | 说明 |
---|---|---|---|
page | int | option | 分页页码,默认1 |
pageSize | int | option | 每页数量,默认20 |
order_status_type | string | option | 查询类型【'order'=>计划单号,'relation_order_code'=>关联单号,'sku'=>商品编码,'box'=>箱唛号】 |
search_key | string | option | 查询传值 |
order_status | string | option | 箱唛状态【1待暂存 2已暂存 3已预占 4已出库】 |
warehouse_code | string | option | 仓库代码 |
is_mark | string | option | 换标服务 1是2否 |
mark_type | string | option | 换标要求 2外箱3内箱 |
create_time_for | string | option | 大于创建时间 |
create_time_to | string | option | 小于创建时间 |
参数名 | 数据类型 | 说明 |
---|---|---|
ask | string | 参考response公共参数 |
message | string | 参考response公共参数 |
data | Object | 数据内容 |
Error | Object | 参考Error格式 |
参数名 | 数据类型 | 说明 |
---|---|---|
fba_plan_order_code | string | 计划单号 |
box_no | string | 箱唛号 |
ts_code | string | 暂存编码 |
length | string | 长 |
width | string | 宽 |
height | string | 高 |
weight | string | 重 |
op_status | string | 箱唛状态【1待暂存 2已暂存 3已预占 4已出库】 |
customer_code | string | 客户编码 |
relation_order_code | string | 关联单号 |
box_create_time | string | 箱唛创建时间 |
box_allot_time | string | 箱唛分配时间 |
box_finish_time | string | 箱唛完成暂存时间 |
box_finish_time | string | 箱唛完成暂存时间 |
box_out_time | string | 箱唛出库时间 |
box_detail | object | 箱唛装箱详情信息 |
参数名 | 数据类型 | 说明 |
---|---|---|
product_barcode | string | 产品编号 |
qty | int | 产品数量 |
fnsku | int | 换标编码fnsku |
product | object | 对应产品信息 |
参数名 | 数据类型 | 说明 |
---|---|---|
fba_plan_order_code | string | 所属计划单号 |
product_id | int | 产品ID |
op_category | int | 产品分类ID |
product_barcode | string | 产品SKU |
fnsku | string | fnsku |
product_name | string | 产品名称 |
product_name_en | string | 产品英文名 |
qty | int | 产品数量 |
mark_qty | int | 换标数量 |
length | string | 长 |
width | string | 宽 |
height | string | 高 |
weight | string | 重 |
declared_value | string | 产品价值 |