addProduct创建商品，商品审核通过后可进行入库操作
谷仓开放平台已全新升级，旧版文档将不再更新，请您进入新版查阅最新文档
| 日期 | 变更内容 |
|---|---|
| 2021年5月17日 | 调整API文档结构，统一响应结构(ask, message, data)。 |
以下为较旧的发布日志。
2015年5月12日
新建API对接资料。
2015年7月8日
createOrder, modifyOrder 接口，增加forceVerify属性，用于强制审核。
2015年8月5日
getOrderByRefCode 接口 创建修改订单增加 签名保险服务等属性
2015年10月5日
addProduct、editProduct、getProductSkuList 接口,增加product_declared_name_zh(中文申报品名)属性
2016年1月1日
新建入库单增加transit_type字段。getOrderByCode接口支持参考编号请求
2016年5月4日
头程入库单与尾程订单增加FBA
2016年5月4日
创建产品 修改产品 增加hs_code,warning_qty 字段
2016年5月4日
GetOrderByCode、getOrderByRefCode、 getOrderList接口增加了一票多箱装箱明细，一票一箱返回空值。
2017年5月9日
createOrder接口shipping_method为空系统推荐价格最优发货渠道；forceVerify判断逻辑修改（详细见接口说明）
2017年7月11日
createAsn 接口 增加 lanshou_time 中转仓上门揽收时间 ，volume 入库单体积 weight入库单重量； 增加 中转入库单附件上传 接口 接口字段 ： documents 单证 manufacturer 制造商资料 增加揽收时间 ：lanshou_time
2017年11月30日
getAsnList 接口增加 transit_type、sm_code、receiving_shipping_type、container_number字段。
getShippingMethod 接口增加 is_signature、sp_code、type字段。
2018年5月19日
创建售后单 createAfterReturnOrder 接口 (is_auth, photo_no)废弃 (warehouse_code)必填 (logistics)物流产品，当派送方式为0时，必填
修改售后单 updateAfterReturnOrder 接口 (is_auth, photo_no)废弃 (logistics)物流产品，当派送方式为0时，必填
2018年5月21日
售后单查询 searchReturnOrder 接口 (asro_status,sm_code,is_auth,pas_codes)加描述
售后单列表 getAfterReturnOrders 接口 (asro_status,sm_code,is_auth,pas_codes)加描述 (pageSize,currentPage)必填
2019年11月28日
创建中转入库单 废弃字段：weight,volume,pickup_form,invoice_base64,clearance_file 新增字段：car_model_code
修改中转入库单 废弃字段：weight,volume,pickup_form,invoice_base64,clearance_file 新增字段：car_model_code
新增接口 获取FMS物流产品与目的仓中转仓
新增接口 获取FMS车型
2019年11月29日
11月22日目的仓为美南仓时创建、编辑入库单接口商品SKU种数限制
【商品更新】接口增加货型字段
【获取产品列表】中增加货型字段
2019年12月18日
【创建中转入库单】接口增加重量和体积字段
【编辑中转入库单】接口增加重量和体积字段
2020年01月03日
【产品管理->打印sku】打印尺寸增加A4尺寸, 去除60*20
2020年07月27日
【入库单管理(新)->获取入库单明细】增加字段 gc_putaway_time 上架时间
接入API对接平台开发，开发者需要按照如下步骤完成：
GD地址： https://oms.goodcang.com，请自行注册用户，并使用注册账号（即主账号）登陆。
addProduct创建商品，商品审核通过后可进行入库操作
新品创建入库单，仓储完成收货，质检，上架后可进行订单的创建
商品有库存后可以通过该接口创建订单，仓储进行下架、分拣、打包发货
请求公共参数
| 序号 | 参数 | 类型 | 必填项 | 描述 |
|---|---|---|---|---|
| 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 | √ | 当前页 |
谷仓开放服务平台提供完善的API接口服务，卖家系统与谷仓仓储系统实现无缝对接
电商系统通常只需对接谷仓仓储创建商品、创建入库单、创建订单、获取跟踪号接口就能完成仓储货品入库，出库的运作。
接口接入顺序如下：
说明：/product/add_product 客户系统对接创建商品接口，推送产品信息到仓储。
说明：/inbound_order/create_grn 推送入库单的信息到仓储。
说明：完成商品创建和入库之后，可通过 /inventory/get_product_inventory 获取商品库存信息
说明：createOrder创建订单，推送订单信息，如：收件人信息，包裹信息等；
根据订单号获取单票订单信息： /order/get_order_by_code（订单号是新建订单成功后仓储系统返回给客户的单号如：000010-170310-0003）
根据参考号获取单票订单信息：/order/get_order_by_ref_code（参考号一般是卖家系统的订单号）
鉴于SOAP协议较老旧，且存在一些不可克服的缺陷，同时听取广大用户的建议和心声。我们决定在全新API上，使用行业广泛使用，广受开发者欢迎的RESTFUL WEB API协议。
为了兼容已接入的客户，对于存量API，既支持SOAP协议，亦支持RESTFUL WEB API协议，而全新的API，则仅支持RESTFUL WEB API协议。
鉴权信息与SOAP保持不变，不过，RESTFUL WEB API鉴权信息通过http请求的header中带到GD OPEN API。
同时，为了方便服务端以正确的格式向客户端响应，和以正确的格式读取客户端请求，请传入必要的Accept与Content-Type参数。
请在header中传入以下key和对应的值：
KEY |
数据类型 |
是否必填 |
内容 |
|---|---|---|---|
app-token |
String |
Required |
对应SOAP上的appToken。 |
app-key |
String |
Required |
对应SOAP上的appKey。 |
Accept |
String |
Required |
方便服务端在返回不可预知的异常发生时，以JSON的形式返回给客户端 请输入值 application/json |
Content-Type |
String |
Required |
请输入 application/json |
如果API请求成功，且无报错消息，那么http status code为200，响应JSON里的code为0。
否则，http status code为非200，可能是5XX，或者4XX，甚至是其它。
同时，如果是服务端可以捕获到的错误或者异常，会在响应的JSON里返回message(错误提示消息)，code为非0的值(code的值如果有特别含义的话，具体以不同API说明文档为准)。
API请求错误示范
以下为PHP代码为示范，调用 财务中心-获取费用流水 API，开发者可以以此为参考一起步调试。
API标题带有RESTFUL V1 表示是V1版本，RESTFUL 表示V2版本。
V1与V2的区别主要是响应结构不一样，V1用结构一般是 { "ask":"Success", "message":null }，而V2是{ "code":0, "message":null, "error_id":null }。
除上述区别外，V1与V2接入方式没有区别，开放平可以放心接入，若有疑问，可以联系技术支持了解更多信息。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| 无 | |||||
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object[] | 国家/地区数据数组，数组元素对象说明参见下文CountryListItem。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| country_code | String | 国家/地区二字码 |
| country_name | String | 国家/地区中文名 |
| country_name_en | String | 国家/地区英文名 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| 无 | |||||
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object[] | 仓库数据数组，数组元素对象说明参见下文WarehouseListItem。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| warehouse_code | String | 仓库代码 |
| warehouse_name | String | 仓库名称 |
| country_code | String | 仓库所在国家/地区代码 |
| wp_list | Object[] | 物理仓对象数组，数组元素对像结构参见 PhysicalWarehouseItem 对象。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | String | 物理仓代码 |
| name | String | 物理仓名称 |
| address | Object[] | 地址信息，参见 PhysicalWarehouseAddress |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| state | String | 省/州 |
| city | String | 城市 |
| postcode | String | 邮编 |
| contacter | String | 联系人 |
| phone | String | 电话 |
| street_address1 | String | 地址1 |
| street_address2 | String | 地址2 |
| street_number | String | 门牌号 |
说明：获取系统中 所有物流派送方式的物流代码和物流产品中英文名称，和对应支持派送的仓库信息。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| warehouseCode | String | Optional | 32 | 尾程仓库代码 | USWE |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object[] | 物流方式数据数组，数组元素对象说明参见下文ShippingMethodListItem。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | String | 物流产品代码 |
| name | String | 物流产品中文名称 |
| name_en | String | 物流产品英文名称 |
| warehouse_code | String | 仓库代码 |
| type | String | 物流产品类型
0-尾程物流产品 1-退件代选物流产品 2-头程物流产品 3-退件自选物流产品 4-未预报退件物流产品 5-销毁物流产品 6-自提物流产品 |
| sp_code | String | 服务商代码 |
| is_signature | Number | 是否支持签名服务（0 否，1 是） |
| address_validation_enabled | Number | 是否支持地址校验（0 不支持，1 支持） |
| is_truck | Number | 是否卡派渠道（0 否，1 是） |
| is_specify_arrival_time | Number | 是否指定到货时间（1 支持，2 不支持） |
| delivery_time_list | String[] | 支持的到货时间段 |
| sm_business_type | Int | 业务类型
1：仓配一体 3：仓配分离 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| 无 | |||||
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 账户详情，请参见下文 AccountItem。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| customer_code | String | 客户代码 |
| account_list | Object[] | 账户信息数据数组，数组元素请参见下文 AccountListItem。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| firm_name | String | 签约主体名称（例如企业名称） |
| firm_status | String | 签约主体状态
0-审核中 1-审核不通过 2-可用 3-停用 4-已作废 5-草稿 6-待签约 |
| server_firm_name | String | 服务主体
0-深圳谷仓科技有限公司 1-ETARGET LIMITED 2-ELOGISTIC |
| business_type_list | String | 签约业务类型
0-海外仓储 1-中转代发 |
| balance_list | Object[] | 币种信息数组，数组元素请参见下文 BalanceListItem。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| currency_code | String | 公司代码 |
| amount | String | 金额（双精度数字，避免精度丢失，API以字符串形式返回，请客户端酌情处理） |
说明：上传附件，并返回附件ID，配合其他业务接口使用。 注意：每种 use_for 类型，服务端同时只能处理一次请求，并发调用将拒绝处理。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| file | string | Required | base64 | 文件base64内容。 | |
| use_for | string | Required | 255 | 用途枚举选项 有效类型 参见 use_for 枚举选项，系统会不定期新增类型支持，敬请关注。 注意：文件mime类型与文件后缀必须保持一致，否则会导致文件上传失败。 |
ORDER_ATTACHMENT |
| file_name | string | Required | 255 | 完整文件名。 | TEST0008.txt |
请勿根据扩展名需求而随意选择枚举值，应该根据实际应用的场景对应的API文档说明上指明的附件枚举类型而定。
随意使用附件枚举类型，将可能收到报错响应。
| 枚举值 | 可上传文件尺寸 | 支持的文件类型 | 说明 |
|---|---|---|---|
| ORDER_ATTACHMENT | 5MB | xlsx, pdf, docx | 适用于订单附件 |
| GENERAL_ATTACHMENT | 10MB | xlsx, pdf, docx, jpg, jpeg, png | 适用于其他通用附件 |
| LOGISTIC_TICKET_ATTACHMENT | 10MB | jpg, jpeg, png, pdf | 适用于查件单附件 |
| ORDER_LABEL_ATTACHMENT | 10MB | pdf, png, jpg, jpeg, zpl, zpl2 | 适用于订单面单附件 |
| PO_ORDER_LABEL_ATTACHMENT | 50MB | 适用于订单维度PO面单附件 | |
| PO_BOX_LABEL_ATTACHMENT | 10MB | 适用于箱维度PO面单附件 | |
| BOX_LOGISTIC_LABEL_ATTACHMENT | 10MB | 适用于箱维度物流面单附件 | |
| NOTICE_LABEL_ATTACHMENT | 10MB | pdf, jpeg, jpg, png | 适用于ASN/ARN面单附件 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 返回数据，请参见下文data参数。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| attachment_id | Number | 附件ID（整型） |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| sign_business_type | Int | Required | 业务类型，(枚举类型)
0: 海外仓储 1: 中转代发 |
0 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object[] | 数组元素类型, 参见CostTypeItemResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| cost_name | String | False | 费用名称 |
| cost_code | String | False | 费用编码 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| logistic_type | Int | Required | 物流产品，(枚举类型)
0: 发货物流 1: 退货物流 |
0 | |
| sm_code | String | Required | 物流产品编码 | CZ_DHL_DOMESTICPK | |
| begin_time | String | Required | 起始生效时间（北京时间,31天跨度,时间区间参数必须成对出现） | 2021-09-15 00:00:00 | |
| end_time | String | Required | 结束生效时间（北京时间, 31天跨度，时间区间参数必须成对出现） | 2021-10-15 23:59:59 | |
| page | Int | Required | 分页页码 | 1 | |
| page_size | Int | Required | 分页数量(最大200) | 20 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 参见FuelRateListResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| list | Object[] | False | 燃油费率信息列表，数组元素定义参数 FuelRateItemResp |
| total | Int | False | 列表总数 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| fls_rate | String | False | 燃油费率 |
| fls_begin_time | String | False | 开始有效时间(北京时间) |
| fls_end_time | String | False | 结束有效时间(北京时间) |
| sm_name | String | False | 物流产品名称 |
| sm_code | String | False | 物流产品代码 |
说明：获取系统中所有的商品品类信息，创建商品时需要填写 相应商品的3级类目
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| 无 | |||||
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object[] | 系统品类数据数组，数组元素对象说明参见下文CategoryItem。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| category_id | Int | 品类ID |
| parent_category_id | Int | 品类父ID |
| category_name | String | 品类中文名 |
| category_name_en | String | 品类英文名 |
| category_level | Int | 品类级别 |
说明：获取谷仓系统建议的中文申报品名，建议新建商品时在这些选项中选择。 如果无匹配的选项，可以反馈给我们的技术支持，我们会考虑将选项加入系统中。 同时，商户可以按规则自由输入中文申报品名内容。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| 无 | |||||
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 申报品名数据，参见DeclareNameListResp |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| declare_list | String[] | 申报品名列表 |
说明：获取谷仓系统建议的商品材质，建议新建商品时在这些选项中选择。 如果无匹配的选项，可以反馈给我们的技术支持，我们会考虑将选项加入系统中。 同时，商户可以按规则自由输入材质内容。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| 无 | |||||
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 参见下文MaterialList。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| material_list | String[] | 材质列表 |
说明：在系统中创建商品信息，为后期发货和出单做基础数据。
注：商品编码和商品参考号是唯一。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 | SKU
商品编码限制24个字符, 仅支持：数字、字母、下划线、中横线、小数点、+ |
XH009 |
| sn_info | Object | Optional | 采集序列号信息, 参见 SnInfo 对象 | ||
| sku_wrapper_type | Int | Optional | SKU包装属性，默认预包装1：预包装 2：销售包装 3：原包彩盒 |
1 | |
| reference_no | String | Optional | 50 | 客户参考代码
增加输入字符数范围，商品参考号不能超过255个字符 |
GCC001002 |
| product_name_cn | String | Required | 255 | 商品名称
不能超过255个字符 |
电脑 |
| product_name_en | String | Required | 255 | 商品英文名称
不能超过255个字符,不支持中文 |
computer |
| product_weight | Float | Required | 7 | 重量，单位KG
取值范围0.001-9999.999，最多保留3位小数 |
10 |
| product_length | Float | Required | 6 | 长，单位CM
取值范围0.01-9999.99，最多保留2位小数 |
10 |
| product_width | Float | Required | 6 | 宽，单位CM
取值范围0.01-9999.99，最多保留2位小数 |
10 |
| product_height | Float | Required | 6 | 高，单位CM
取值范围0.01-9999.99，最多保留2位小数 |
6 |
| contain_battery | Int | Required | 货物属性，默认为0
0：普货
1：含电池
2：纯电池
3：纺织品
4：易碎品
6：超标纯电池
7：超标含电池
|
0 | |
| type_of_goods | Int | Required | 包裹类型
0：包裹 1：信封 |
0 | |
| cat_lang | String | Optional | 2 | 品类语言，默认为zh
zh：中文 en：英文 |
zh |
| cat_id_level2 | Int | Required | 品类ID
传值是获取系统品类接口返回的品类级别（category_level）为2的品类ID |
602276 | |
| verify | Int | Optional | 是否自动提交审核
0：创建 状态草稿下需要手动在oms 提交审核 1：默认推送wms 审核如不填 默认值是 0 注：审核之后产品信息不允许修改 |
0 | |
| product_declared_name_cn | String | Required | 255 | 中文申报品名 | 数据线 |
| product_declared_name | String | Optional | 255 | 英文申报品名 | data line |
| product_material | String | Required | 255 | 材质 | Metal |
| product_function | String | Optional | 100 | 用途 | phone |
| branded | Int | Required | 2 | 是否品牌
0：否 1：是 |
0 |
| product_brand | String | Optional | 100 | 商品品牌
- 当branded为1时必填 - 不能超过100个字符； |
苹果笔记本 |
| product_model | String | Optional | 100 | 商品型号
未填写默认“无”，表示无商品型号。 |
无 |
| product_link | String | Required | 1000 | 商品链接
最长1000字符：卖家在平台售卖的商品链接。 |
如：https://www.ebay.com.hk/itm/123456789.html |
| unit | String | Optional | 11 | 单位
- 枚举值有：台、米、箱等。 - 具体请看成交单位表，默认为PCS，校验是在计量单位表是否存在；如果退税，以出口增值税发票成交单位结算。 |
PCS |
| image_link | String[] | Optional | 300 | 商品图片链接
最多传10张 |
["http://pic3.nipic.com/20090527/1242397_102231006_2.jpg"] |
| export_country | Object | Required | 出口国关税信息维护，参见 ExportCountry 对象 | ||
| import_country | Object | Required | 进口国清关信息维护，参见 ImportCountry 对象 | ||
| certificate_url_list | String[] | Optional | 商品证书URL地址数组列表
最多允许30个 |
["http://pic3.nipic.com/20090527/xxx"] | |
| thirdparty_sku_mapping | String[] | Optional | 映射编码数组列表
最多填写1个，限制50个字符, 仅支持：数字、字母、下划线、中横线、小数点、+ |
["Blue2020_2XL"] | |
| return_auth | Int | Optional | 退件授权
0：未授权 1：已授权 传空则默认为：1（已授权） |
||
| return_replacement_sku | String | Optional | 换标编码 | ||
| batch_management_enabled | Integer | Optional | 是否进行批次管理：默认为0
0：否 1：是 |
0 | |
| batch_info | Object | Optional | 批次信息, 参见 BatchInfo 对象 | 0 | |
| battery_info | Object | Optional | 电池信息, 参见BatteryInfo对象
货物属性为以下值必填 6：超标纯电池 7：超标含电池 |
||
| remark | String | Optional | 备注
最大长度为500个字符 |
备注 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| validity_period_info | Object | Optional | 有效期批次信息，参见ValidityPeriodInfo |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| expiration_enabled | Integer | Required | 是否进行有效期管理
0：否 1：是 |
0 | |
| shelf_life_days | Integer | Optional | 有效期天数
- expiration_enabled=1时，必填 - 大于0小于等于9000的整数 |
360 | |
| outbound_threshold | Integer | Optional | 禁售天数
- expiration_enabled=1时，必填 - 大于等于0并且小于有效期天数的整数 |
10 | |
| warning_days | Integer | Optional | 预警天数
- expiration_enabled=1时，必填 - 大于禁售天数并且小于有效期天数的整数 |
30 | |
| inbound_threshold | Integer | Optional | 禁收天数
- expiration_enabled=1时，必填 - 大于禁售天数并且小于有效期天数的整数 |
90 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| country_code | String | Required | 2 | 国家/地区简称,目前只能填写CN | CN |
| declared_value | Float | Required | 6 | 申报价值 币种只能为USD，最多保留两位小数 取值范围0.01-9999.99，最多保留2位小数 |
10 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| country_code | String | Required | 2 | 国家/地区简称
可支持的国家/地区代码与您的账户所开通的仓库覆盖国家/地区相关， 查询已开通仓库请参见API「获取系统仓库」。 |
US |
| declared_value | Float | Required | 6 | 申报价值币种只能为USD 取值范围0.01-9999.99，最多保留2位小数 |
10 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| is_collect_serial_number | Int | Optional | 出库是否采集序列号
- 默认不采集，指仓库出库扫描时是否需采集商品序列号（SN码）信息。 - 如需要采集，请务必在序列号管理中提前维护商品的序列号信息 - 当入库是否采集序列号为是1时，出库是否采集序列号必须为1 0：不采集序列号 1：采集序列号 |
0 | |
| is_inbound_collect_serial_number | Int | Optional | 入库是否采集序列号
- 默认不采集，指仓库入库扫描时是否需采集商品序列号（SN码）信息。 - 如需要采集，请务必在序列号管理中提前维护商品的序列号信息 0：不采集序列号 1：采集序列号 |
0 | |
| is_return_collect_serial_number | Int | Optional | 退件是否采集序列号
- 默认不采集，指退件扫描时是否需采集商品序列号（SN码）信息 - 如需要采集，请务必在序列号管理中提前维护商品的序列号信息 - 当出库是否采集序列号为1时，退件是否采集序列号必须为1； 反之出库是否采集序列号为0时，退件是否采集序列号必须为0 0：不采集序列号 1：采集序列号 |
0 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| battery_model | String | Required | 50 | 电池型号 | GB-S04-733068 |
| un_code | String | Required | 16 | UN编码 | UN3480 |
| battery_power_range | Integer | Required | 电池功率范围（WH）
1：101WH~300WH 2：>300WH |
1 | |
| battery_power | Integer | Optional | 电池功率（WH） | 200 | |
| msds_file_url | String | Required | 300 | MSDS报告证书链接 | http://pic3.nipic.com/20090527/xxx |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 创建订单响应结构，参见 ProductMutationResp。 |
| product_sku | String | SKU |
| product_barcode | String | 商品条码 |
说明：修改商品的信息，只有在草稿状态的 产品信息才允许修改，提交审核之后商品信息不允许修改
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 | SKU
商品编码限制24个字符, 仅支持：数字、字母、下划线、中横线、小数点、+ |
XH009 |
| sn_info | Object | Optional | 采集序列号信息, 参见 SnInfo 对象 | ||
| reference_no | String | Optional | 50 | 客户参考代码
增加输入字符数范围，商品参考号不能超过255个字符 |
GCC001002 |
| product_name_cn | String | Required | 255 | 商品名称
不能超过255个字符 |
电脑 |
| product_name_en | String | Required | 255 | 商品英文名称
不能超过255个字符,不支持中文 |
computer |
| product_weight | Float | Required | 7 | 重量，单位KG
取值范围0.001-9999.999，最多保留3位小数 |
10 |
| product_length | Float | Required | 6 | 长，单位CM
取值范围0.01-9999.99，最多保留2位小数 |
10 |
| product_width | Float | Required | 6 | 宽，单位CM
取值范围0.01-9999.99，最多保留2位小数 |
10 |
| product_height | Float | Required | 6 | 高，单位CM
取值范围0.01-9999.99，最多保留2位小数 |
6 |
| contain_battery | Int | Required | 货物属性，默认为0
0：普货
1：含电池
2：纯电池
3：纺织品
4：易碎品
6：超标纯电池
7：超标含电池
|
0 | |
| type_of_goods | Int | Required | 包裹类型
0：包裹 1：信封 |
0 | |
| cat_lang | String | Optional | 6 | 品类语言，默认为zh
zh：中文 en：英文 |
zh |
| cat_id_level2 | Int | Required | 三级品类 | 602276 | |
| verify | Int | Optional | 是否自动提交审核
0：创建 状态草稿下需要手动在oms 提交审核 1：默认推送wms 审核如不填 默认值是 0 注：审核之后产品信息不允许修改 |
||
| product_declared_name_cn | String | Required | 255 | 中文申报品名 | 数据线 |
| product_declared_name | String | Optional | 255 | 英文申报品名 | data line |
| product_material | String | Required | 255 | 材质 | Metal |
| product_function | String | Optional | 100 | 用途 | phone |
| branded | Int | Required | 是否品牌
0：否 1：是 |
0 | |
| product_brand | String | Optional | 100 | 商品品牌
- 当branded为1时必填 - 不能超过100个字符； |
苹果笔记本 |
| product_model | String | Optional | 100 | 商品型号
未填写默认“无”，表示无商品型号。 |
无 |
| product_link | String | Required | 1000 | 商品链接
最长1000字符：卖家在平台售卖的商品链接。 |
如：https://www.ebay.com.hk/itm/123456789.html |
| unit | String | Optional | 11 | 单位
- 枚举值有：台、米、箱等。 - 具体请看成交单位表，默认为PCS，校验是在计量单位表是否存在；如果退税，以出口增值税发票成交单位结算。 |
PCS |
| image_link | String[] | Optional | 300 | 商品图片链接
最多传10张(有值就覆盖,没有值不处理) |
["http://pic3.nipic.com/20090527/1242397_102231006_2.jpg"] |
| export_country | Object | Required | 出口国关税信息维护，参见 ExportCountry 对象 | ||
| import_country | Object | Required | 口国清关信息维护，参见 ImportCountry 对象 | ||
| certificate_url_list | String[] | Optional | 商品证书URL地址数组列表
最多允许30个(有值就覆盖,没有值不处理) |
["http://pic3.nipic.com/20090527/xxx"] | |
| thirdparty_sku_mapping | String[] | Optional | 映射编码数组列表
最多填写1个，限制50个字符, 仅支持：数字、字母、下划线、中横线、小数点、+ |
["Blue2020_2XL"] | |
| return_auth | Int | Optional | 退件授权
0：未授权 1：已授权 传空则默认为：1（已授权） |
||
| return_replacement_sku | String | Optional | 换标编码 | ||
| batch_management_enabled | Integer | Optional | 是否进行批次管理：默认为0
0：否 1：是 |
0 | |
| batch_info | Object | Optional | 批次信息, 参见 BatchInfo 对象 | 0 | |
| sku_wrapper_type | Int | Optional | SKU包装属性，默认预包装1：预包装 2：销售包装 3：原包彩盒 |
1 | |
| battery_info | Object | Optional | 电池信息, 参见BatteryInfo对象
货物属性为以下值必填 6：超标纯电池 7：超标含电池 |
||
| remark | String | Optional | 备注
最大长度为500个字符 |
备注 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| validity_period_info | Object | Optional | 有效期批次信息，参见ValidityPeriodInfo |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| expiration_enabled | Integer | Required | 是否进行有效期管理
0：否 1：是 |
0 | |
| shelf_life_days | Integer | Optional | 有效期天数
- expiration_enabled=1时，必填 - 大于0小于等于9000的整数 |
360 | |
| outbound_threshold | Integer | Optional | 禁售天数
- expiration_enabled=1时，必填 - 大于等于0并且小于有效期天数的整数 |
10 | |
| warning_days | Integer | Optional | 预警天数
- expiration_enabled=1时，必填 - 大于禁售天数并且小于有效期天数的整数 |
30 | |
| inbound_threshold | Integer | Optional | 禁收天数
- expiration_enabled=1时，必填 - 大于禁售天数并且小于有效期天数的整数 |
90 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| country_code | String | Required | 2 | 国家/地区简称,目前只能填写CN | CN |
| declared_value | Float | Required | 6 | 申报价值 币种只能为USD，最多保留两位小数 取值范围0.01-9999.99，最多保留2位小数 |
10 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| country_code | String | Required | 2 | 国家/地区简称
可支持的国家/地区代码与您的账户所开通的仓库覆盖国家/地区相关， 查询已开通仓库请参见API「获取系统仓库」。 |
US |
| declared_value | Float | Required | 6 | 申报价值币种只能为USD 取值范围0.01-9999.99，最多保留2位小数 |
10 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| is_collect_serial_number | Int | Optional | 出库是否采集序列号
- 默认不采集，指仓库出库扫描时是否需采集商品序列号（SN码）信息。 - 如需要采集，请务必在序列号管理中提前维护商品的序列号信息 - 当入库是否采集序列号为是1时，出库是否采集序列号必须为1 0：不采集序列号 1：采集序列号 |
0 | |
| is_inbound_collect_serial_number | Int | Optional | 入库是否采集序列号
- 默认不采集，指仓库入库扫描时是否需采集商品序列号（SN码）信息。 - 如需要采集，请务必在序列号管理中提前维护商品的序列号信息 0：不采集序列号 1：采集序列号 |
0 | |
| is_return_collect_serial_number | Int | Optional | 退件是否采集序列号
- 默认不采集，指退件扫描时是否需采集商品序列号（SN码）信息 - 如需要采集，请务必在序列号管理中提前维护商品的序列号信息 - 当出库是否采集序列号为1时，退件是否采集序列号必须为1； 反之出库是否采集序列号为0时，退件是否采集序列号必须为0 0：不采集序列号 1：采集序列号 |
0 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| battery_model | String | Required | 50 | 电池型号 | GB-S04-733068 |
| un_code | String | Required | 16 | UN编码 | UN3480 |
| battery_power_range | Integer | Required | 电池功率范围（WH）
1：101WH~300WH 2：>300WH |
1 | |
| battery_power | Integer | Optional | 电池功率（WH） | 200 | |
| msds_file_url | String | Required | 300 | MSDS报告证书链接 | http://pic3.nipic.com/20090527/xxx |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 创建订单响应结构，参见 ProductMutationResp。 |
| product_sku | String | SKU |
| product_barcode | String | 商品条码 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| pageSize | Int | Required | 每页显示的sku 数量 | 10 | |
| page | Int | Required | 查询页数 | 1 | |
| product_sku | String | Optional | 24 | SKU精确搜索匹配 |
AALING1 |
| product_sku_arr | String[] | Optional | 多个SKU,数组格式精确搜索匹配 |
["EA14051211404212", "EA110"] | |
| product_update_time_from | Date | Optional | datetime | 修改开始时间 格式:Y-m-d H:i:s | 2020-07-15 09:00:00 |
| product_update_time_to | Date | Optional | datetime | 修改结束时间 格式:Y-m-d H:i:s | 2020-07-15 09:00:00 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| count | Int | 总数量 |
| data | Object[] | 商品数据对象数组，数组元素结构参见 ProductItem。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| product_sku | String | 商品编码 |
| reference_no | String | 客户参考代码 |
| product_status | String | 产品状态 X:废弃 D:草稿 S:可用 W:审核中 R:审核不通过 |
| product_title_cn | String | 商品名称 |
| product_title_en | String | 商品英文名称 |
| product_weight | Float | 重量，单位KG |
| product_length | Float | 长，单位CM |
| product_width | Float | 宽，单位CM |
| product_height | Float | 高，单位CM |
| contain_battery | Int | 货物属性，默认为0
0：普货
1：含电池
2：纯电池
3：纺织品
4：易碎品
6：超标纯电池
7：超标含电池
|
| type_of_goods | Int | 包裹类型。0包裹，1信封 |
| branded | Int | 是否品牌，0否，1是 |
| product_brand | String | 商品品牌 |
| product_model | String | 商品型号 |
| cat_lang | String | 品类语言，zh中文，en英文，默认为zh |
| cat_id_level0 | Int | 一级品类，参考getCategory |
| cat_id_level1 | Int | 二级品类，参考getCategory |
| cat_id_level2 | Int | 三级品类，参考getCategory |
| unit | String | 成交单位 |
| image_link | Object | 商品图片链接,数组格式 |
| product_link | String | 商品链接 |
| cargo_type | String | 货型 |
| Product_real_weight | Float | 实收重量，单位KG |
| Product_real_length | Float | 实收长，单位CM |
| Product_real_width | Float | 实收宽，单位CM |
| Product_real_height | Float | 实收高，单位CM |
| product_add_time | Date | 添加时间 |
| product_modify_time | Date | 修改时间 |
| tax_info | Object | 商品关税信息 |
| export_country | Object | 出口国关税信息维护 |
| import_country | Object | 进口国清关信息维护 |
| IsIrregular | Int | 是否异形商品，0否 1是 |
| check_remark | String | 查验审核备注 |
| import_country_remark | String | 进口国备注 |
| product_material | String | 材质 |
| product_function | String | 用途 |
| thirdparty_sku_mapping | String[] | 映射编码列表 |
| is_collect_serial_number | Bool | 出库是否采集序列号，指仓库出库扫描时是否需采集商品序列号（SN码）信息。 如需要采集，请务必在序列号管理中提前维护商品的序列号信息 |
| is_inbound_collect_serial_number | Bool | 入库是否采集序列号，指仓库入库扫描时是否需采集商品序列号（SN码）信息。 如需要采集，请务必在序列号管理中提前维护商品的序列号信息 |
| battery_info | Object | 电池信息, 参见BatteryInfo对象 |
| sku_wrapper_type | Int | SKU包装属性，默认预包装1：预包装 2：销售包装 3：原包彩盒 |
| remark | String | 备注 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| country_code | String | 国家简称 |
| declared_value | String | 申报价值 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| exportable_country | String | 可发国家 |
| product_declared_name | String | 申报品名 |
| tariff_calculation_value | Float | 关税计算值 |
| currency | String | 币种 |
| tariff_percentage | Float | 关税百分比 |
| additional_tax_rate | String | 附加关税税率 |
| vat_tax_rate | Float | VAT税率 |
| allow_save | String | 海外仓是否可存，是："Y"，否："N" |
| head_type | String | 头程类型;谷仓头程"GC",卖家直发："MJ" |
| declared_value | String | 申报价值 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| battery_model | String | 电池型号 |
| un_code | String | UN编码 |
| battery_power_range | Integer | 电池功率范围（WH） 1：101WH~300WH 2：>300WH |
| battery_power | Integer | 电池功率（WH） |
| msds_file_url | String | MSDS报告证书链接 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| battery_model | String | 电池型号 |
| un_code | String | UN编码 |
| battery_power_range | Integer | 电池功率范围（WH） 1：101WH~300WH 2：>300WH |
| battery_power | Integer | 电池功率（WH） |
| msds_file_url | String | MSDS报告证书链接 |
获取SKU条码标签PDF文件。
不支持一个SKU生成多个标签形式，如果商户希望一个标签打印多次，可以对标签PDF执行多次打印操作。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| print_size | Int | Required | 打印尺寸
2：70*30 3：100*30 4：A4 |
2 | |
| print_code | Int | Required | 打印编码
1：产品名称 2：made in china 5：商品英文名称 3：1和2 6：1和5 7：2和5 8：1和2和5都选 4：都不选 |
1 | |
| product_sku_arr | String[] | Required | 产品编码 字符串数组(一次不能超过50个) |
["SHOUCHIJI003","SHOUCHIJI004"] |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 数据内容 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| label_image | String | 返回图片 |
| image_type | Int | 1：png，2：pdf |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_country | Object | Required | 商品进口国清关信息（最多100个sku） |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 | 商品sku | AALING1 |
| import_country_data | Object | Required | 进口国清关信息 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| country_code | String | Required | 2 | 国家/地区简称
可支持的国家/地区代码与您的账户所开通的仓库覆盖国家/地区相关， 查询已开通仓库请参见API「获取系统仓库」。 |
US |
| declared_value | Float | Required | 6 | 申报价值币种只能为USD 取值范围0.01-9999.99，最多保留2位小数 |
10 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 | 商品SKU | AALING1 |
| image_link | String[] | Optional | 300 | 商品图片链接 （最多支持10张图片，超出的图片会覆盖之前上传的，图片链接与产品链接必填其一，（路径格式以http://或https://开头）） |
["http://pic3.nipic.com/20090527/1242397_102231006_2.jpg"] |
| product_link | String | Optional | 1000 | 商品链接 商品链接最多支持1000个字符 （图片链接与产品链接必填其一，（路径格式以http://或https://开头）） |
http://pic3.nipic.com/02231006_2.jpg |
| is_brand | String | Required | 1 | 是否品牌 只能输入Y/N |
N |
| product_brand | String | Optional | 100 | 商品品牌（is_brand为’Y‘时，必填） 不能超过100个字符 |
apple |
| product_model | String | Optional | 100 | 商品型号（is_brand为’Y‘时，必填） 不能超过100个字符 |
X11 |
| unit | String | Optional | 11 | 成交单位 不能超过50个字符,例如"pcs" |
PCS |
| export_country | String | Required | 32 | 出口国 CN |
CN |
| export_declared_value | Float | Required | 6 | 出口国申报单价
取值范围0.01-9999.99，最多保留2位小数 |
5 |
| attachments | Object[] | Required | 进口国附件对象 参见ProductAttachment |
||
| product_declared_name_cn | String | Optional | 255 | 中文申报品名 | 数据线 |
| product_declared_name | String | Optional | 255 | 英文申报品名 | data line |
| certification_file_url | String[] | Optional | 认证资料文件路径 （最多支持30个，路径格式以http://或https://开头） |
["http://pic3.nipic.com/02231006_2.zip"] |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| country_code | String | Required | 2 | 国家/地区简称 可支持的国家/地区代码与您的账户所开通的仓库覆盖国家/地区相关。 查询已开通仓库请参见API「获取系统仓库」。 |
US |
| import_declared_value | Float | Required | 6 | 进口国申报单价
取值范围0.01-9999.99，最多保留2位小数 |
10 |
| product_material | String | Optional | 255 | 材质 不能超过255个字符 |
塑料 |
| product_use | String | Optional | 100 | 用途 不能超过100个字符 |
家用 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| 当前状态 | 可转化状态 |
|---|---|
| 草稿 |
0: 废弃 3: 审核中 |
| 可用 |
0: 废弃 5: 暂存 |
| 暂存 |
0: 废弃 1: 可用 |
| 驳回 |
0: 废弃 3: 审核中 |
| 废弃 |
2: 草稿
|
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| sku | String | Required | 产品SKU | "ALEITEST1001" | |
| current_status | Int | Required | 当前状态，(枚举类型)
此状态用于乐观锁，即系统会判断当前商品状态是否依然是这个状态，否则返回错误，并中止流程。 0: 废弃 1: 可用 2: 草稿 4: 驳回 5: 暂存 |
1 | |
| change_status | Int | Required | 修改产品的目标状态，(枚举类型)
0: 废弃 1: 可用 2: 草稿 3: 审核中 4: 驳回 5: 暂存不能和当前状态相同 |
0 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| sn_list | Object[] | Required | 10 | 参见ProductSnItem类型 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 | SKU 商品编码限制24个字符, 仅支持：数字、字母、下划线、中横线、小数点、+ |
XH009 |
| data_code | String | Optional | 100 | 序列号集成码限制100个字符 | |
| serial_number_list | String[] | Required | 10 | 最多10个元素， 单个序列号限制100个字符，仅支持：数字、字母、下划线、中横线、小数点、+ |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object[] | 详情参见CreateSerialNumberItem类型。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| serial_number | string | 品类ID |
| status | String | 状态 |
| msg | String | 错误原因 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| sn_list | Object[] | Required | 10 | 参见ProductSnItem类型 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 | SKU 商品编码限制24个字符, 仅支持：数字、字母、下划线、中横线、小数点、+ |
XH009 |
| serial_number_list | String[] | Required | 10 | 最多10个元素， 单个序列号限制100个字符，仅支持：数字、字母、下划线、中横线、小数点、+ |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object[] | 详情参见DiscardSerialNumberItem类型。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| serial_number | string | 品类ID |
| status | String | 状态 |
| msg | String | 错误原因 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| status | Int | Optional | 查询类型，枚举值
0: 待收货
1: 待出库
2: 已出库
3: 已废弃
|
1 | |
| code_type | Int | Optional | 查询类型，枚举值
1: 序列号
2: 商品编码
3: 订单号
4: 序列号集成码
5: 入库单号
|
1 | |
| code_value | String | Optional | 查询值 | "" | |
| time_type | Int | Optional | 查询时间类型，枚举值
1: 创建时间
3: 出库时间
4: 废弃时间
|
1 | |
| start_time | String | Optional | 50 | 时间类型 开始时间和结束时间必须成对出现，且结束时间晚于开始时间 |
|
| end_time | String | Optional | 50 | 时间类型 开始时间和结束时间必须成对出现，且结束时间晚于开始时间 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 参见 SerialNumberDataResp类型。 |
| list | Object[] | 序列信息数组，数组元素参见SerialNumberListItem类型。 |
| total | Int | 总数 |
| order_code | String | 订单号 |
| product_sku | String | 商品编码 |
| serial_number | String | 商品编码 |
| status_text | String | 状态 |
| create_time | String | 创建时间 |
| update_time | String | 更新时间 |
| ship_time | String | 出库时间 |
| discard_time | String | 废弃时间 |
| data_code | String | 序列号集成码 |
| inbound_code | String | 入库单号 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 | 商品SKU
商品编码限制24个字符, 仅支持：数字、字母、下划线、中横线、小数点、+ 仅支持可用状态商品编码 |
abc-123 |
| carton_package | Object | Optional | 箱包装规格信息, 参见 ProductSpecInfo 对象 | ||
| box_package | Object | Optional | 盒包装规格信息, 参见 ProductSpecInfo 对象 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| unit_qty | Int | Optional | 1 | 内件数量以SKU维度的内部数量。 |
1 |
| package_size | Object | Optional | 包装尺寸无数据请传Null |
详见ProductPackageSizeInfo对象 | |
| weight | Float | Optional | 7 | 预报重量 单位KG，0.001~9999.999之间。 无数据请传null。 |
10.02 |
| barcode_list | String[] | Optional | 20 | 包装条码每个条码在GD系统唯一。 每个条码限制50个字符, 可支持：数字、字母、下划线、中横线、小数点。 最多支持输入20个条码。 |
["barcode1","barcode2","barcode3"] |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| length | Float | Optional | 7 | 预报长，单位CM
取值范围0.01-9999.99，最多保留2位小数 |
10.01 |
| width | Float | Optional | 7 | 预报宽，单位CM
取值范围0.01-9999.99，最多保留2位小数 |
10.02 |
| height | Float | Optional | 7 | 预报高，单位CM
取值范围0.01-9999.99，最多保留2位小数 |
10.03 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku_list | String[] | Required | 100 | 商品SKU字符串数组
最多支持100个元素。 |
["abc-123","sku-abc"] |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| unit_qty | Int | Required | 1 | 内件数量以SKU维度的内部数量。 |
1 |
| package_size | Object | Optional | 包装尺寸无数据请传Null |
详见ProductPackageSizeInfo对象 | |
| weight | Float | Optional | 7 | 预报重量 单位KG，0.001~9999.999之间。 无数据请传null。 |
10.02 |
| barcode_list | String[] | Optional | 20 | 包装条码每个条码在GD系统唯一。 每个条码限制50个字符, 可支持：数字、字母、下划线、中横线、小数点。 最多支持输入20个条码。 |
["barcode1","barcode2","barcode3"] |
| 参数名 | 数据类型 | 能否为空 | 说明 |
|---|---|---|---|
| code | Int | 0 成功，其它值表示失败。 | |
| message | String | 文本消息 | |
| data | Object[] | False | 参见ProductSpecComposite对象 |
| 参数名 | 数据类型 | 能否为空 | 说明 |
|---|---|---|---|
| product_sku | String | False | 商品SKU |
| carton_package | Object | True | 箱规格信息， 参见ProductSpecInfo对象 |
| box_package | Object | True | 盒规格信息, 参见ProductSpecInfo对象 |
| 参数名 | 数据类型 | 能否为空 | 说明 |
|---|---|---|---|
| unit_qty | Int | True | 内建数量 |
| package_size | Object | True | 箱规格信息， 参见ProductSpecSizeInfo对象 |
| weight | Float | True | 预报重量， 单位KG |
| barcode_list | String[] | True | 对应商品条码列表 |
| 参数名 | 数据类型 | 能否为空 | 说明 |
|---|---|---|---|
| length | Float | True | 预报重量， 单位CM |
| width | Float | True | 预报重量， 单位CM |
| height | Float | True | 预报重量， 单位CM |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| page_size | Int | Optional | 每页数据长度，最大值为200 | 10 | |
| page | Int | Optional | 当前页 | 1 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object[] | 进口商信息数组，数组元素参见VatItem类型。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| vat_type | Int | 进出口商,1：进口商,2：出口商 |
| company_name | String | 公司名称 |
| vat_number | String | 增值税号 |
| exemption_number | String | 增值税豁免号 |
| eori | String | EORI |
| warhouse_code | String | 海外仓仓库代码 |
| cv_contacter | String | 联系人 |
| cv_contact_phone | String | 联系人电话 |
| vat_email | String | 联系人邮箱 |
| cv_business_address | String | 公司主要营业地址 |
| importer_company_licence | Object | 营业执照/商业登记书文件，参见VatFile类型。 |
| gst_certificate | Object | 增值税证明文件，参见VatFile类型。 |
| cv_status | String | 0已废弃 1待审核 2审核通过 3审核驳回 |
| cv_create_time | Datetime | 创建时间 格式:Y-m-d H:i:s |
| auditing_time | Datetime | 审核时间 格式:Y-m-d H:i:s |
| cv_update_time | Datetime | 更新时间 格式:Y-m-d H:i:s |
| cv_id | Int | 进/出口商编码 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| file_url | String | 对应文件的URL访问地址（完整URL路径） |
| file_type | String | 返回文件类型 |
说明：获取中转入库单的中转物流产品，和对应的目的仓、中转仓及服务方式
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| 无 | |||||
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 运输方式对象，参见 InboundOrderDelivery |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| AIR | Object[] | 空运服务方式，对象数组，参见 InboundOrderDeliveryItem。 |
| LCL | Object[] | 海运散货服务方式，对象数组，参见 InboundOrderDeliveryItem。 |
| EXPRESS | Object[] | 快递服务方式，对象数组，参见 InboundOrderDeliveryItem。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| sm_code | String | 物流产品 |
| sm_code_name | String | 物流产品名称 |
| twc_to_warehouse | Object[] | 物流产品绑定中转仓目的仓对象数组，参见 InboundOrderDeliveryWarehouseItem。 |
| warehouse_code | String | 目的仓代码 |
| warehouse_name | String | 目的仓名称 |
| transit_warehouse_code | String | 中转仓代码 |
| transit_warehouse_name | String | 中转仓名称 |
说明：创建入库单
目的仓为美南仓库时，单个入库单最多只能录入20种SKU且货型为S或XS的商品不允许添加，单个海柜号最多只能录入20种SKU
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| reference_no | String | Optional | 50 | 参考号 | 2020062901 |
| transit_type | Int | Required | 入库单类型：
0：自发入库单 3：中转入库单 5：FBA入库单 |
3 | |
| receiving_shipping_type | Int | Required | 运输方式
0：空运 1：海运散货 2：快递 3：铁运整柜 4：海运整柜 5：铁运散货 |
0 | |
| tracking_number | String | Optional | 35 | 跟踪号/海柜号
中转选填，verify=1（入库单提交审核）时自发，FBA转仓必填 |
MATS7401101 |
| warehouse_code | String | Required | 32 | 海外仓仓库编码 | USEA |
| eta_date | Datetime | Optional | datetime | 预计到达时间
（格式：YYYY-MM-DD）。自发入库单和FBA入库单必填 |
2020-07-01 |
| receiving_desc | String | Optional | 255 | 备注 | 备注 |
| import_company | Int | Optional | 进口商编码
- 目的仓库对应的国家需要提供VAT(目前英国、德国、法国需要提供) - transit_type=3特有 - 必填条件：clearance_service=1（自有税号清关） |
785 | |
| verify | Int | Optional | 是否审核值
0：新建不审核(草稿状态) 1：新建并审核默认为0，审核通过之后，不可编辑 |
0 | |
| items | Object | Required | 入库单明细 | ||
| shiper_address | Object | Optional | 入库单发货地址
（仅适用于自发入库单） |
||
| sm_code | String | Required | 255 | 物流产品
transit_type=3特有。物流产品（整柜无需填） |
USEAAIRFREIGHT6000D |
| transit_warehouse_code | String | Required | 255 | 中转仓仓库编码
transit_type=3特有。（非整柜：物流产品绑定的中转仓库 ， 整柜：国内中转仓库） |
DG |
| customs_type | Int | Required | 报关方式
transit_type=3特有 0：EDI报关 1：委托报关 2：报关自理 |
1 | |
| collecting_service | Int | Required | 揽收服务
transit_type=3特有 0：自送货物 1：上门提货 |
1 | |
| collecting_address | Object[] | Optional | 揽收资料
transit_type=3特有 必填条件：当collecting_service=1（上门揽收）时必填 |
||
| collecting_time | Datetime | Optional | datetime | 揽收时间
transit_type=3特有 注：揽收时间不允许小于创建时间 |
2020-07-02 12:00 |
| customers_send_info | Object | Optional | 客户自送信息
- 参见 CustomersSendInfo 对象 - transit_type=3特有 - 必填条件：当collecting_service=0（自送货物）时必填 |
||
| value_add_service | String | Optional | 255 | 增值服务
transit_type=3特有 world_ease：worldease服务 origin_crt：产地证 fumigation：熏蒸 |
world_ease |
| clearance_service | Int | Required | 是否自有税号清关
transit_type=3特有 0：否（KJ清关：KJ税号） 1：是（KJ清关+自主税号） 注：当warehouse_code开启了VAT，必为1；如没开启，可选0或者1 |
0 | |
| export_company | Int | Optional | 出口商编码
transit_type=3特有 |
372 | |
| car_model_code | String | Optional | 255 | 车型 车型接口获取。transit_type=3特有。当collecting_service=1时必填。 | minivan |
| weight | Float | Optional | 8 |
重量(kg) 小于等于100000 取值范围0.01-999999.99，最多保留2位小数 |
10 |
| volume | Float | Optional | 5 |
体积(立方米) 小于等于100 取值范围0.01-99999.99，最多保留2位小数 |
10 |
| wp_code | String | Optional | 物理仓仓库代码
通过获取系统仓库接口获取物理仓编码，不传默认为仓库主物理仓编码。 |
||
| is_delay | Int | Optional | 是否递延，0否（默认），1是 | ||
| is_rollover | Int | Optional | 是否仓库装箱商品
0：否（默认） 1：是 transit_type=5（FBA入库单）必填 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| box_no | Int | Required |
箱号
从1开始的连续正整数 |
1 | |
| reference_box_no | String | Optional | 30 | 箱唛参考号 自发入库单/FBA入库单 才有该字段
FBA入库单，且为仓库装箱商品（is_rollover=1）时，必填。 |
1 |
| box_details | Object[] | Required | 箱子信息，参见对象 box_details。 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 | SKU | TEST20200428 |
| quantity | Int | Required | 数量
为仓库装箱商品（is_rollover=1）时，数量值会置为1。 |
10 | |
| fba_product_code | String | Optional | 20 | FBA商品编码
transit_type=5（FBA入库单）, 且不是仓库装箱商品（is_rollover=0）时，必填。 为仓库装箱商品（is_rollover=1）时，无需填写，该值会默认置空。 |
ABC |
| data_code | String | Optional | 100 | 序列号集成码，限制100个字符, | |
| serial_number | String | Optional | 100 | 序列号，限制6-100个字符, 仅支持：数字、字母、下划线、中横线、小数点、+ |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| sa_contacter | String | Required | 50 | 联系人 | lucy |
| sa_contact_phone | String | Required | 50 | 联系电话（手机号） | 18500000000 |
| sa_country_code | String | Required | 2 | 发件国家/地区简称 | CN |
| sa_state | String | Required | 50 | 省/州 | 广东省 |
| sa_city | String | Required | 50 | 城市 | 深圳市 |
| sa_region | String | Optional | 50 | 区 | 龙岗区 |
| sa_address1 | String | Optional | 50 | 地址1 | 创汇国际 |
| sa_address2 | String | Optional | 50 | 地址2 | 地址2 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| ca_first_name | String | Required | 50 | 揽收联系人-名 | Li |
| ca_last_name | String | Required | 50 | 揽收联系人-姓 | max |
| ca_contact_phone | String | Required | 50 | 揽收联系人电话 | 18565743265 |
| ca_state | String | Required | 50 | 揽收地址州/省份 | 广东省 |
| ca_city | String | Required | 50 | 揽收地址城市 | 深圳市 |
| ca_country_code | String | Required | 50 | 揽收地址国家/地区 | 中国 |
| ca_zipcode | String | Required | 50 | 揽收地址邮编 | 45362 |
| ca_address1 | String | Required | 50 | 揽收地址1 | 创汇国际 |
| ca_address2 | String | Required | 50 | 揽收地址2 | 地址2 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| arrive_transfer_warehouse_time | Datetime | Optional | datetime | 预计到达中转仓时间
注：时间需大于等于当前时间 |
2020-07-02 12:00:00 |
| company_name | String | Optional | 50 | 快递公司名称 | |
| delivery_code | String | Optional | 500 | 快递单号
注：多个快递单号用英文逗号隔开 |
|
| plate_no | String | Optional | 50 | 车牌号 | |
| driver_name | String | Optional | 50 | 司机姓名 | |
| driver_phone | String | Optional | 50 | 司机电话 仅支持输入数字、+、- |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 入库创建/修改响应结果，参见 InboundOrderMutationResp。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| receiving_code | String | 入库单单号 |
说明：编辑入库单，入库单草稿状态下才可以编辑
目的仓为美南仓库时，单个入库单最多只能录入20种SKU且货型为S或XS的商品不允许添加，单个海柜号最多只能录入20种SKU
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| reference_no | String | Optional | 50 | 参考号 | 2020062901 |
| receiving_code | String | Required | 255 | 入库单号 | RV000010-200714-0003 |
| transit_type | Int | Required | 入库单类型：
0：自发入库单 3：中转入库单 5：FBA入库单 |
3 | |
| receiving_shipping_type | Int | Required | 运输方式
0：空运 1：海运散货 2：快递 3：铁运整柜 4：海运整柜 5：铁运散货 |
0 | |
| tracking_number | String | Optional | 35 | 跟踪号/海柜号
中转选填，verify=1（入库单提交审核）时自发，FBA转仓必填 |
MATS7401101 |
| warehouse_code | String | Required | 32 | （非整柜：物流产品绑定的海外仓库， 整柜 ：海外目的仓库仓库代码） | USEA |
| eta_date | Datetime | Optional | datetime | 预计到达时间
（格式：YYYY-MM-DD）。自发入库单和FBA入库单必填 |
2020-07-01 12:00:00 |
| receiving_desc | String | Optional | 255 | 备注 | 备注 |
| import_company | Int | Optional | 进口商编码
- 目的仓库对应的国家需要提供VAT(目前英国、德国、法国需要提供) - transit_type=3特有 - 必填条件：clearance_service=1（自有税号清关） |
785 | |
| verify | Int | Optional | 是否审核值
0：新建不审核(草稿状态) 1：新建并审核默认为0，审核通过之后，不可编辑 |
0 | |
| items | Object | Required | 入库单明细 | ||
| shiper_address | Object | Optional | 入库单发货地址
（仅适用于自发入库单） |
||
| sm_code | String | Required | 255 | 物流产品
transit_type=3特有。物流产品（整柜无需填） |
USEAAIRFREIGHT6000D |
| transit_warehouse_code | String | Required | 255 | 中转仓仓库编码
transit_type=3特有。（非整柜：物流产品绑定的中转仓库 ， 整柜：国内中转仓库） |
DG |
| customs_type | Int | Required | 报关方式
transit_type=3特有 0：EDI报关 1：委托报关 2：报关自理 |
1 | |
| collecting_service | Int | Required | 揽收服务
transit_type=3特有 0：自送货物 1：上门提货 |
1 | |
| collecting_address | Array | Optional | 揽收资料
transit_type=3特有 必填条件：当collecting_service=1（上门揽收）时必填 |
||
| collecting_time | Datetime | Optional | datetime | 揽收时间
transit_type=3特有 当 collecting_service=1时必填。注：揽收时间不允许小于创建时间 |
2020-07-02 12:00 |
| customers_send_info | Object | Optional | 客户自送信息
- 参见 CustomersSendInfo 对象 - transit_type=3特有 - 必填条件：当collecting_service=0（自送货物）时必填 |
||
| value_add_service | String | Optional | 255 | 增值服务
transit_type=3特有 world_ease：worldease服务 origin_crt：产地证 fumigation：熏蒸 |
world_ease |
| clearance_service | Int | Required | 是否自有税号清关
transit_type=3特有 0：否（KJ清关：KJ税号） 1：是（KJ清关+自主税号） 注：当warehouse_code开启了VAT，必为1；如没开启，可选0或者1 |
0 | |
| export_company | Int | Optional | 出口商编码
transit_type=3特有 |
372 | |
| car_model_code | String | Optional | 255 | 车型 车型接口获取。transit_type=3特有。当collecting_service=1时必填。 | minivan |
| weight | Float | Optional | 8 | 重量(kg) 小于等于100000 最多保留2位小数 |
10 |
| volume | Float | Optional | 5 | 体积(立方米) 小于等于100 最多保留2位小数 |
10 |
| wp_code | String | Optional | 物理仓仓库代码
通过获取系统仓库接口获取物理仓编码，不传默认为仓库主物理仓编码。 |
||
| is_delay | Int | Optional | 是否递延，0否（默认），1是 | ||
| is_rollover | Int | Optional | 是否仓库装箱商品
0：否（默认） 1：是 不支持修改该选项，需与创建时的字段值一致。 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| box_no | Int | Required |
箱号
从1开始的连续正整数 |
1 | |
| reference_box_no | String | Optional | 30 | 箱唛参考号 自发入库单/FBA入库单 才有该字段
FBA入库单，且为仓库装箱商品（is_rollover=1）时，必填。 |
1 |
| box_details | Object[] | Required | 箱子信息，参见对象 box_details。 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 | SKU | TEST20200428 |
| quantity | Int | Required | 数量
为仓库装箱商品（is_rollover=1）时，数量值会置为1。 |
10 | |
| fba_product_code | String | Optional | 20 | FBA商品编码
transit_type=5（FBA入库单）, 且不是仓库装箱商品（is_rollover=0）时，必填。 为仓库装箱商品（is_rollover=1）时，无需填写，该值会默认置空。 |
ABC |
| data_code | String | Optional | 100 | 序列号集成码，限制100个字符, | |
| serial_number | String | Optional | 100 | 序列号，限制6-100个字符, 仅支持：数字、字母、下划线、中横线、小数点、+ |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| sa_contacter | String | Required | 50 | 联系人 | lucy |
| sa_contact_phone | String | Required | 50 | 联系电话（手机号） | 18500000000 |
| sa_country_code | String | Required | 2 | 发件国家/地区简称 | CN |
| sa_state | String | Required | 50 | 省/州 | 广东省 |
| sa_city | String | Required | 50 | 城市 | 深圳市 |
| sa_region | String | Optional | 50 | 区 | 龙岗区 |
| sa_address1 | String | Optional | 50 | 地址1 | 创汇国际 |
| sa_address2 | String | Optional | 50 | 地址2 | 地址2 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| ca_first_name | String | Required | 50 | 揽收联系人-名 | Li |
| ca_last_name | String | Required | 50 | 揽收联系人-姓 | max |
| ca_contact_phone | String | Required | 50 | 揽收联系人电话 | 18565743265 |
| ca_state | String | Required | 50 | 揽收地址州/省份 | 广东省 |
| ca_city | String | Required | 50 | 揽收地址城市 | 深圳市 |
| ca_country_code | String | Required | 50 | 揽收地址国家/地区 | 中国 |
| ca_zipcode | String | Required | 50 | 揽收地址邮编 | 45362 |
| ca_address1 | String | Required | 50 | 揽收地址1 | 创汇国际 |
| ca_address2 | String | Required | 50 | 揽收地址2 | 地址2 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| arrive_transfer_warehouse_time | Datetime | Optional | datetime | 预计到达中转仓时间
注：时间需大于等于当前时间 |
2020-07-02 12:00:00 |
| company_name | String | Optional | 50 | 快递公司名称 | |
| delivery_code | String | Optional | 500 | 快递单号
注：多个快递单号用英文逗号隔开 |
|
| plate_no | String | Optional | 50 | 车牌号 | |
| driver_name | String | Optional | 50 | 司机姓名 | |
| driver_phone | String | Optional | 50 | 司机电话 仅支持输入数字、+、- |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 入库创建/修改响应结果，参见 InboundOrderMutationResp。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| receiving_code | String | 入库单单号 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| receiving_code | String | Required | 255 | 入库单号 | RV000010-200714-0003 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | String | 返回结果 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| page_size | Int | Required | 每页数据长度，最大值为100 | 10 | |
| page | Int | Required | 当前页 | 1 | |
| receiving_code_arr | String[] | Optional | 多个入库单号,数组格式,最多100 | ["RVG296-190117-0005", "RVG296-190116-0060"] | |
| create_date_from | Date | Optional | datetime | 创建开始日期 | 2020-07-07 00:00:00 |
| create_date_to | Date | Optional | datetime | 创建结束日期 | 2020-07-07 23:59:59 |
| modify_date_from | Date | Optional | datetime | 修改开始时间 | 2020-07-07 23:59:59 |
| modify_date_to | Date | Optional | datetime | 修改结束时间 | 2020-07-07 23:59:59 |
| is_rollover | Int | Optional | 是否仓库装箱商品：0否，1是 | 1 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| count | Int | 总数量 |
| data | Object[] | 入库单信息数组，参见InboundOrderItem类型。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| receiving_code | String | 入库单号 |
| reference_no | String | 客户参考号 |
| transit_type | Int | 入库单类型
0标准入库单 3中转入库单 5FBA入库单 |
| sm_code | String | 服务方式(物流产品代码) |
| receiving_status | Int | 入库单状态
0草稿 1待审核 2审核不通过 3中转仓待签收 4中转仓待收货 5中转仓待配货 6中转仓待发货 7海外仓在途 8海外仓收货中 9海外仓收货完成 10海外仓上架完成 100废弃 |
| receiving_shipping_type | Int | 货运方式
0空运 1海运散货 2快递 3铁运整柜 4海运整柜 5铁运散货 |
| create_at | Date | 创建日期 |
| update_at | Date | 修改日期 |
| warehouse_code | String | 海外仓仓库编码 |
| box_total_count | Int | 预报箱数 |
| sku_total_count | Int | 预报sku件数 |
| overseas_box_total | Int | 海外仓入库端收货总箱数 |
| overseas_sku_total | Int | 海外目的仓收货总件数 |
| tracking_number | String | 跟踪号 |
| transit_warehouse_code | String | 国内中转仓库代码 |
| wp_code | String | 物理仓编码 |
| remark | String | 备注 |
| customs_docs_status | int | 报关资料上传状态
0无需上传 1未上传 2已上传 |
| is_rollover | Int | 是否仓库装箱商品
0否 1是 |
| track_status | String | 最后中转运输轨迹状态名称 |
| declaration_examine | int | 报关资料审核状态
1审核通过 2审核驳回 3待审核 4待上传 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| receiving_code | String | Required | 255 | 入库单号 | RV000010-200707-0001 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 入库单详情信息，参见InboundOrderDetails类型 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| receiving_code | String | 入库单号 |
| receiving_shipping_type | Int | 货运方式 0：空运, 1：海运散货, 2：快递, 3：铁运整柜, 4：海运整柜, 5：铁运散货 |
| transit_type | Int | 0:标准入库单 3-中转入库单 5-FBA入库单 |
| sm_code | String | FMS服务方式(物流产品代码) |
| reference_no | String | 客户参考号 |
| value_added_service | Object | 增值服务:world_ease(worldease服务) origin_crt(产地证 ) fumigation(熏蒸 ) |
| receiving_status | Int | 入库单状态
0草稿 1待审核 2审核不通过 3中转仓待签收 4中转仓待收货 5中转仓待配货 6中转仓待发货 7海外仓在途 8海外仓收货中 9海外仓收货完成 10海外仓上架完成 100废弃 |
| weight | Decimal(10,2) |
预报重量(kg)
最多保留2位小数 |
| volume | Decimal(10,2) | 预报体积(立方米)
最多保留2位小数 |
| receiving_desc | String | 备注 |
| create_at | Datetime | 创建日期 |
| update_at | Datetime | 修改日期 |
| warehouse_code | String | 海外目的仓仓库代码 |
| box_total_count | Int | 预报箱数 |
| sku_total_count | Int | 预报sku件数 |
| customs_type | Int | 报关项,0:EDI报关,1:委托报关,2:报关自理 |
| pickup_form | Int | 提单类型,0:电放;1:正本 |
| clearance_service | Int | 是否自有税号清关,0:否,1:是 |
| export_company | Int | 出口商id |
| import_company | Int | 进口商id |
| collecting_service | Int | 揽收服务(送货方式),0:自送货物,1:上门提货 |
| collecting_address | Object[] | 揽收资料,当collection_service为1时必填 |
| transit_warehouse_code | String | 中转仓仓库代码 |
| transit_box_total | Int | 中转仓收货总箱数 |
| tracking_number | String | 跟踪号 |
| eta_date | Datetime | 预计到达时间 |
| transfer_detail | Object[] | 中转入库明细 |
| overseas_detail | Object[] | 海外仓入库明细 |
| gc_putaway_time | Datetime | 上架时间 |
| wp_code | String | 物理仓仓库编码 |
| is_delay | Int | 是否递延,0:否,1:是 |
| is_rollover | Int | 是否仓库装箱商品, 0:否,1:是 |
| booking_cabin_no | String | 订舱单号 |
| tax_rebate_data_url | String | 退税资料url |
| customers_send_info | Object | 客户自送信息对象
- 参见 CustomersSendInfo - 当transit_type=3（中转入库单） 并且 collecting_service=0（自送货物） 时，存在 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ca_first_name | String | 揽收联系人-名 |
| ca_last_name | String | 揽收联系人-姓 |
| ca_contact_phone | String | 揽收联系人电话 |
| ca_state | String | 揽收地址州/省份 |
| ca_city | String | 揽收地址城市 |
| ca_country_code | String | 揽收地址国家 |
| ca_zipcode | String | 揽收地址邮编 |
| ca_address1 | String | 揽收地址1 |
| ca_address2 | String | 揽收地址2 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| box_no | Int | 箱号 |
| product_sku | String | SKU |
| transit_pre_count | Int | 中转预报数量 |
| transit_receiving_count | Int | 中转收货数量 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| box_no | Int | 箱号 |
| reference_box_no | String | 箱唛参考号(适用于自发入库单、FBA入库单) |
| product_sku | String | SKU |
| fba_product_code | String | fba商品编码 |
| overseas_pre_count | Int | 海外仓预报数量 |
| overseas_shelves_count | Int | 海外端上架数量 |
| sn_list | Int | 详见SnListItem类型 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| data_code | String | 序列号集成码 |
| sn_item_list | String[] | 序列号列表 |
| 参数名 | 数据类型 | 可空 | 说明 |
|---|---|---|---|
| arrive_transfer_warehouse_time | Datetime | 否 | 预计到达中转仓时间 |
| company_name | String | 是 | 快递公司名称 |
| delivery_code | String | 是 | 快递单号
注：多个快递单号用英文逗号隔开 |
| plate_no | String | 是 | 车牌号。 |
| driver_name | String | 是 | 司机姓名 |
| driver_phone | String | 是 | 司机电话 |
说明：删除入库单箱唛，实际未发货的箱可以用此接口删除 （只有自发入库单和FBA入库单才可以删除）
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| receiving_code | String | Required | 255 | 入库单号 | RV000010-200715-0001 |
| box_no | String[] | Required | 箱号数组 | ["12","99"] |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 删除成功的箱号 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| receiving_code | String | Required | 255 | 入库单号 | RV000010-200714-0001 |
| made_in_china | Int | Optional | 1 | 是否打印"Made In China" (枚举字段， 默认为4)
2: 打印 4: 不打印 |
4 |
| print_size | Int | Required |
打印尺寸
1：A4 2：100*100 3：100*150 4：100*60 |
4 | |
| print_type | Int | Required | 打印类型(1：入库清单，2：箱唛) | 2 | |
| receiving_box_no_arr | String[] | Optional |
入库单箱号(一次不能超过50个)
print_type=1时，为空 print_type=2时，必填 |
["23","45"] | |
| printing_method | Int | Optional |
打印方式，未填写时默认为1
1：按箱打印 2：按SKU打印 |
1 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 返回的数据 |
| Error | Object | 参考Error格式 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| label_image | String | 返回文件 |
| image_type | Int |
1：png 2：pdf |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| receiving_code | String | Required | 255 | 入库单号 | RV000010-200707-0001 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object[] | 入库单上架批次信息数组，数组元素参见InboundOrderShelfBatchItem类型。/td> |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| receiving_code | String | 入库单号 |
| receiving_status | Int | 入库单状态
0草稿 1待审核 2审核不通过 3中转仓待签收 4中转仓待收货 5中转仓待配货 6中转仓待发货 7海外仓在途 8海外仓收货中 9海外仓收货完成 10海外仓上架完成 100废弃 |
| product_sku | String | 商品编码 |
| quantity | Int | 上架数量 |
| putaway_time | Date | 上架时间 |
| inventory_type | Int | 库存类型
1良品 2不良品 |
| shelf_lift | Int | 是否有效期管理(0.否, 1.是) |
| shelf_lift_day | Int | 有效期天数 |
| shelf_life_list | Object[] | 效期实收明细，参见 shelf_life_list |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| manufacture_date | String | 生产日期, 格式: 2020-01-01 |
| expiration_date | String | 过期日期, 格式: 2020-12-01 |
| rbd_putaway_qty | Int | 上架数量 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| receiving_code | String | Required | 255 | 入库单号 | RV000010-200707-0001 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 入库单收货批次信息，参见ReceiptBatchResp类型 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| transit_type | Int | 入库单类型0:标准入库单 3-中转入库单 5-FBA入库单 |
| transit_data | Object[] | 中转仓收货批次(商品)，参见transit_data类型 |
| transit_box_data | Object[] | 中转仓收货批次(箱子)，参见transit_box_data类型 |
| gc_receiving_data | Object[] | 尾程仓收货批次，参见gc_receiving_data类型 |
| receiving_status | Int | 入库单状态
0草稿 1待审核 2审核不通过 3中转仓待签收 4中转仓待收货 5中转仓待配货 6中转仓待发货 7海外仓在途 8海外仓收货中 9海外仓收货完成 10海外仓上架完成 100废弃 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| receiving_code | String | 入库单号 |
| box_no | String | 入库单箱号 |
| quantity | Int | 预报数量 |
| received_qty | Int | 收货数量 |
| product_sku | String | 商品编码 |
| product_weight | Float | 商品重量，单位KG |
| product_length | Float | 商品长度，单位CM |
| product_width | Float | 商品宽度，单位CM |
| product_height | Float | 商品高度，单位CM |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| receiving_code | String | 入库单号 |
| box_no | String | 入库单箱号 |
| box_weight | Float | 箱子重量，单位KG |
| box_length | Float | 箱子长度，单位CM |
| box_width | Float | 箱子宽度，单位CM |
| box_height | Float | 箱子高度，单位CM |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| receiving_code | String | 入库单号 |
| box_no | String | 入库单箱号 |
| quantity | Int | 预报数量 |
| received_qty | Int | 收货数量 |
| product_sku | String | 商品编码 |
| product_weight | Float | 商品重量，单位KG |
| product_length | Float | 商品长度，单位CM |
| product_width | Float | 商品宽度，单位CM |
| product_height | Float | 商品高度，单位CM |
| product_height | Float | 商品高度，单位CM |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| receiving_code | String | Required | 255 | 入库单号 | RV000010-200707-0001 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 返回的数据 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| transit_type | Int | 入库单类型0:标准入库单 3-中转入库单 5-FBA入库单 |
| transit_data | Object | 中转仓收货批次(商品) |
| transit_box_data | Object | 中转仓收货批次(箱子) |
| gc_receiving_data | Object | 尾程仓收货批次 |
| receiving_status | Int | 入库单状态
0草稿 1待审核 2审核不通过 3中转仓待签收 4中转仓待收货 5中转仓待配货 6中转仓待发货 7海外仓在途 8海外仓收货中 9海外仓收货完成 10海外仓上架完成 100废弃 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| receiving_code | String | 入库单号 |
| box_no | String | 入库单箱号 |
| quantity | Int | 预报数量 |
| received_qty | Int | 收货数量 |
| product_sku | String | 商品编码 |
| product_weight | Float | 商品重量，单位KG |
| product_length | Float | 商品长度，单位CM |
| product_width | Float | 商品宽度，单位CM |
| product_height | Float | 商品高度，单位CM |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| receiving_code | String | 入库单号 |
| box_no | String | 入库单箱号 |
| box_weight | Float | 箱子重量，单位KG |
| box_length | Float | 箱子长度，单位CM |
| box_width | Float | 箱子宽度，单位CM |
| box_height | Float | 箱子高度，单位CM |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| receiving_code | String | 入库单号 |
| box_no | String | 入库单箱号 |
| quantity | Int | 预报数量 |
| received_qty | Int | 收货数量 |
| product_sku | String | 商品编码 |
| product_weight | Float | 商品重量，单位KG |
| product_length | Float | 商品长度，单位CM |
| product_width | Float | 商品宽度，单位CM |
| product_height | Float | 商品高度，单位CM |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| 无 | |||||
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 返回结果 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| car_model_name | String | 车型名称 |
| car_model_code | String | 车型代码 |
说明：入库单上传清关文件(需要上传时才调用这个接口) 英国非欧盟国的入库单上传清关文件说明： 进口商编码：选填； IEN号：必填 报关单C88：报关单C88/税单E2/其他文件三选一必填 税单E2：报关单C88/税单E2/其他文件三选一必填 其他文件：报关单C88/税单E2/其他文件三选一必填 其他入库单上传清关文件说明： 进口商编码：选填，填了覆盖原值； 报关单C88， 税单E2，INCOICE:必填，装箱单,提单：必填
| 名称 | 参数 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|---|
| 入库单号 | receiving_code | String | Required | 255 | 请输入需要上传资料的入库单,否则上传不成功 | RV000010-200707-0001 |
| 进/出口商编码 | cv_id | String | Required | 11 | 通过接口getVatList获取对应的进/出口商编码 | 123 |
| IEN号 | ien_number | String | Optional | 32 | IEN号,目的仓为英国以及非欧盟国必填 | 123 |
| 文件附件 | upload_url | Object[] | Required | 清关附件数据组 |
| 名称 | 参数 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|---|
| 文件类型 | file_type | Int | Required | 文件类型，
-1：报关单C88 1：税单E2 2：INVOICE 3：装箱单 4：提单 6：其他文件 |
||
| 文件地址 | file_url | String | Required | 255 | 必须提供可下载的地址 | |
| 文件后缀名 | type | String | Required | 10 | 支持png,jpeg,pdf,xls,xlsx,docx | png |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
说明：获取清关文件上传状态(配合接口 uploadClearanceDocument使用,当uploadClearanceDocument上传成功,5分钟后再使用此接口判断对应的入库单上传清关文件是否成功)
| 名称 | 参数 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|---|
| 入库单号数组 | receiving_list | String[] | Required | 请输入需要上传资料的入库单,否则上传不成功 | ["RV000010-201010-00001","RV000010-201010-00002"] |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object[] | 清关文件数组，数组元素参见ClearanceDocumentListItem类型 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| receiving_code | String | 入库单号 |
| file_status | Int | 状态:1 未上传 ，2 已上传 |
过期API，请勿调用，请参见 获取物流产品与目的仓中转仓。
说明：获取中转仓库
开发者请务必使用正确的URL，否则请求可能失败。
paramJson 里的内容原则要使用 html 编码，否则内容中有个别特殊的字符时，会产生Bad Request的失败响应。
为了提高当前示范代码的可读性，所以未进行编码，请勿作为生产行为指导。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| 无 | |||||
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | string | 参考response公共参数 |
| message | string | 参考response公共参数 |
| data | Object | 返回结果 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| transit_warehouse_code | string | 中转仓库编号 |
| transit_warehouse_name | string | 中转仓库名称 |
过期API，请勿调用，请参见 获取物流产品与目的仓中转仓。
说明：获取中转服务方式
开发者请务必使用正确的URL，否则请求可能失败。
paramJson 里的内容原则要使用 html 编码，否则内容中有个别特殊的字符时，会产生Bad Request的失败响应。
为了提高当前示范代码的可读性，所以未进行编码，请勿作为生产行为指导。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| 无 | |||||
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | string | 参考response公共参数 |
| message | string | 参考response公共参数 |
| data | Object[] | 中转服务类型复合对象，参见 InboundOrderSmComposite。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| AIR | Object[] | 空运服务方式条目数组，参见 InboundOrderSmItem。 |
| LCL | Object[] | 海运散货服务条目数组，参见 InboundOrderSmItem。 |
| EXPRESS | Object[] | 快递服务条目数组，参见 InboundOrderSmItem。 |
| TRAIN | Object[] | 铁运服务条目数组，参见 InboundOrderSmItem。 |
| FCL | Object[] | 海运整柜服务条目数组，参见 InboundOrderSmItem。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| sm_code | string | 服务方式编号 |
| sm_code_name | string | 服务方式名称 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| inbound_order_code | string | Required | 255 | 入库单号 | RV000010-200714-0003 |
| doc_url | string | Required | 255 | 文件地址（必须提供可下载的地址，http（https）绝对完整路径） | |
| ext | string | Required | 10 | 文件后缀名（支持png,jpeg,jpg,pdf,xlsx,docx） | png |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
说明：在系统中创建订单信息，正常订单的订单号和参考号是唯一的（订单在废弃之后，参考号可以重复使用）
「指定批次」（适用于销毁和自提的订单的一个选项）的订单，不能通过API创建，请在浏览器用手动方式创建。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| reference_no | String | Optional | 50 | 订单参考号(建议使用平台单号) | 2020071601 |
| platform | String | Optional | 20 |
平台，默认OTHER
3DCART ALIBABA ALIEXPRESS ALLEGRO ALLVALUE AMAZON AMERICANAS ASOS BEST BUY BIGCOMMERCE展开>> |
EBAY |
| shipping_method | String | Required | 32 | 物流产品代码，参考getShippingMethod。（当使用物流优选服务时，可选填项，参见vas.logistics_recommendation_option选项）。 当使用物流优选时，该参数必须传null，或者不传，否则报错。 | FEDEX-SMALLPARCEL |
| warehouse_code | String | Required | 32 | 配送仓库代码，参考getWarehouse。（当使用物流优选服务时，可选填项，参见vas.logistics_recommendation_option选项）。 当使用物流优选时，且入参提供了仓库，则系统在该仓库范围内选择适用的物流方式。 | USEA |
| country_code | String | Required | 2 | 收件人国家/地区，参考getCountry | US |
| province | String | Required | 20 | 省 | FL |
| city | String | Required | 32 | 城市 | Miami |
| company | String | Optional | 50 | 公司名称 | 谷仓 |
| address1 | String | Required | 50 | 地址1
关于地址1长度限制50的说明： 市面上绝大部分物流服务商，不支持地址1超过50字符，超过的部分，要拆解到地址2。 地址1、地址2必填一个。 |
One Microsoft Way |
| address2 | String | Optional | 50 | 地址2
地址1、地址2必填一个。 |
创汇国际2 |
| zipcode | String | Required | 20 | 邮编 | 33178 |
| doorplate | String | Optional | 20 | 门牌号 | 35 |
| name | String | Required | 48 | 收件人名 | samuel |
| last_name | String | Optional | 48 | 收件人姓 | fake |
| cell_phone | String | Optional | 8 | 分机号
当platform为AMAZON时，此参数无效。 |
-1 |
| phone | String | Optional | 20 | 收件人联系方式
当platform为AMAZON时，可以由此分解分机号(cell_phone)参数。 |
435028690 |
| String | Optional | 100 | 收件人邮箱 | xx@gmail.com | |
| order_desc | String | Optional | 500 | 订单备注 | xx |
| customer_package_requirement | Int | Optional | 订单包装要求，请注意：未开启订单销售包材服务不支持选择
1：纸箱 2：快递袋 3：气泡袋 4：环保袋 |
1 | |
| verify | Int | Optional | 是否直接审核，默认为0
0：新建不审核(草稿状态) 1：新建并审核审核通过之后，不可编辑 |
1 | |
| is_shipping_method_not_allow_update | Int | Optional | 派送方式是否允许修改
0：可以修改 1：不允许修改（默认值） |
0 | |
| is_signature | Int | Optional | 签名服务
0：不选择签名服务 1：签名服务不填默认为0 |
0 | |
| is_insurance | Int | Optional | 保险服务, 不填默认为0
0：不需要 1：需要 |
0 | |
| insurance_value | Float | Optional | 7 | 保额, 不填为0
最多保留3位小数 |
0 |
| fba_shipment_id | String | Optional | 12 | FBA Shipment ID FBA 类型订单必填 是12位数字+加字母组成 | FBA15D330YGA |
| fba_shipment_id_create_time | String | Optional | datetime | FBA Shipment ID创建时间 FBA 类型订单必填 | 2020-07-17 14:14:14 |
| property_label | String | Optional | 50 | 平台模式
SFP
| SFP |
| business_type | Int | Optional | 配送方式
0:仓配一体 1:仓配分离 该字段受限于是否开通仓配分离服务 | 0 | |
| is_change_label | Int | Optional | FBA换标服务
1：换标 0：不换标(不填，默认为1) | 0 | |
| age_detection | Int | Optional |
若选择的物流产品支持年龄检测服务不填则默认16，该服务只可填16或18。其他物流产品默认为0不检测。 特别说明：如果物流产品支持年龄检测服务，该参数只能传16或18，传0或者不传，将强制改为16。 |
0 | |
| items | Object[] | Required | 订单明细
如果是FBA订单，并且选择仓库装箱商品（is_warehouse_packing = 1），不能填写。
|
||
| LiftGate | Int | Optional | LiftGate服务
0：为否 1：为是 |
0 | |
| payment_time | String | Optional | datetime | 付款时间 格式必须为 YYYY-MM-DD HH:MM:SS，例如 2021-10-01 22:12:01 | 2020-07-17 14:14:14 |
| attachment_ids | Int[] | Optional | 订单附件id数组
参考上传附件接口上传附件，注意use_for要用ORDER_ATTACHMENT，其它类型无法用在当前场景。
|
[12,88] | |
| estimated_arrival_date | String | Optional | datetime | 预计到货日期, 物流产品支持则填写， 格式例如：2021-03-01 | 2020-07-17 |
| estimated_arrival_time | Int | String | Optional | datetime | 到货时间段 兼容数字枚举 或 具体时间段 具体时间段支持“~”和“-”两种时间分隔符（例如：08:00~12:00 或 08:00-12:00） 物流产品支持则可填写，否则输入无效。支持选项有： 108:00~12:00 212:00~14:00 314:00~16:00 416:00~18:00 518:00~20:00 600:00~10:00 700:00~17:00 |
1 |
| sender_info | Object | Optional | 发件人信息，参见SenderInfo。（仓库所在地为日本时适用，否则该参数将被忽略） | ||
| vat_change_info | Object | Optional | 欧盟税改资料，参见VatChangeInfo。（非标准订单时，该参数将被忽略） | ||
| is_euro_label | Int | Optional | 是否贴标。1是，0否 | ||
| vas | Object | Optional | 增值服务选项，参见对象 ValueAddedService。 | ||
| is_warehouse_packing | Int | Optional | 是否仓库装箱商品（FBA订单适用）。
1：是 0：否（默认） is_warehouse_packing = 1时，FBA转仓单信息（carton_info）必填。 |
||
| carton_info | Object | Optional | FBA转仓单信息，参见对象 CartonProductItem。
如果是FBA订单，并且选择仓库装箱商品（is_warehouse_packing = 1），必填。
|
||
| truck_info | Object | Optional | 卡派渠道物流信息，参见对象 TruckInfo。
FBA类型订单 并且 所选物流产品为卡派渠道（is_truck=1）时, 必填。
|
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 | SKU | LZZTEST1212 |
| quantity | Int | Required | 数量 | 1 | |
| transaction_id | String | Optional | 50 | 订单交易号 | 291529280347 |
| item_id | String | Optional | 50 | 订单商品编码 | 291529280347 |
| fba_product_code | String | Optional | 20 | FBA商品编码，当is_change_label=1时必填 | X00170NZI8 |
| euro_terms_code | String | Optional | 合规负责人编码 | ||
| label_replacement_qty | int | Optional | 换标数量FBA订单适用 |
||
| product_declared_value | String | Optional | 8,2 | 申报价值(USD)
取值范围0.01-99999999.99，最多保留2位小数 |
|
| hs_code | String | Optional | 10 | 海关编码，必须为6-10位数字 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| name | String | Optional | 200 | 发件人姓名 |
| phone | String | Optional | 50 | 发件人电话 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| ioss_number | String | Optional | 100 | IOSS号码 | |
| pid_number | String | Optional | 100 | PID号码 | |
| recipient_eori | String | Optional | 100 | 收件人EORI | |
| recipient_vat | String | Optional | 100 | 收件人VAT | |
| shipper_eori | String | Optional | 100 | 发件人EORI | |
| shipper_vat | String | Optional | 100 | 发件人VAT | |
| shipper_company_name | String | Optional | 100 | 发件人公司名称 | |
| recipient_vat_country | String | Optional | 2 | 收件人VAT注册国
参考获取国家/地区列表接口的 country_code 字段
|
GB |
| recipient_eori_country | String | Optional | 2 | 收件人EORI号注册国
参考获取国家/地区列表接口的 country_code 字段
|
US |
| 参数名 | 数据类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| logistics_recommendation_option | Int | Optional | 物流优选时效枚举选项
不使用此服务时传null。 使用物流优选时（该选项不为null），则warehouse_code, shippping_method为选填项，系统将根据优选结果自动选择 仓库与物流方式选项。 1：0-3 个工作日(不包括0) 2：3-6 个工作日(不包括3) 3：6 个工作日(不包括6) 4：时效最快 5：费用最省 |
1 |
| label_replacement_option | Int | Optional |
换标要求
可选项有： 1 - 外箱 2 - 内箱 当换标服务为 1:换标 时，不传默认为 1外箱 当换标服务为 0:不换标 时，该参数必须为null，或者不传。 |
1 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| carton_list | Object[] | Required | 箱唛号列表，参见数组元素 CartonListItem。 | |
| renewal_product_list | Object[] | Optional | 商品信息变更列表，参见数组元素 CartonProductLineItem。 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| carton_no | String | Required | 箱唛号 | |
| fba_box_mark | String | Required | 30 | FBA箱唛号 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| sku | String | Required | 24 | 商品sku |
| product_declared_value | String | Required | 8,2 | 申报价值(USD) 必须在0.01到99999999.99范围内，不能为0，最多保留2位小数； |
| hs_code | String | Required | 10 | 海关编码，必须为6-10位数字 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| reference_id | String | Required | 100 | 参考号，当物流产品为卡派渠道时需要填写，也可更换非卡派渠道物流产品 |
| seller_name | String | Required | 100 | 店铺名称，当物流产品为卡派渠道时需要填写，也可更换非卡派渠道物流产品 |
| fba_warehouse_code | String | Required | 100 | 亚马逊仓库地址四字代码，当物流产品为卡派渠道时需要填写，也可更换非卡派渠道物流产品 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 创建/修改订单结果响应对象，参见 OrderMutationResp。 |
| 参数名 | 数据类型 | 可空 | 说明 |
|---|---|---|---|
| order_code | String | 可空 | 订单号 |
说明：修改订单信息，「草稿状态」的订单信息支持修改，审核之后订单信息将不允许修改。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| order_code | String | Required | 50 | 订单号 | 000010-200716-0006 |
| reference_no | String | Required | 50 | 订单参考号 | 2020071601 |
| platform | String | Optional | 20 |
平台，默认OTHER
3DCART ALIBABA ALIEXPRESS ALLEGRO ALLVALUE AMAZON AMERICANAS ASOS BEST BUY BIGCOMMERCE展开>> |
EBAY |
| shipping_method | String | Required | 32 | 配送方式，参考getShippingMethod。（当使用物流优选服务时，可选填项，参见vas.logistics_recommendation_option选项）。 当使用物流优选时，该参数必须传null，或者不传，否则报错。 | FEDEX-SMALLPARCEL |
| warehouse_code | String | Required | 32 | 配送仓库，参考getWarehouse。（当使用物流优选服务时，可选填项，参见vas.logistics_recommendation_option选项）。 当使用物流优选时，且入参提供了仓库，则系统在该仓库范围内选择适用的物流方式。 | USEA |
| country_code | String | Required | 2 | 收件人国家/地区，参考getCountry | US |
| province | String | Required | 20 | 省 | FL |
| city | String | Required | 32 | 城市 | Miami |
| address1 | String | Required | 50 | 地址1
关于地址1长度限制50的说明： 市面上绝大部分物流服务商，不支持地址1超过50字符，超过的部分，要拆解到地址2。 地址1、地址2必填一个。 |
One Microsoft Way |
| address2 | String | Optional | 50 | 地址2
地址1、地址2必填一个。 |
创汇国际2 |
| zipcode | String | Required | 20 | 邮编 | 33178 |
| doorplate | String | Optional | 20 | 门牌号 | 35 |
| name | String | Required | 48 | 收件人名 | samuel |
| last_name | String | Optional | 48 | 收件人姓 | fake |
| cell_phone | String | Optional | 8 | 分机号 | 430 |
| phone | String | Optional | 20 | 收件人联系方式 | 435028690 |
| String | Optional | 100 | 收件人邮箱 | xx@gmail.com | |
| order_desc | String | Optional | 500 | 订单备注 | xx |
| customer_package_requirement | Int | Optional | 订单包装要求，请注意：未开启订单销售包材服务不支持选择
1：纸箱 2：快递袋 3：气泡袋 4：环保袋 |
1 | |
| verify | Int | Optional | 是否直接审核，默认为0
0：新建不审核(草稿状态) 1：新建并审核审核通过之后，不可编辑 |
1 | |
| is_shipping_method_not_allow_update | Int | Optional | 派送方式是否允许修改
0：可以修改 1：不允许修改（默认值） |
0 | |
| is_signature | Int | Optional | 签名服务
0：不选择签名服务 1：签名服务不填默认为0 |
0 | |
| is_insurance | Int | Optional | 保险服务, 不填默认为0
0：不需要 1：需要 |
0 | |
| insurance_value | Float | Optional | 7 | 保额, 不填为0
最多保留3位小数 |
0 |
| fba_shipment_id | String | Optional | 12 | FBA Shipment ID FBA 类型订单必填 是12位数字+加字母组成 | FBA15D330YGA |
| fba_shipment_id_create_time | String | Optional | datetime | FBA Shipment ID创建时间 FBA 类型订单必填 | 2020-07-17 14:14:14 |
| property_label | String | Optional | 50 | 平台模式
SFP
| SFP |
| business_type | Int | Optional | 配送方式
0:仓配一体 1:仓配分离 该字段受限于是否开通仓配分离服务 | 0 | |
| is_change_label | Int | Optional | FBA换标服务
1：换标 0：不换标(不填，默认为1) | 0 | |
| age_detection | Int | Optional |
若选择的物流产品支持年龄检测服务不填则默认16，该服务只可填16或18。其他物流产品默认为0不检测。 特别说明：如果物流产品支持年龄检测服务，该参数只能传16或18，传0或者不传，将强制改为16。 |
0 | |
| LiftGate | Int | Optional | LiftGate服务
0：为否 1：为是 |
0 | |
| attachment_ids | Int[] | Optional | 订单附件id数组
参考上传附件接口上传附件，注意use_for要用ORDER_ATTACHMENT，其它类型无法用在当前场景。
|
[12,88] | |
| items | Object | Required | 订单明细
如果是FBA订单，并且选择仓库装箱商品（is_warehouse_packing = 1），不能填写。
|
||
| estimated_arrival_date | String | Optional | datetime | 预计到货日期, 物流产品支持则填写， 格式例如：2021-03-01 | 2020-07-17 |
| estimated_arrival_time | Int | String | Optional | datetime | 到货时间段 兼容数字枚举 或 具体时间段 具体时间段支持“~”和“-”两种时间分隔符（例如：08:00~12:00 或 08:00-12:00） 物流产品支持则可填写，否则输入无效。支持选项有： 108:00~12:00 212:00~14:00 314:00~16:00 416:00~18:00 518:00~20:00 600:00~10:00 700:00~17:00 |
1 |
| sender_info | Object | Optional | 发件人信息，参见SenderInfo。（仓库所在地为日本时适用，否则该参数将被忽略） | ||
| vat_change_info | Object | Optional | 欧盟税改资料，参见VatChangeInfo。（非标准订单时，该参数将被忽略） | ||
| is_euro_label | Int | Optional | 是否贴标。1是，0否 | ||
| vas | Object | Optional | 增值服务选项，参见对象 ValueAddedService。 | ||
| is_warehouse_packing | Int | Optional | 是否仓库装箱商品（FBA订单适用）。
1：是 0：否（默认） 不支持修改该选项，需与创建时的字段值一致。 is_warehouse_packing = 1时，FBA转仓单信息（carton_info）必填。 |
||
| carton_info | Object | Optional | FBA转仓单信息，参见对象 CartonProductItem。
如果是FBA订单，并且选择仓库装箱商品（is_warehouse_packing = 1），必填。
|
||
| truck_info | Object | Optional | 卡派渠道物流信息，参见对象 TruckInfo。
FBA类型订单 并且 所选物流产品为卡派渠道（is_truck=1）时, 必填。
|
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 | SKU | LZZTEST1212 |
| quantity | Int | Required | 数量 | 1 | |
| transaction_id | String | Optional | 50 | 订单交易号 | 291529280347 |
| item_id | String | Optional | 50 | 订单商品编码 | 291529280347 |
| fba_product_code | String | Optional | 20 | FBA商品编码，当is_change_label=1时必填 | X00170NZI8 |
| euro_terms_code | String | Optional | 合规负责人编码 | ||
| label_replacement_qty | int | Optional | 换标数量FBA订单适用 |
||
| product_declared_value | String | Optional | 8,2 | 申报价值(USD)
取值范围0.01-99999999.99，最多保留2位小数 |
|
| hs_code | String | Optional | 10 | 海关编码，必须为6-10位数字 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| name | String | Optional | 200 | 发件人姓名 |
| phone | String | Optional | 50 | 发件人电话 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| ioss_number | String | Optional | 100 | IOSS号码 | |
| pid_number | String | Optional | 100 | PID号码 | |
| recipient_eori | String | Optional | 100 | 收件人EORI | |
| recipient_vat | String | Optional | 100 | 收件人VAT | |
| shipper_eori | String | Optional | 100 | 发件人EORI | |
| shipper_vat | String | Optional | 100 | 发件人VAT | |
| shipper_company_name | String | Optional | 100 | 发件人公司名称 | |
| recipient_vat_country | String | Optional | 2 | 收件人VAT注册国
参考获取国家/地区列表接口的 country_code 字段
|
GB |
| recipient_eori_country | String | Optional | 2 | 收件人EORI号注册国
参考获取国家/地区列表接口的 country_code 字段
|
US |
| 参数名 | 数据类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| logistics_recommendation_option | Int | Optional | 物流优选时效枚举选项
不使用此服务时传null。 使用物流优选时（该选项不为null），则warehouse_code, shippping_method为选填项，系统将根据优选结果自动选择 仓库与物流方式选项。 1：0-3 个工作日(不包括0) 2：3-6 个工作日(不包括3) 3：6 个工作日(不包括6) 4：时效最快 5：费用最省 |
1 |
| label_replacement_option | Int | Optional |
换标要求
可选项有： 1 - 外箱 2 - 内箱 当换标服务为 1:换标 时，不传默认为 1外箱 当换标服务为 0:不换标 时，该参数必须为null，或者不传。 |
1 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| carton_list | Object[] | Required | 箱唛号列表，参见数组元素 CartonListItem。 | |
| renewal_product_list | Object[] | Optional | 商品信息变更列表，参见数组元素 CartonProductLineItem。 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| carton_no | String | Required | 箱唛号 | |
| fba_box_mark | String | Required | 30 | FBA箱唛号 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| sku | String | Required | 24 | 商品sku |
| product_declared_value | String | Required | 8,2 | 申报价值(USD) 必须在0.01到99999999.99范围内，不能为0，最多保留2位小数； |
| hs_code | String | Required | 10 | 海关编码，必须为6-10位数字 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| reference_id | String | Required | 100 | 参考号，当物流产品为卡派渠道时需要填写，也可更换非卡派渠道物流产品 |
| seller_name | String | Required | 100 | 店铺名称，当物流产品为卡派渠道时需要填写，也可更换非卡派渠道物流产品 |
| fba_warehouse_code | String | Required | 100 | 亚马逊仓库地址四字代码，当物流产品为卡派渠道时需要填写，也可更换非卡派渠道物流产品 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 创建/修改订单结果响应对象，参见 OrderMutationResp。 |
| 参数名 | 数据类型 | 可空 | 说明 |
|---|---|---|---|
| order_code | String | 可空 | 订单号 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| order_code | String | Required | 50 | 订单号 | 000010-200716-0006 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 订单数据，参见OrderItemComposite。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| order_code | String | 订单号 |
| reference_no | String | 客户参考号 |
| platform | String | 平台 |
| order_status | String | 订单状态
C:待发货审核 W:待发货 D:已发货 H:暂存 N:异常订单 P:问题件 X:废弃 |
| abnormal_problem_reason | String | 异常问题原因 |
| shipping_method | String | 配送方式 |
| tracking_no | String | 跟踪号 |
| warehouse_code | String | 配送仓库代码 |
| wp_code | String | 物理仓代码 |
| order_weight | Float | 订单重量 |
| order_desc | String | 订单说明 |
| date_create | Datetime | 创建时间 |
| date_release | Datetime | 审核时间 |
| date_shipping | Datetime | 出库时间 |
| date_modify | Datetime | 修改时间 |
| fba_shipment_id | String | FBA Shipment ID FBA 类型订单必填 |
| fba_shipment_id_create_time | String | FBA Shipment ID创建时间 FBA 类型订单必填 |
| 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 |
| consignee_address3 | String | 地址3 |
| consigne_zipcode | String | 邮编 |
| consignee_doorplate | String | 门牌号 |
| consignee_company | String | 公司 |
| consignee_name | String | 收件人名 |
| consignee_last_name | String | 收件人姓 |
| consignee_phone | String | 收件人电话 |
| consignee_email | String | 收件人邮箱 |
| age_detection | String |
年龄检测服务 0 - 否 16 - 对应16岁 18 - 对应18岁 |
| LiftGate | Int | LiftGate服务 0为否 1为是 |
| items | Object[] | 订单明细对象数组，元素结构参数 OrderLineItem。 |
| fee_details | Object | 订单费用对象，参见OrderFeeComposite。 |
| orderBoxInfo | Object[] | 一票多箱装箱明细（适用于一票多箱，或者FBA订单），数组元素参见OrderCartonItem。 |
| sn_info_list | Object[] | 订单SKU序列号列表，数组元素参见OrderSkuSnItem。 |
| estimated_arrival_date | String | 预计到货日期 |
| estimated_arrival_time | String | 到货时间段 |
| payment_time | String | 付款时间 |
| sender_info | Object | 发件人信息，参见SenderInfo。（仓库所在地为日本时适用，否则该参数忽略） |
| vat_change_info | Object | 欧盟税改资料，参见VatChangeInfo。（非标准订单时，该参数将被忽略） |
| is_euro_label | Int | 商品是否贴标。1是，0否 |
| vas | Object | 增值服务选项，参见对象 ValueAddedService。 |
| is_warehouse_packing | Int | 是否仓库装箱商品。1是，0否 |
| truck_info | Object | 卡派渠道物流信息，参见对象 TruckInfo。
(FBA订单适用) 物流产品为卡派渠道时有值。
|
| property_label | String | 平台模式：SFP |
| customer_package_requirement | Int | 订单包装要求
1：纸箱 2：快递袋 3：气泡袋 4：环保袋 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| product_sku | String | SKU |
| quantity | Int | 数量 |
| transaction_id | String | ebay订单交易号 |
| fba_product_code | String | fba商品编码 |
| item_id | String | ebay订单商品编码 |
| euro_terms_code | String | 合规负责人编码 |
| euro_terms_company | String | 合规负责人公司名称 |
| label_replacement_qty | int | 换标数量FBA订单适用 |
| product_declared_value | Float | 申报价值（价值币种同仓库币种） |
| hs_code | String | 海关编码 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| totalFee | Float | 总费用 |
| SHIPPING | Float | 运输费 |
| OPF | Float | 操作费用 |
| FSC | Float | 燃油附加费 |
| DT | Float | 关税 |
| RSF | Float | 挂号 |
| OTF | Float | 其它费用 |
| currency_code | String | 币种 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| box_no | String | 箱号 |
| box_mark | String | 箱唛号 |
| fba_box_mark | String | FBA箱唛号 |
| ob_length | Float | 长，单位CM |
| ob_width | Float | 宽，单位CM |
| ob_height | Float | 高，单位CM |
| ob_weight | Float | 重量，单位KG |
| ob_add_time | String | 创建时间 |
| tracking_number | String | 跟踪号 |
| product_barcode | String | 产品编码 |
| order_code | String | 订单号 |
| ob_qty | Int | 数量 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| name | String | Optional | 200 | 发件人姓名 |
| phone | String | Optional | 50 | 发件人电话 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| ioss_number | String | Optional | 100 | IOSS号码 | |
| pid_number | String | Optional | 100 | PID号码 | |
| recipient_eori | String | Optional | 100 | 收件人EORI | |
| recipient_vat | String | Optional | 100 | 收件人VAT | |
| shipper_eori | String | Optional | 100 | 发件人EORI | |
| shipper_vat | String | Optional | 100 | 发件人VAT | |
| shipper_company_name | String | Optional | 100 | 发件人公司名称 | |
| recipient_vat_country | String | Optional | 2 | 收件人VAT注册国
参考获取国家/地区列表接口的 country_code 字段
|
GB |
| recipient_eori_country | String | Optional | 2 | 收件人EORI号注册国
参考获取国家/地区列表接口的 country_code 字段
|
US |
| 参数名 | 数据类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| logistics_recommendation_option | Int | Optional | 物流优选时效枚举选项
不使用此服务时传null。 使用物流优选时（该选项不为null），则warehouse_code, shippping_method为选填项，系统将根据优选结果自动选择 仓库与物流方式选项。 1：0-3 个工作日(不包括0) 2：3-6 个工作日(不包括3) 3：6 个工作日(不包括6) 4：时效最快 5：费用最省 |
1 |
| label_replacement_option | Int | Optional |
换标要求
可选项有： 1 - 外箱 2 - 内箱 当换标服务为 1:换标 时，不传默认为 1外箱 当换标服务为 0:不换标 时，该参数必须为null，或者不传。 |
1 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| product_sku | String | 商品SKU。 |
| serial_number | String | 序列号。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| reference_id | String | 参考号 |
| seller_name | String | 店铺名称 |
| fba_warehouse_code | String | FBA仓库代码 |
说明：根据参考号获取订单（只返回有效订单状态）。有效订单状态包括：草稿/暂存/待发货/已发货/异常/问题件
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| reference_no | String | Required | 50 | 参考号 !!注意!! 只支持有效订单状态，有效订单状态包括：草稿/暂存/待发货/已发货/异常/问题件 |
2020071601 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 订单数据，参见OrderItemComposite。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| order_code | String | 订单号 |
| reference_no | String | 客户参考号 |
| platform | String | 平台 |
| order_status | String | 订单状态
C:待发货审核 W:待发货 D:已发货 H:暂存 N:异常订单 P:问题件 X:废弃 |
| abnormal_problem_reason | String | 异常问题原因 |
| shipping_method | String | 配送方式 |
| tracking_no | String | 跟踪号 |
| warehouse_code | String | 配送仓库代码 |
| wp_code | String | 物理仓代码 |
| order_weight | Float | 订单重量 |
| order_desc | String | 订单说明 |
| date_create | Datetime | 创建时间 |
| date_release | Datetime | 审核时间 |
| date_shipping | Datetime | 出库时间 |
| date_modify | Datetime | 修改时间 |
| fba_shipment_id | String | FBA Shipment ID FBA 类型订单必填 |
| fba_shipment_id_create_time | String | FBA Shipment ID创建时间 FBA 类型订单必填 |
| 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 |
| consignee_address3 | String | 地址3 |
| consigne_zipcode | String | 邮编 |
| consignee_doorplate | String | 门牌号 |
| consignee_company | String | 公司 |
| consignee_name | String | 收件人名 |
| consignee_last_name | String | 收件人姓 |
| consignee_phone | String | 收件人电话 |
| consignee_email | String | 收件人邮箱 |
| age_detection | String |
年龄检测服务 0 - 否 16 - 对应16岁 18 - 对应18岁 |
| LiftGate | Int | LiftGate服务 0为否 1为是 |
| items | Object[] | 订单明细对象数组，元素结构参数 OrderLineItem。 |
| fee_details | Object | 订单费用对象，参见OrderFeeComposite。 |
| orderBoxInfo | Object[] | 一票多箱装箱明细（适用于一票多箱，或者FBA订单），数组元素参见OrderCartonItem。 |
| sn_info_list | Object[] | 订单SKU序列号列表，数组元素参见OrderSkuSnItem。 |
| estimated_arrival_date | String | 预计到货日期 |
| estimated_arrival_time | String | 到货时间段 |
| payment_time | String | 付款时间 |
| sender_info | Object | 发件人信息，参见SenderInfo。（仓库所在地为日本时适用，否则该参数忽略） |
| vat_change_info | Object | 欧盟税改资料，参见VatChangeInfo。（非标准订单时，该参数将被忽略） |
| is_euro_label | Int | 商品是否贴标。1是，0否 |
| vas | Object | 增值服务选项，参见对象 ValueAddedService。 |
| is_warehouse_packing | Int | 是否仓库装箱商品。1是，0否 |
| truck_info | Object | 卡派渠道物流信息，参见对象 TruckInfo。
(FBA订单适用) 物流产品为卡派渠道时有值。
|
| property_label | String | 平台模式：SFP |
| customer_package_requirement | Int | 订单包装要求
1：纸箱 2：快递袋 3：气泡袋 4：环保袋 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| product_sku | String | SKU |
| quantity | Int | 数量 |
| transaction_id | String | ebay订单交易号 |
| fba_product_code | String | fba商品编码 |
| item_id | String | ebay订单商品编码 |
| euro_terms_code | String | 合规负责人编码 |
| euro_terms_company | String | 合规负责人公司名称 |
| label_replacement_qty | int | 换标数量FBA订单适用 |
| product_declared_value | Float | 申报价值（价值币种同仓库币种） |
| hs_code | String | 海关编码 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| totalFee | Float | 总费用 |
| SHIPPING | Float | 运输费 |
| OPF | Float | 操作费用 |
| FSC | Float | 燃油附加费 |
| DT | Float | 关税 |
| RSF | Float | 挂号 |
| OTF | Float | 其它费用 |
| currency_code | String | 币种 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| box_no | String | 箱号 |
| box_mark | String | 箱唛号 |
| fba_box_mark | String | FBA箱唛号 |
| ob_length | Float | 长，单位CM |
| ob_width | Float | 宽，单位CM |
| ob_height | Float | 高，单位CM |
| ob_weight | Float | 重量，单位KG |
| ob_add_time | String | 创建时间 |
| tracking_number | String | 跟踪号 |
| product_barcode | String | 产品编码 |
| order_code | String | 订单号 |
| ob_qty | Int | 数量 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| name | String | Optional | 200 | 发件人姓名 |
| phone | String | Optional | 50 | 发件人电话 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| ioss_number | String | Optional | 100 | IOSS号码 | |
| pid_number | String | Optional | 100 | PID号码 | |
| recipient_eori | String | Optional | 100 | 收件人EORI | |
| recipient_vat | String | Optional | 100 | 收件人VAT | |
| shipper_eori | String | Optional | 100 | 发件人EORI | |
| shipper_vat | String | Optional | 100 | 发件人VAT | |
| shipper_company_name | String | Optional | 100 | 发件人公司名称 | |
| recipient_vat_country | String | Optional | 2 | 收件人VAT注册国
参考获取国家/地区列表接口的 country_code 字段
|
GB |
| recipient_eori_country | String | Optional | 2 | 收件人EORI号注册国
参考获取国家/地区列表接口的 country_code 字段
|
US |
| 参数名 | 数据类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| logistics_recommendation_option | Int | Optional | 物流优选时效枚举选项
不使用此服务时传null。 使用物流优选时（该选项不为null），则warehouse_code, shippping_method为选填项，系统将根据优选结果自动选择 仓库与物流方式选项。 1：0-3 个工作日(不包括0) 2：3-6 个工作日(不包括3) 3：6 个工作日(不包括6) 4：时效最快 5：费用最省 |
1 |
| label_replacement_option | Int | Optional |
换标要求
可选项有： 1 - 外箱 2 - 内箱 当换标服务为 1:换标 时，不传默认为 1外箱 当换标服务为 0:不换标 时，该参数必须为null，或者不传。 |
1 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| product_sku | String | 商品SKU。 |
| serial_number | String | 序列号。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| reference_id | String | 参考号 |
| seller_name | String | 店铺名称 |
| fba_warehouse_code | String | FBA仓库代码 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| pageSize | Int | Required | 每页数据长度，最大值100 | 10 | |
| page | Int | Required | 当前页 | 1 | |
| order_code | String | Optional | 50 | 订单号 | 000010-200716-0006 |
| order_code_arr | String[] | Optional | 订单号字符串数组 | ["00001606170001","00001606170002"] | |
| shipping_method | String | Optional | 32 | 物流产品代码 | FEDEX-SMALLPARCEL |
| create_date_from | Datetime | Optional | datetime | 订单创建开始时间， 格式YYYY-MM-DD HH:II:SS 订单号传值时，该参数无效 | 2020-07-20 01:00:00 |
| create_date_to | Datetime | Optional | datetime | 订单创建结束时间， 格式YYYY-MM-DD HH:II:SS 订单号传值时，该参数无效 | 2020-07-20 01:00:00 |
| modify_date_from | Datetime | Optional | datetime | 订单修改开始时间， 格式YYYY-MM-DD HH:II:SS 订单号传值时，该参数无效 | 2020-07-20 01:00:00 |
| modify_date_to | Datetime | Optional | datetime | 订单修改结束时间， 格式YYYY-MM-DD HH:II:SS 订单号传值时，该参数无效 | 2020-07-20 01:00:00 |
| date_shipping_from | Datetime | Optional | datetime | 订单出库开始时间， 格式YYYY-MM-DD HH:II:SS 订单号传值时，该参数无效 | 2020-07-20 01:00:00 |
| date_shipping_to | Datetime | Optional | datetime | 订单出库结束时间， 格式YYYY-MM-DD HH:II:SS 订单号传值时，该参数无效 | 2020-07-20 01:00:00 |
| order_status | String | Optional | 1 | 订单状态
W:待发货 D:已发货 N:异常订单 P:问题件 X:废弃 |
D |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| count | Int | 总数量 |
| data | Object[] | 订单数据对象数组，数组元素结构参见OrderItemComposite。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| order_code | String | 订单号 |
| reference_no | String | 客户参考号 |
| platform | String | 平台 |
| order_status | String | 订单状态
W:待发货 D:已发货 N:异常订单 P:问题件 X:废弃 |
| abnormal_problem_reason | String | 异常问题原因 |
| shipping_method | String | 配送方式 |
| tracking_no | String | 跟踪号 |
| warehouse_code | String | 配送仓库代码 |
| wp_code | String | 物理仓代码 |
| order_weight | Float | 订单重量 |
| order_desc | String | 订单说明 |
| date_create | Datetime | 创建时间 |
| payment_time | Datetime | 付款时间 |
| date_release | Datetime | 审核时间 |
| date_shipping | Datetime | 出库时间 |
| date_modify | Datetime | 修改时间 |
| fba_shipment_id | String | FBA Shipment ID FBA 类型订单必填 |
| fba_shipment_id_create_time | String | FBA Shipment ID创建时间 FBA 类型订单必填 |
| 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 |
| consignee_address3 | String | 地址3 |
| consignee_zipcode | String | 邮编 |
| consignee_doorplate | String | 门牌号 |
| consignee_company | String | 公司 |
| consignee_name | String | 收件人名 |
| consignee_last_name | String | 收件人姓 |
| consignee_phone | String | 收件人电话 |
| consignee_email | String | 收件人邮箱 |
| age_detection | Int |
年龄检测服务 0 - 否 16 - 对应16岁 18 - 对应18岁 |
| items | Object[] | 订单明细对象数组，元素结构参数 OrderLineItem。 |
| fee_details | Object | 订单费用对象，参见OrderFeeComposite。 |
| orderBoxInfo | Object[] | 一票多箱装箱明细（适用于一票多箱，或者FBA订单），数组元素参见OrderCartonItem。 |
| LiftGate | Int | LiftGate服务 0为否 1为是 |
| estimated_arrival_date | String | 预计到货日期 |
| estimated_arrival_time | String | 到货时间段 |
| sender_info | Object | 发件人信息，参见SenderInfo。（仓库所在地为日本时适用，否则该参数忽略） |
| vat_change_info | Object | 欧盟税改资料，参见VatChangeInfo。（非标准订单时，该参数将被忽略） |
| vas | Object | 增值服务选项，参见对象 ValueAddedService。 |
| currency_code | string | 仓库币种 |
| is_warehouse_packing | Int | 是否仓库装箱商品。1是，0否 |
| truck_info | Object | 卡派渠道物流信息，参见对象 TruckInfo。
(FBA订单适用) 物流产品为卡派渠道时有值。
|
| property_label | String | 平台模式
SFP
|
| customer_package_requirement | Int | 订单包装要求
1：纸箱 2：快递袋 3：气泡袋 4：环保袋 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| product_sku | String | SKU |
| fba_product_code | String | FBA商品编码 |
| quantity | Int | 数量 |
| transaction_id | String | ebay订单交易号 |
| item_id | String | ebay订单商品编码 |
| label_replacement_qty | int | 换标数量FBA订单适用 |
| product_declared_value | Float | 申报价值（价值币种同仓库币种） |
| hs_code | String | 海关编码 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| totalFee | Float | 总费用 |
| SHIPPING | Float | 运输费 |
| OPF | Float | 操作费用 |
| FSC | Float | 燃油附加费 |
| DT | Float | 关税 |
| RSF | Float | 挂号 |
| OTF | Float | 其它费用 |
| currency_code | String | 币种 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| box_no | String | 箱号 |
| box_mark | String | 箱唛号 |
| fba_box_mark | String | FBA箱唛号 |
| ob_length | Float | 长，单位CM |
| ob_width | Float | 宽，单位CM |
| ob_height | Float | 高，单位CM |
| ob_weight | Float | 重量，单位KG |
| ob_add_time | String | 创建时间 |
| tracking_number | String | 跟踪号 |
| product_barcode | String | 产品编码 |
| order_code | String | 订单号 |
| ob_qty | Int | 数量 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| name | String | 发件人姓名 |
| phone | String | 发件人电话 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ioss_number | String | IOSS号码 |
| pid_number | String | PID号码 |
| recipient_eori | String | 收件人EORI |
| recipient_vat | String | 收件人VAT |
| shipper_eori | String | 发件人EORI |
| shipper_vat | String | 发件人VAT |
| shipper_company_name | String | 发件人公司名称 |
| recipient_vat_country | String | 收件人VAT注册国 |
| recipient_eori_country | String | 收件人EORI号注册国 |
| 参数名 | 数据类型 | 说明 | 示例 |
|---|---|---|---|
| logistics_recommendation_option | Int | 物流优选时效枚举选项（不使用此服务时传null）。 |
1 |
| 使用物流优选时（该选项不为null），则warehouse_code, shippping_method为选填项，系统将根据优选结果自动选择 仓库与物流方式选项。 | |||
| 1：0-3 个工作日(不包括0) | |||
| 2：3-6 个工作日(不包括3) | |||
| 3：6 个工作日(不包括6) |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| reference_id | String | 参考号 |
| seller_name | String | 店铺名称 |
| fba_warehouse_code | String | FBA仓库代码 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| pageSize | Int | Required | 每页数据长度，最大值100 | 10 | |
| page | Int | Required | 当前页 | 1 | |
| order_code | String | Optional | 50 | 订单号 | 000010-200716-0006 |
| order_code_arr | String[] | Optional | 多个订单号,数组格式 | ["00001606170001","00001606170002"] | |
| shipping_method | String | Optional | 32 | 物流产品代码 | FEDEX-SMALLPARCEL |
| create_date_from | Datetime | Optional | datetime | 订单创建开始时间， 格式YYYY-MM-DD HH:II:SS 订单号传值时，该参数无效 | 2020-07-20 01:00:00 |
| create_date_to | Datetime | Optional | datetime | 订单创建结束时间， 格式YYYY-MM-DD HH:II:SS 订单号传值时，该参数无效 | 2020-07-20 01:00:00 |
| modify_date_from | Datetime | Optional | datetime | 订单修改开始时间， 格式YYYY-MM-DD HH:II:SS 订单号传值时，该参数无效 | 2020-07-20 01:00:00 |
| modify_date_to | Datetime | Optional | datetime | 订单修改结束时间， 格式YYYY-MM-DD HH:II:SS 订单号传值时，该参数无效 | 2020-07-20 01:00:00 |
| order_status | String | Required | 1 | 订单状态
C:待发货审核 H:暂存 |
C |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| count | Int | 总数量 |
| data | Object | 数据内容 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| order_code | String | 订单号 |
| reference_no | String | 客户参考号 |
| platform | String | 平台 |
| order_status | String | 订单状态
C:待发货审核 H:暂存 |
| abnormal_problem_reason | String | 异常问题原因 |
| shipping_method | String | 配送方式 |
| tracking_no | String | 跟踪号 |
| warehouse_code | String | 配送仓库代码 |
| order_weight | float | 订单重量 |
| order_desc | String | 订单说明 |
| date_create | Datetime | 创建时间 |
| payment_time | Datetime | 付款时间 |
| date_release | Datetime | 审核时间 |
| date_shipping | Datetime | 出库时间 |
| date_modify | Datetime | 修改时间 |
| fba_shipment_id | String | FBA Shipment ID FBA 类型订单必填 |
| fba_shipment_id_create_time | String | FBA Shipment ID创建时间 FBA 类型订单必填 |
| 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 |
| consignee_address3 | String | 地址3 |
| consignee_zipcode | String | 邮编 |
| consignee_doorplate | String | 门牌号 |
| consignee_company | String | 公司 |
| consignee_name | String | 收件人名 |
| consignee_last_name | String | 收件人姓 |
| consignee_phone | String | 收件人电话 |
| consignee_email | String | 收件人邮箱 |
| age_detection | String |
年龄检测服务 0 - 否 16 - 对应16岁 18 - 对应18岁 |
| items | Object[] | 订单明细 |
| fee_details | Object | 订单费用 |
| orderBoxInfo | Object | 一票多箱装箱明细，一票一箱则返回空 |
| LiftGate | Int | LiftGate服务 0为否 1为是 |
| sender_info | Object | 发件人信息，参见SenderInfo。（仓库所在地为日本时适用，否则该参数忽略） |
| vat_change_info | Object | 欧盟税改资料，参见VatChangeInfo。（非标准订单时，该参数将被忽略） |
| vas | Object | 增值服务选项，参见对象 ValueAddedService。 |
| is_warehouse_packing | Int | 是否仓库装箱商品。1是，0否 |
| truck_info | Object | 卡派渠道物流信息，参见对象 TruckInfo。
(FBA订单适用) 物流产品为卡派渠道时有值。
|
| property_label | String | 平台模式
SFP
|
| customer_package_requirement | Int | 订单包装要求
1：纸箱 2：快递袋 3：气泡袋 4：环保袋 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| product_sku | String | SKU |
| fba_product_code | String | FBA商品编码 |
| quantity | Int | 数量 |
| transaction_id | String | ebay订单交易号 |
| item_id | String | ebay订单商品编码 |
| label_replacement_qty | int | 换标数量FBA订单适用 |
| product_declared_value | Float | 申报价值(USD) |
| hs_code | String | 海关编码 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| totalFee | Float | 总费用 |
| SHIPPING | Float | 运输费 |
| OPF | Float | 操作费用 |
| FSC | Float | 燃油附加费 |
| DT | Float | 关税 |
| RSF | Float | 挂号 |
| OTF | Float | 其它费用 |
| currency_code | String | 币种 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| box_no | String | 箱号 |
| ob_length | Float | 长，单位CM |
| ob_width | Float | 宽，单位CM |
| ob_height | Float | 高，单位CM |
| ob_weight | Float | 重量，单位KG |
| ob_add_time | String | 创建时间 |
| tracking_number | String | 跟踪号 |
| product_barcode | String | 产品编码 |
| order_code | String | 订单号 |
| ob_qty | Int | 数量 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| name | String | Optional | 200 | 发件人姓名 |
| phone | String | Optional | 50 | 发件人电话 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| ioss_number | String | Optional | 100 | IOSS号码 | |
| pid_number | String | Optional | 100 | PID号码 | |
| recipient_eori | String | Optional | 100 | 收件人EORI | |
| recipient_vat | String | Optional | 100 | 收件人VAT | |
| shipper_eori | String | Optional | 100 | 发件人EORI | |
| shipper_vat | String | Optional | 100 | 发件人VAT | |
| shipper_company_name | String | Optional | 100 | 发件人公司名称 | |
| recipient_vat_country | String | Optional | 2 | 收件人VAT注册国
参考获取国家/地区列表接口的 country_code 字段
|
GB |
| recipient_eori_country | String | Optional | 2 | 收件人EORI号注册国
参考获取国家/地区列表接口的 country_code 字段
|
US |
| 参数名 | 数据类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| logistics_recommendation_option | Int | Optional | 物流优选时效枚举选项
不使用此服务时传null。 使用物流优选时（该选项不为null），则warehouse_code, shippping_method为选填项，系统将根据优选结果自动选择 仓库与物流方式选项。 1：0-3 个工作日(不包括0) 2：3-6 个工作日(不包括3) 3：6 个工作日(不包括6) 4：时效最快 5：费用最省 |
1 |
| label_replacement_option | Int | Optional |
换标要求
可选项有： 1 - 外箱 2 - 内箱 当换标服务为 1:换标 时，不传默认为 1外箱 当换标服务为 0:不换标 时，该参数必须为null，或者不传。 |
1 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| reference_id | String | 参考号 |
| seller_name | String | 店铺名称 |
| fba_warehouse_code | String | FBA仓库代码 |
说明：取消订单，待审核和仓库没有下架的订单支持取消，仓库端已经下架的订单客户不允许取消
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| order_code | String | Required | 50 | 订单号 | 000011-160617-0001 |
| reason | String | Optional | 255 | 截单原因 | 客户取消订单 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| order_code | String | 订单号 |
| cancel_status | Int |
订单拦截状态
2：拦截成功 3：拦截失败 |
此API受用户所开通的服务权限约束，如果未开通「仓配分离」的业务，调用此API将被拒绝。
| 参数名 | 数据类型 | 是否必填 | 说明 |
|---|---|---|---|
| order_code | String | Required | 订单号 |
| tracking_number | String | Required | 跟踪号 |
| package_area_code | String | Optional | 分拣码 |
| label_info | object | Required | 订单面单参见LabelInfo |
| 参数名 | 数据类型 | 是否必填 | 说明 |
|---|---|---|---|
| label_image_type | int | Required | 面单格式3:PDF, 6:PNG, 7:JPG, 8:ZPL2, 10:GIF, 11:ZPL |
| label_url_list | String[] | RequiredIf | 面单 URL参数label_id_list为空时必填 |
| label_id_list | int[] | RequiredIf | 附件 ID参数label_url_list为空时必填 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 数据内容 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| refrence_no | String | Required | 50 | 支持:订单号,跟踪号,参考号 | 000010-200716-0006 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 参见OrderTrackingComposite类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
| code | String | False | 渠道名称 |
| trajectory_information | Object | False | 参见OrderTrajectoryInformationResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
| tracking_number | String | True | 跟踪号 |
| status_list | Object[] | True | 轨迹信息,参见OrderTrackingItemComposite类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
| utc_time | datetime | True | utc 时间 零时区 |
| date_time | datetime | True | 北京时间 |
| info | String | True | 物流详细信息 |
| location | String | True | 站点信息 |
| code | String | True | 轨迹代码 |
| code_info | String | True | 轨迹结构化详情 |
| TMS轨迹代码（新） | 轨迹描述 | 备注 | 总原则 |
|---|---|---|---|
| TMS_NTI | 查无轨迹 | 查无轨迹 | |
| TMS_OC | 订单创建 | 订单创建，服务商收到订单信息 | |
| TMS_AS | 预上网 | 预上网 | |
| TMS_PU | 揽件完毕 | 服务商揽件完毕 | 当揽收节点重复出现时，系统需取时间节点最早出现的轨迹映射为揽收 |
| TMS_IT | 运输中 | 货物运输途中（如到达某网点，到达某分拨中心等） | |
| TMS_OD | 派送中 | 货物到达目的地城市，准备派送给收方 | |
| TMS_WPU | 到达目的地 | 货物到达目的地城市，等待客户上门取件 | |
| TMS_RT | 退回寄放 | 退回给寄放 | |
| TMS_EXCP | 轨迹异常 | 轨迹异常（如货物无法投递，因服务商原因导致延迟等） | |
| TMS_FD | 派送完毕 | 派送完毕（如妥投，货物放在门口等） | 订单超过30个自然日，无签收轨迹，系统默认为签收。以订单预报时间为起始时间 |
| TMS_DF | 投递未遂 | 投递未遂（如客户不在家） | |
| TMS_UN | 无法匹配 | 指对抓回的轨迹系统找不到相应的匹配关系 | |
| TMS_NP | 未变化 | 未变化 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| value_list | String[] | Required | 包含订单号的字符串列表(最多包含50个) | ["G123456", "G321567"] | |
| code_type | String | Required | value_list中字符串的业务类型枚举类型
"order_code": 订单号 "reference_no": 参考号 "tracking_number": 追踪号 |
order_code |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object[] | 参见OrderTrackingComposite类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
| order_code | String | False | 订单号 |
| code | String | False | 渠道名称 |
| trajectory_information | Object[] | False | 参见OrderTrajectoryInformationResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
| tracking_number | String | True | 跟踪号 |
| status_list | Object[] | True | 轨迹信息,参见OrderTrackingItemComposite类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
| utc_time | Datetime | True | utc 时间 零时区 |
| date_time | Datetime | True | 北京时间 |
| info | String | True | 物流详细信息 |
| location | String | True | 站点信息 |
| code | String | True | 轨迹代码（映射内容参见下表「轨迹代码映射」） |
| code_info | String | True | 轨迹结构化详情 |
| TMS轨迹代码（新） | 轨迹描述 | 备注 | 总原则 |
|---|---|---|---|
| TMS_NTI | 查无轨迹 | 查无轨迹 | |
| TMS_OC | 订单创建 | 订单创建，服务商收到订单信息 | |
| TMS_AS | 预上网 | 预上网 | |
| TMS_PU | 揽件完毕 | 服务商揽件完毕 | 当揽收节点重复出现时，系统需取时间节点最早出现的轨迹映射为揽收 |
| TMS_IT | 运输中 | 货物运输途中（如到达某网点，到达某分拨中心等） | |
| TMS_OD | 派送中 | 货物到达目的地城市，准备派送给收方 | |
| TMS_WPU | 到达目的地 | 货物到达目的地城市，等待客户上门取件 | |
| TMS_RT | 退回寄放 | 退回给寄放 | |
| TMS_EXCP | 轨迹异常 | 轨迹异常（如货物无法投递，因服务商原因导致延迟等） | |
| TMS_FD | 派送完毕 | 派送完毕（如妥投，货物放在门口等） | 订单超过30个自然日，无签收轨迹，系统默认为签收。以订单预报时间为起始时间 |
| TMS_DF | 投递未遂 | 投递未遂（如客户不在家） | |
| TMS_UN | 无法匹配 | 指对抓回的轨迹系统找不到相应的匹配关系 | |
| TMS_NP | 未变化 | 未变化 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| order_code | String | Required | 100 | 订单号 | G000-210706-0001 |
| estimated_arrival_date | String | Optional | 期望到货时间（北京时间） | 2021-03-22 | |
| estimated_arrival_time | String | Optional | 到货时间段（北京时间） 物流产品支持则可填写，否则输入无效。支持选项有： 108:00~12:00 212:00~14:00 314:00~16:00 416:00~18:00 518:00~20:00 600:00~10:00 700:00~17:00 |
1 | |
| tax_info | Object | Optional | 税务信息，参见OrderTaxInfo类型 | ||
| address | Object | Required | 地址信息，参见OrderAddress类型 | ||
| fulfilment_info | Object | Required | 物流信息，参见OrderFulfilment类型 | ||
| truck_info | Object | Optional | 卡派渠道物流信息，参见对象 TruckInfo。
FBA类型订单 并且 所选物流产品为卡派渠道（is_truck=1）时, 必填。
|
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| ioss_number | String | Optional | 100 | IOSS号码 | |
| pid_number | String | Optional | 100 | PID号码 | |
| recipient_eori | String | Optional | 100 | 收件人EORI | |
| recipient_vat | String | Optional | 100 | 收件人VAT | |
| shipper_eori | String | Optional | 100 | 发件人EORI | |
| shipper_vat | String | Optional | 100 | 发件人VAT | |
| shipper_company_name | String | Optional | 100 | 发件人公司名称 | |
| recipient_vat_country | String | Optional | 2 | 收件人VAT注册国
参考获取国家/地区列表接口的 country_code 字段
|
GB |
| recipient_eori_country | String | Optional | 2 | 收件人EORI号注册国
参考获取国家/地区列表接口的 country_code 字段
|
US |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| sm_code | String | Required | 配送方式 | ||
| age_detection | String | Required | 年龄检测(枚举类型)
"0"-"无年龄检测" "16"-"16岁" "18"-"18岁" |
"0" | |
| insurance_value | String | Required | 保额
0.00-9999.99 当is_insurance为0时，insurance_value必须传0。 |
"9999.12" | |
| is_insurance | Int | Required | 1 | 是否投保(枚举类型)
0-否 1-是 |
0 |
| is_signature | Int | Required | 1 | 是否签名服务(枚举类型)
0-否 1-是 |
0 |
| is_lift_gate | Int | Required | 1 | 是否lift gate服务(枚举类型)
0-否 1-是 |
0 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| country_code | String | Required | 10 | 国家(地区)编码 | |
| city | String | Required | 50 | 城市 | |
| post_code | String | Required | 20 | 邮政编码 | |
| street1 | String | Required | 50 | 地址1 | |
| consignee_name | String | Required | 48 | 收货人名 | |
| last_name | String | Optional | 48 | 收货人姓 | |
| company | String | Optional | 50 | 公司名称 | |
| room_no | String | Optional | 20 | 门牌号 | |
| String | Optional | 100 | 邮箱 | ||
| ext | String | Optional | 8 | 分机号 | |
| phone | String | Optional | 20 | 电话 | |
| state | String | Optional | 20 | 州/省 | |
| street2 | String | Optional | 50 | 地址2 |
| 参数名 | 数据类型 | 是否必填 | 长度 | 说明 |
|---|---|---|---|---|
| reference_id | String | Required | 100 | 参考号，当物流产品为卡派渠道时需要填写，也可更换非卡派渠道物流产品 |
| seller_name | String | Required | 100 | 店铺名称，当物流产品为卡派渠道时需要填写，也可更换非卡派渠道物流产品 |
| fba_warehouse_code | String | Required | 100 | 亚马逊仓库地址四字代码，当物流产品为卡派渠道时需要填写，也可更换非卡派渠道物流产品 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| pageSize | Int | Required | 每页数据长度，最大值为200 | 10 | |
| page | Int | Required | 当前页 | 1 | |
| product_sku | String | Optional | 24 | 商品编码
精确匹配搜索， 编码为系统编码时，库存数 = 系统编码库存。 编码为外部编码时，库存数 = 外部编码库存。 |
LZZTEST1212 |
| product_sku_arr | String[] | Optional | 多个SKU,数组格式
最多允许200个元素，每个元素精确匹配搜索。
|
["LZZTEST1212","LZZTEST1212"] | |
| warehouse_code | String | Optional | 32 | 仓库代码 | USEA |
| warehouse_code_arr | String[] | Optional | 多个仓库代码,数组格式 | ["USEA"] |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| count | Int | 总数量 |
| data | Object | 数据内容 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| product_sku | String | SKU |
| warehouse_code | String | 仓库代码 |
| onway | Int | 在途数量 |
| pending | Int | 待上架数量 |
| sellable | Int | 可售数量 |
| unsellable | Int | 不合格数量 |
| reserved | Int | 待出库数量 |
| shipped | Int | 历史出库数量 |
| product_barcode | String | 商品编码（客户代码-商品编码） |
| stocking | Int | 备货数量 |
| pi_no_stock | Int | 缺货数量 |
| warehouse_desc | String | 仓库描述 |
| pi_freeze | Int | 冻结数量 |
| 已废弃 sold_shared | Int | (无效字段，兼容客户端而保留)已销售的共享数量 |
| 已废弃 tune_out | Int | (无效字段，兼容客户端而保留)待调出数量 |
| 已废弃 tune_in | Int | (无效字段，兼容客户端而保留)待调入数量 |
| 已废弃 product_sales_value | Int | (无效字段，兼容客户端而保留)商品销售价值 |
说明：客户填写相应商品信息，系统根据填写的信息自动核算在系统中的收费情况。
开发者请务必使用正确的URL，否则请求可能失败。
paramJson 里的内容原则要使用 html 编码，否则内容中有个别特殊的字符时，会产生Bad Request的失败响应。
为了提高当前示范代码的可读性，所以未进行编码，请勿作为生产行为指导。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| warehouse_code | String | Required | 32 | 发货仓库代码 | USEA |
| country_code | string | Required | 2 | 目的国家/地区代码 | US |
| shipping_method | string | Required | 32 | 配送方式 | FEDEX-SMALLPARCEL |
| postcode | string | Required | 32 | 邮政编码 | 33178 |
| weight | float | Required | 6 | 包裹重量单位KG
最多保留2位小数 |
12 |
| length | float | Optional | 6 | 包裹长 单位CM
最多保留2位小数 |
10 |
| width | float | Optional | 6 | 包裹宽 单位CM
最多保留2位小数 |
10 |
| height | float | Optional | 6 | 包裹高 单位CM
最多保留2位小数 |
10 |
| state | string | Optional | 100 | 省/州 | NY |
| city | string | Optional | 50 |
城市
当国家/地区为[澳大利亚]时，如果不传城市，可能导致费用结果与实际偏差较大。 |
New York |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | string | 参考response公共参数 |
| message | string | 参考response公共参数 |
| data | Object | 数据内容 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| totalFee | float | 总费用 |
| SHIPPING | float | 运输费 |
| OPF | float | 操作费用 |
| FSC | float | 燃油附加费 |
| DT | float | 关税 |
| RSF | float | 挂号 |
| OTF | float | 其它费用 |
说明：客户填写相应商品信息，系统根据填写的信息自动核算在系统中的收费情况。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| warehouse_code | String | Required | 20 | 仓库代码 | USEA |
| sm_code | String | Optional | 32 | 物流产品代码，未填写配送方式，试算所有可用物流产品的费用 | FEDEX_OVERNIGHT |
| country_code | String | Required | 2 | 目的国家/地区代码 | US |
| postcode | String | Required | 32 | 邮政编码 | 33178 |
| sku | String[] | Optional | 商品编码
[商品编码与包裹重量必须填写一个,商品编码与包裹重量都填写时,以商品编码为主] 格式如:["sku1","sku2:1","sku3:1"],多个商品隔开,冒号后接商品数量,不填商品数量,默认1件,最多不超过100种sku |
["123321","123322:1","123323:1"] | |
| weight | Float | Optional | 6 | 包裹重量单位KG
有sku参数时，以sku数据优先，下文参数length、width、height同理。 最多保留2位小数 |
10 |
| length | Float | Optional | 6 | 包裹长 单位CM
最多保留2位小数 |
10 |
| width | Float | Optional | 6 | 包裹宽 单位CM
最多保留2位小数 |
10 |
| height | Float | Optional | 6 | 包裹高 单位CM
最多保留2位小数 |
10 |
| is_residential | String | Optional | 1 | 是否住宅地址
[只能传0或1,默认0] 0：否 1：是 |
1 |
| is_sign_server | Int | Optional | 是否签名服务
[只能传1或2,默认1] 1：否 2：是 |
1 | |
| is_insurance_service | Int | Optional | 是否保险服务
[只能传1或2,默认1] 1：否 2：是 |
1 | |
| insurance_amount | Float | Optional | 7 | 保险金额(USD)
当is_insurance_service等于2时生效，保险金额 最多保留3位小数 |
10 |
| state | String | Optional | 100 | 省/州 | NY |
| city | String | Optional | 50 |
城市
当国家/地区为[澳大利亚]时，如果不传城市，可能导致费用结果与实际偏差较大。 |
New York |
| property_label | String | Optional | 50 | 平台模式
SFP
| SFP |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 数据内容 |
| currency | String | 费用币种 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| sm_code | String | 物流产品代码 |
| sm_name | String | 物流产品的英文名称 |
| sm_name_cn | String | 物流产品的中文名称 |
| sm_delivery_time_min | Int | 最慢时效 |
| sm_delivery_time_max | Int | 最快时效 |
| total | Float | 总费用 |
| income | object | 明细 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| name | String | 名称 |
| amount | Float | 费用 |
| 参数名 | 数据类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| pageSize | Int | Required | 每页数据长度，最大值为200 | 10 |
| page | Int | Required | 当前页 | 1 |
| application_code | Int | Optional | 操作类型 |
3 |
| warehouse_code | String | Optional | 仓库代码 | USEA |
| product_sku_list | String[] | Optional | 多个SKU，数组格式，精确匹配。 | ["ALI_AND_NABC_INO", "IND_KGRN_AD_KO"] |
| reference_no_list | String[] | Optional | 操作单号, 数组格式 | ["RVG296-210518-0016", "RVG296-210329-0001"] |
| create_date_from | datetime | Required | 操作开始时间, 格式YYYY-MM-DD | 2021-05-07 |
| create_date_end | datetime | Required | 操作结束时间, 格式YYYY-MM-DD。最大时间跨度为31天 | 2021-05-10 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| count | Int | 总数量 |
| data | Object[] | 数据内容 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| reference_no | String | 操作单号 |
| ref_no | String | 参考号 |
| application_code | String | 操作类型 |
| product_sku | String | 商品编码 (不带客户编码) |
| warehouse_code | String | 仓库代码 |
| warehouse_name | String | 仓库名称 |
| inventory_change_type | Int | 变动类型（1：新增，2：减少） |
| ibl_change_quantity | Int | 变动量 |
| remark | String | 备注 |
| ibl_add_time | String | 操作时间 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku_list | String[] | Optional | 商品编码列表(最多200个元素) | ||
| product_title | String | Optional | 商品名称 | ||
| product_title_en | String | Optional | 商品英文名称 | ||
| fifo_time_from | String | Optional | 上架时间起始值
北京时间, 时间区间参数必须成对提交 |
2021-04-11 00:00:00 | |
| fifo_time_to | String | Optional | 上架时间末位值
北京时间，时间区间参数必须成对提交 |
2021-10-14 23:59:59 | |
| age_from | Int | Optional | 库龄起始值 | ||
| age_to | Int | Optional | 库龄末位值 | ||
| quantity_from | Int | Optional | 在库库存起始值 | ||
| quantity_to | Int | Optional | 在库库存末位值 | ||
| warning_age_type | Int | Optional | 库龄预警， 枚举类型
1：超出 2：未超出 |
||
| warehouse_code | String | Optional | 仓库代码 | ||
| page | Int | Required | 分页页码 | 1 | |
| page_size | Int | Required | 分页数量(最大200) | 20 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 详情参考InventoryAgeListResp |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| total | Int | False | 总数量 |
| list | Object[] | False | 列表数据 详见InventoryAgeItemResp |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| warehouse_code | String | False | 仓库代码 |
| product_sku | String | False | 商品编码 |
| iba_quantity | Int | False | 在库库存 |
| iba_fifo_time | String | False | 上架时间（北京时间） |
| iba_warning_age | Int | False | 预警库龄 |
| product_title | String | False | 商品中文名称 |
| product_title_en | String | False | 商品英文名称 |
| warehouse_desc | String | False | 仓库名称 |
| warehouse_age | Int | False | 库龄 |
| expiration_date | String | False | 过期日期 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| fifo_time | String | Required | 上架时间（北京时间） | 2021-04-22 | |
| warning_age | Int | Required | 4 | 预警库龄(最大9999) | 1000 |
| warehouse_code | String | Required | 50 | 仓库代码 | USEA |
| product_sku | String | Required | 50 | 产品SKU | product_sku |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
说明： 如果物流运输方式不支持地址校验，系统将返回不支持地址校验的错误。 该接口不对地址的准确性进行校验，仅校验地址是否为住宅地址用于运费试算接口。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| address | Object | Required | 地址信息 | ||
| shipping_method | String | Required | 32 | 配送方式 | FEDEX-SMALLPARCEL |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| oab_firstname | String | Required | 48 | 收件人名 | Tom |
| oab_lastname | String | Optional | 48 | 收件人姓 | Tom |
| oab_company | String | Optional | 50 | 公司名称 | Li |
| oab_street_address1 | String | Required | 50 | 公司地址1 | 创汇 |
| oab_state | String | Optional | 20 | 州 | FL |
| oab_city | String | Required | 50 | 城市 | Miami |
| oab_postcode | String | Required | 20 | 邮编 | 33178 |
| country_code | String | Required | 2 | 国家/地区简称 | US |
| oab_phone | String | Optional | 20 | 联系电话 | 435028690 |
| oab_street_address2 | String | Optional | 50 | 地址2 | 创汇2 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 校验后的地址信息，参见 AddressResp。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| 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-住宅 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| order_code | String | Required | 50 | 订单号 | 000010-200708-0002 |
| ref_no | String | Optional | 50 | 参考号 | 2020072201 |
| return_identification | Int | Required | 1 | 退件标识，默认为谷仓发货退件
1：谷仓发货退件 2：非谷仓发货退件 |
1 |
| is_verify | String | Required | 1 | 是否直接审核 不填默认为0， 审核通过之后，不可编辑 0：新建不审核(草稿状态) 1：新建并审核 |
0 |
| warehouse_code | String | Required | 32 | 退件收货仓库 | USWE |
| collect_warehouse_code | String | Optional | 50 | 集货区域仓编码 | USWE |
| collect_wp_code | String | Optional | 50 | 集货物理仓编码 | USWE001 |
| is_transit | Int | Optional | 1 | 是否退回集货仓，默认为2
2：否 1：是 |
2 |
| service_type | Int | Optional | 1 | 退货服务类型，默认为1
1：退件质检 2：退件销毁 |
1 |
| logistics | String | Required | 1 | 派送方式
0：代选 1：自选 |
0 |
| courier | String | Optional | 32 | 物流产品，当派送方式为0时，必填 | FEDEXG-RETURN |
| tracking_no | String | Optional | 50 | 跟踪号 | TRE362101 |
| photo_no | Int | Optional | 照片数量 默认3张，最大20 最小0 | 0 | |
| ro_desc | String | Optional | 500 | 退件原因 | 客户取消订单 |
| ro_note | String | Optional | 255 | 客服备注 | 取消订单 |
| product_list | Object | Required | 退件产品明细 | ||
| delivery_address | Object | Required | 退件发货地址：退件单的发货地址，默认为订单收件人地址 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 |
客户商品编码 注意：客户商品SKU（不以客户编码开头的，而非barcode） |
TEST1 |
| num | Int | Required | 数量 | 2 | |
| return_replacement_sku | String | Optional | 50 | 更换的商品编码 不传默认取商品中的退件默认换标编码 |
TEST11 |
| photo_list | String[] | Optional | 图片信息 | ["./test.png"] | |
| product_barcode | String | Optional | 24 | 此参数为历史遗留问题，意义同product_sku，后续将取消掉，请勿使用此参数，如果您正在使用此参数，请改为product_sku | TEST1 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| name | String | Required | 48 | 收件人名 | Lucy |
| last_name | String | Optional | 48 | 收件人姓 | Garner |
| country_code | String | Required | 2 | 收件人国家/地区 | US |
| province | String | Optional | 20 | 收件人省/洲（美国，澳洲地址校验需校验省/洲） | FL |
| city | String | Required | 50 | 收件人城市 | Miami |
| address1 | String | Required | 50 | 收件人地址1 | 180 Chambers Rd |
| address2 | String | Optional | 50 | 收件人地址2 | 180 Chambers Rd 2 |
| company | String | Optional | 50 | 公司名 | Goole |
| doorplate | String | Optional | 20 | 门牌号 | 3 |
| zipcode | String | Required | 50 | 收件人邮编 | 33178 |
| phone | String | Optional | 20 | 收件人电话 | 435028690 |
| String | Optional | 100 | 收件人邮箱 | xx@gmail.com |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 退货单创建响应结果，参见 ReturnOrderMutationResp。 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| return_order_code | String | 退件单号 |
| tracking_no | String | 跟踪号(代选物流才回传跟踪号) |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| return_code | String | Required | 32 | 退件号 | R000010-200722-0001 |
| warehouse_code | String | Required | 32 | 退件收货仓库 | USWE |
| logistics | String | Required | 1 | 派送方式
0：代选 1：自选 |
0 |
| courier | String | Optional | 32 | 物流产品，当派送方式为0时，必填 | FEDEXG-RETURN |
| collect_warehouse_code | String | Optional | 50 | 集货区域仓编码 | USWE |
| is_transit | Int | Optional | 1 | 是否退回集货仓，默认为2
2：否 1：是 |
2 |
| service_type | Int | Optional | 1 | 退货服务类型，默认为1
1：退件质检 2：退件销毁 |
1 |
| tracking_no | String | Optional | 50 | 跟踪号 | TRE362109 |
| ro_desc | String | Optional | 500 | 退件原因 | 客户取消 |
| photo_no | Int | Optional | 照片数量 默认3张，最大20 最小0 | 0 | |
| product_list | Object | Required | 退件产品明细 | ||
| delivery_address | Object | Required | 退件发货地址：退件单的发货地址，默认为订单收件人地址 | ||
| is_verify | String | Required | 1 | 是否提交审核
0：不审核(默认) 1：提交审核 |
1 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 24 |
客户商品编码 注意：客户商品SKU（不以客户编码开头的，而非barcode） |
TEST1 |
| num | Int | Required | 数量 | 2 | |
| return_replacement_sku | String | Optional | 50 | 更换的商品编码 不传默认取商品中的退件默认换标编码 |
TEST11 |
| photo_list | String[] | Optional | 图片信息 | ["./test.png"] | |
| product_barcode | String | Optional | 24 | 产品编码 | TEST1 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| name | String | Required | 48 | 收件人名 | Lucy |
| last_name | String | Optional | 48 | 收件人姓 | Garner |
| country_code | String | Required | 2 | 收件人国家/地区 | US |
| province | String | Optional | 20 | 收件人省/洲（美国，澳洲地址校验需校验省/洲） | FL |
| city | String | Required | 50 | 收件人城市 | Miami |
| address1 | String | Required | 50 | 收件人地址1 | 180 Chambers Rd |
| address2 | String | Optional | 50 | 收件人地址2 | 180 Chambers Rd 2 |
| company | String | Optional | 50 | 公司名 | Goole |
| doorplate | String | Optional | 20 | 门牌号 | 3 |
| zipcode | String | Required | 50 | 收件人邮编 | 33178 |
| phone | String | Optional | 20 | 收件人电话 | 435028690 |
| String | Optional | 100 | 收件人邮箱 | xx@gmail.com |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 请求响应结果，参见 ReturnOrderUpdateResp。 |
| return_order_code | String | 退件单号 |
| verify_error | String | 审核错误信息 |
说明：废弃退件单，草稿状态和已提交状态可以废弃。已提交状态下废弃需要谷仓工作人员审核。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| ro_code | String | Required | 32 | 退件单号 | R000010-200623-0001 |
| new_desc | String | Optional | 500 | 退件原因 | 客户退件 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Int | 1表示成功，2表示失败 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| reference_no | String | Optional | 50 | 参考号 | fdzxcv4654132 |
| asroCodes | String | Optional | 32 | 退件单号 | R000010-200710-0005 |
| 参数二选一或者2个都填 | |||||
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 数据内容 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| asro_code | String | 退件单号 |
| order_code | String | 订单号 |
| reference_no | String | 参考号 |
| is_transit | Int | 是否退回集货仓：
1：是 2：否 |
| collect_warehouse_code | String | 集货区域仓编码 |
| service_type | Int | 退货服务类型：
1：退件质检 2：退件销毁 |
| asro_status | String | 退件状态
0：草稿 1：已提交 4：收货完成 5：处理完成 6：废弃 7：处理中改动说明：由于业务调整，去掉了2待确认，3已确认等状态 |
| 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 | 退件原因 |
| product_detail | Object[] | 退件产品明细 |
| sm_code | String | 物流产品编码 |
| as_length | Int | 计费长 |
| as_width | Int | 计费宽 |
| as_height | Int | 计费高 |
| charge_weight | Int | 计费重 |
| asro_note | String | 客服留言 |
| return_identification | Int | 退件标识：
1：谷仓发货退件 2：非谷仓发货退件 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| product_barcode | String | 商品编码 |
| product_sku | String | 客户商品编码 |
| return_auth | Int | 退件授权
0：否 1：是 |
| return_replacement_sku | String | 换标编码 |
| photo_list | String[] | 图片信息 |
| sellable_qty | Int | 良品数量 |
| unsellable_qty | Int | 不良品数量 |
| destruction_qty | Int | 销毁数量 |
| sellable_detail | Object[] | 良品明细 |
| unsellable_detail | Object[] | 不良品明细 |
| destruction_detail | Object[] | 销毁明细 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| pas_code | String | 售后码 |
| new_product_sku | String | 新客户商品编码 |
| new_product_barcode | String | 该字段已废弃，请使用new_product_sku |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| shipping_fee | Float | 运输费 |
| operating_fee | Float | 操作费用 |
| fuel_surcharge | Float | 燃油附加费 |
| other_fee | Float | 其它费用 |
| currency_code | String | 币别 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| pageSize | String | Required | 每页数据长度, 最大值100 | 10 | |
| currentPage | String | Required | 当前页 | 1 | |
| startTime | String | Optional | datetime | 创建时间 | 2020-06-22 09:00:00 |
| endTime | String | Optional | datetime | 结束时间 | 2020-06-22 09:00:00 |
| startUpdateTime | String | Optional | datetime | 更新时间 | 2020-06-22 09:00:00 |
| endUpdateTime | String | Optional | datetime | 结束更新时间 | 2020-06-22 09:00:00 |
| asroStatus | String | Optional | 2 | 售后退件状态
0：草稿 1：已提交 4：收货完成 5：处理完成 6：废弃 7：处理中 |
0 |
| cassType | String | Optional | 2 | 退件类型
0：服务商退件 1：客户退件 2：未预报退件 |
1 |
| asroCodes | String | Optional | 32 | 退件单号 | R000010-200623-0001 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 数据内容 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| asro_code | String | 退件单号 |
| reference_no | String | 参考号 |
| asro_status | Int | 退件状态
0：草稿 1：已提交 4：收货完成 5：处理完成 6：废弃 7：处理中改动说明：由于业务调整，去掉了2待确认，3已确认等状态 |
| cass_type | Int | 退件类型
0：服务商退件 1：客户退件 2：未预报退件 |
| asro_add_time | String | 创建时间 |
| asro_audit_time | String | 审核时间 |
| asro_putaway_time | String | 上架完成时间 |
| is_transit | Int | 是否退回集货仓：
1：是 2：否 |
| collect_warehouse_code | String | 集货区域仓编码 |
| service_type | Int | 退货服务类型：
1：退件质检 2：退件销毁 |
| warehouse_code | String | 退件收货仓库 |
| sm_type | Int | 派送方式
0：代选物流 1：自选物流 |
| tracking_no | String | 跟踪号 |
| asro_reason | String | 退件原因 |
| product_detail | object[] | 退件产品明细 |
| sm_code | String | 物流产品编码 |
| order_code | String | 订单号 |
| as_length | Int | 计费长 |
| as_width | Int | 计费宽 |
| as_height | Int | 计费高 |
| charge_weight | Int | 计费重 |
| asro_note | String | 客服留言 |
| return_identification | Int | 退件标识：
1：谷仓发货退件 2：非谷仓发货退件 |
| fee_details | Object | 费用明细 |
| validity_period_detail | Object[] | 效期实收明细 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| product_barcode | String | 商品编码 |
| product_sku | String | 客户商品编码 |
| return_auth | Int | 退件授权
0：否 1：是 |
| return_replacement_sku | String | 换标编码 |
| photo_list | String[] | 图片信息 |
| sellable_qty | Int | 良品数量 |
| unsellable_qty | Int | 不良品数量 |
| destruction_qty | Int | 销毁数量 |
| sellable_detail | Object[] | 良品明细 |
| unsellable_detail | Object[] | 不良品明细 |
| destruction_detail | Object[] | 销毁明细 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| pas_code | String | 售后码 |
| new_product_sku | String | 新客户商品编码 |
| new_product_barcode | String | 该字段已废弃，请使用new_product_sku |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| shipping_fee | Float | 运输费 |
| operating_fee | Float | 操作费用 |
| fuel_surcharge | Float | 燃油附加费 |
| other_fee | Float | 其它费用 |
| currency_code | String | 币别 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| product_sku | String | 商品SKU |
| custom_product_sku | String | 换标编码 |
| validity_period_days | Int | 有效期天数 |
| on_shelf_num | Int | 上架数量 |
| receipt_num | Int | 实收数量 |
| creation_date | String | 生产日期 |
| expiration_date | String | 过期日期 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| asro_code | String | Required | 32 | 退件号 | R000010-200518-0006 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 数据内容 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| label_base64 | String | 返回base64编码图片 |
| label_type | String | png或pdf |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| page_size | Int | Required | 每页数据长度，最大值100 | 10 | |
| page | Int | Required | 当前页 | 1 | |
| pas_code | String | Optional | 50 | 售后码 | fdzxcv4654132 |
| product_sku | String | Optional | 24 | 商品编码 | fdzxcv4654132 |
| reference_no | String | Optional | 50 | 参考号 | fdzxcv4654132 |
| asro_code | String | Optional | 32 | 退件单号 | R000010-200518-0006 |
| start_time | String | Optional | datetime | 创建时间（开始） 格式YYYY-MM-DD HH:II:SS 如果退件单号或参考号传值时，该参数无效 |
2020-06-01 10:41:05 |
| end_time | String | Optional | datetime | 创建时间（结束） 格式YYYY-MM-DD HH:II:SS 如果退件单号或参考号传值时，该参数无效 |
2020-06-01 10:41:05 |
| time_type | Int | Optional | 查询时间区间类型 1：创建时间 2：收货时间默认为创建时间类型 |
1 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 数据内容 参见UnauthorizedListResp类型 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| list | Object[] | 列表数据 参见UnauthorizedListItemResp类型 |
| total | Int | 总数量 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| asro_code | String | 退件单号 |
| reference_no | String | 参考号 |
| order_code | String | 订单号 |
| sm_type | Int | 派送方式:
0：代选物流 1：自选物流 |
| collect_warehouse_code | string | 集货仓库代码 |
| confirm_status | Int | 确认状态:
0：待确认 1：已确认该接口只返回"待确认"的数据 |
| cass_type | String | 退件类型
0：服务商退件 1：客户退件 2：未预报退件 |
| tracking_no | String | 跟踪号 |
| sm_code | String | 物流产品编码 |
| warehouse_code | String | 退件收货仓库 |
| product_sku | String | 客户商品编码 |
| pas_code | String | 售后码 |
| photos | String[] | 商品图片URL列表 数组元素为URL完整WEB路径 |
| quantity | Int | 收货数量 |
| received_time | String | 收货日期 |
| 已废弃product_barcode | String | 商品编码（字段已废弃，请使用product_sku替代） |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| pas_code | String | Required | 50 | 售后码 | SHM20200720000036 |
| product_sku | String | Optional | 50 |
新商品编码 当处理方式（exception_process_type=0）为良品，并且原商品码未知时必填。 注意：客户商品SKU（不以客户编码开头的），而非barcode |
GC00050 |
| exception_process_type | Int | Required | 2 | 处理方式
0：良品 1：销毁仅良品上架可使用系统产品代码进行更换 |
1 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| returnOrderCodes | String[] | Required | 退件订单号 | ["RG296-200908-0004"] | |
| message | String | Required | 255 | 留言说明 | 取消订单 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 数据内容 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| result | String | 返回结果，Success 成功 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| pageSize | String | Required | 每页数据长度, 最大值100 | 10 | |
| page | String | Required | 当前页 | 1 | |
| tracking_code | String | Optional | 50 | 跟踪号 | test666 |
| claim_code | String | Optional | 50 | 认领单号 | 2020234 |
| asro_code | String | Optional | datetime | 退件单号 | As908888 |
| warehouse_code | String | Optional | 32 | 仓库代码 | 2020-06-22 09:00:00 |
| status | Int | Optional | 1 | 状态
1：待认领 2：已认领 3：已销毁 |
1 |
| create_time_start | String | Optional | 50 | 收货开始时间 | |
| create_time_end | String | Optional | 50 | 收货结束时间 | |
| dispose_time_start | String | Optional | 50 | 销毁开始时间 | |
| dispose_time_end | String | Optional | 50 | 销毁结束时间 | |
| claim_time_start | String | Optional | 50 | 认领开始时间 | |
| claim_time_end | String | Optional | 50 | 认领结束时间 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object[] | 数据内容,参见Data参数 |
| count | Int | 总数 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| tracking_no | String | 跟踪号 |
| claim_code | String | 认领单号 |
| asro_code | String | 退件单号 |
| warehouse_code | String | 仓库代码 |
| service_type | Int | 退货服务类型：1:退件质检,2:退件销毁 |
| status | Int | 状态 1待认领 2已认领 3已销毁 |
| create_time | String | 收货时间 |
| claim_time | String | 认领时间 |
| destroy_time | String | 销毁时间 |
| error_message | String | 认领失败信息 |
| expire_destroy_time | String | 超期销毁剩余时间 (单位：天) |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object[] | 数据内容，参见Data参数 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| warehouse_code | String | 仓库代码 |
| warehouse_name | String | 仓库名称 |
| cass_type | Int | 服务类型: 0.服务商退件，1.客户退件 |
| service_type_list | Int[] | 退货服务类型：1:退件质检,2:退件销毁 |
| enable_transit | Int | 是否支持退件转仓 0不支持 1支持 |
| return_identification | String | 1.谷仓发货退件, 2.非谷仓发货退件, 3.全部 |
| collect_warehouse | Object[] | 集货仓信息 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| warehouse_id | String | 仓库id |
| warehouse_code | String | 仓库代码 |
| warehouse_name | String | 仓库名称 |
| country_name | String | 国家名称 |
| country_code | String | 国家编码 |
| state | String | 省/州 |
| city | String | 城市 |
| street_address1 | String | 街道地址1 |
| street_address2 | String | 街道地址2 |
| postcode | String | 邮编 |
| wp_code | String | 物理仓编码 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| reference_no | String | Optional | 32 | 退件参考号 | test11220 |
| service_type | Int | Required | 1 | 退货服务类型
1：退件质检 2：退件销毁 |
1 |
| claim_code | String | Required | 50 | 认领单号 | TEST556 |
| product_list | Object[] | Required | 商品列表 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| old_product_sku | String | Required | 50 | 原商品编码 | TEST1 |
| num | Int | Required | 数量 | 2 | |
| new_product_sku | String | Optional | 50 | 更换的商品编码 | TEST11 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| data | Object | 数据内容 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| asro_code | String | 退件单号 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| wis_code | String | Optional | 32 | 单号 | WT000010-1-20200722 |
| ow_id_charge | String | Optional | 32 | 仓库代码 | USEA |
| dateFrom | Date | Optional | datetime |
开始时间 格式:Y-m-d H:i:s
如果开始时间和截止时间都不填，则默认查询一个月。 |
2020-07-21 09:30:00 |
| dateTo | Date | Optional | datetime | 截至时间 格式:Y-m-d H:i:s
如果开始时间和截止时间都不填，则默认查询一个月。 |
2020-07-21 09:30:00 |
| page | Int | Required | 查询页数，不传值则默认第1页 | 1 | |
| pageSize | Int | Required | 每页显示数量 不传值则默认10条数量，大于100查询100 |
20 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| count | Int | 总数量 |
| data | Object | 数据内容 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| wis_code | String | 单号 |
| wp_settlement_cycle | String | 结算周期 |
| ow_id_charge | String | 仓库代码 |
| is_date | Date | 发生时间 Y:m:d |
| isdb_volume | String | 体积(m3) |
| is_amount | String | 计费总金额 |
| currency_code | String | 计费货币 |
| is_settlement_amount | String | 结算总金额 |
| settlement_currency_code | String | 结算货币 |
| note | String | 备注 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| wis_code | String | Required | 32 | 单号 | WT000010-1-20200722 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ask | String | Success 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 这是V1版本API，所以响应结构为V1版本，请开者注意区别。 | ||
| count | Int | 总数量 |
| data | Object[] | 仓租明细数组，数组对象结构参见WarehouseRentDetailItemResp |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| wis_code | String | 单号 |
| product_barcode | String | 产品代码 |
| product_name | String | 产品名称 |
| reference_no | String | 参考编号 |
| charge_date | Datetime | 计费时间 |
| putaway_date | Datetime | 上架时间 |
| length | Float | 长(cm) |
| width | Float | 宽(cm) |
| height | Float | 高(cm) |
| quantity | Int | 数量 |
| volume | Float | 体积(m3) |
| bill_amount | Float | 计费金额 |
| bill_currency_code | String | 计费币种 |
| settlement_amount | Float | 结算金额 |
| settlement_currency_code | String | 结算币种 |
| day | Int | 库龄(天) |
| peak_season_surcharge | String | 旺季附加费 |
| isdb_amount | String | 仓租金额 |
| warehouse_code | String | 仓库代码 |
| storage_shape | String | 存储物理形态储位盒 箱 托 件 |
| bill_unit | String | 计费单位，如： 数量，体积，数量/月均，数量/天，体积/天 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| flow_type | String | Optional | 流水类型，(枚举类型)
0: 入款 1: 扣款 2: 冻结 3: 解冻 |
1 | |
| number_type | String | Optional | 单号类型，(枚举类型，参数必须与order_number成对提交)
"order_number": 单号 "reference_number": 参考号 |
order_number | |
| order_number | String | Optional | 单号（订单号或者参考号的值，参数必须与number_type成对提交） | ||
| account_code | String | Optional | 账户编号 | ACCOUNT_CODE_STRING | |
| business_type | Int | Optional | 业务类型，(枚举类型)
"0": 海外仓储 "1":中转代发 |
0 | |
| types_of_fee | String | Optional | 费用类型(具体详见获取费用类型接口) | CBC | |
| currency_code | String | Optional | 币种(具体参见获取货币列表接口) | JPY | |
| charge_type | Int | Optional | 业务类型，(枚举类型)
"0": 未出账 "1":已出账 "2":出账中 |
0 | |
| page | Int | Required | 当前分页 | 1 | |
| page_size | Int | Required | 分页数量(最大200) | 20 | |
| happen_start_time | String | Required | 发生开始时间
时间跨度最大为365天（北京时间, 时间区间参数必须一起提交） |
2021-09-13 00:00:00 | |
| happen_end_time | String | Required | 发生结束时间时间跨度最大为365天（北京时间, 时间区间参数必须一起提交） |
2021-10-14 00:00:00 | |
| next_page_token | String | Optional | 200 | 下一页token
当请求分页数据 > 5000条时，next_page_token, prev_page_token 必填其一 next_page_token, prev_page_token 不能同时存在， |
|
| prev_page_token | String | Optional | 200 | 上一页token
当请求分页数据 > 5000条时，next_page_token, prev_page_token 必填其一。 next_page_token, prev_page_token 不能同时存在， |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 参见 CostStatementListResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| total | Int | False | 总数量 |
| list | Object[] | False | 列表数据 参见CostStatementItemResp类型 |
| next_page_token | String | True | 超过5000时的下一页token
当请求分页数据 > 5000条时，不再支持页码跳转（page参数暂时失效）， 要根据出参的next_page_token/prev_page_token查询上一页/下一页数据。 |
| prev_page_token | String | True | 超过5000时的上一页token
当请求分页数据 > 5000条时，不再支持页码跳转（page参数暂时失效）， 要根据出参的next_page_token/prev_page_token查询上一页/下一页数据。 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| order_number | String | False | 单号 |
| reference_number | String | True | 交易流水号 |
| account_code | String | False | 账户编码 |
| types_of_fee_name_cn | String | True | 费用代码中文名称 |
| types_of_fee_name_en | String | True | 费用代码英文名称 |
| flow_type | String | False | 流水类型 |
| flow_type_text | String | False | 流水类型文本 |
| amount | String | False | 发生金额 |
| currency_code | String | False | 币种 |
| currency_balance | String | False | 当前账户币种余额 |
| exchange_rate | String | True | 汇率 |
| types_of_fee_text | String | True | 费用类型编码描述 |
| charge_type_text | String | True | 出账状态 |
| add_time | String | False | 发生时间（北京时间） |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| code_field | String | Required | 单号类型，(枚举类型)
"reference_number": 银行流水号 "order_number": 充值单号 |
reference_number | |
| code_value | String | Optional | 字段值 | order_number | |
| transaction_type | Int | Optional | 充值交易类型，(枚举类型)
0: 余额转汇（转入） 1: 余额转汇（转出） 2: 银行转账 3: Payoneer 4: 自动转汇（转入） 5: 自动转汇（转出） 6: 原件返利 7: 退件返利 8: 现金支付 9: 主体余额转移（转入） 10: 主体余额转移（转出） 11: 调增充值 12: 调减充值 |
0 | |
| transaction_gd_status | Int | Optional | 交易状态，(枚举类型)
0: 待处理 1: 已到账 2: 已废弃 3: 草稿 4: 审核异常 5: 驳回 |
0 | |
| bank_name | String | Optional | 付款银行名称(参见银行列表接口) | 招商银行 | |
| account_code | String | Optional | 账户编码 | ||
| begin_add_time | String | Optional | 充值开始日期
北京时间，186天跨度, 时间区间参数必须一起提交 |
2021-07-27 00:41:23 | |
| end_add_time | String | Optional | 充值结束日期
北京时间，186天跨度，时间区间参数必须一起提交 |
2021-07-27 12:41:23 | |
| page | Int | Required | 分页标签 | ||
| page_size | Int | Required | 分页数量(最大200) | 20 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 详见TopUpRecordResp参数 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| list | Object[] | 详见TopUpRecordItemResp数据结构 |
| total | Int | 总数 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| order_number | String | False | 单号 |
| reference_number | String | True | 交易流水号 |
| account_code | String | False | 账户编码 |
| sign_body_name | String | False | 签约主体名称 |
| service_body_name | String | False | 服务主体名称 |
| sign_business_type_text | String | True | 签约业务类型 |
| drawee | String | True | 付款人 |
| transaction_type_text | String | False | 交易方式文本 |
| bank_name | String | True | 付款银行 |
| drawee_account | String | True | 付款银行账号 |
| transaction_status_text | String | False | 审核状态 |
| register_amount | String | False | 登记金额 |
| arrival_amount | String | False | 到账金额 |
| actual_amount | String | False | 实收金额 |
| currency_code | String | False | 币种，比如USD |
| exchange | String | False | 转汇汇率 |
| add_time | String | False | 充值时间（北京时间） |
| recharge_code | String | False | 充值币种 |
| update_time | String | False | 到账时间（北京时间） |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| bill_number | String | Optional | 账单号 | ||
| begin_bill_to_time | String | Optional | 账单截至时间开始
北京时间, 186天跨度, 时间区间参数必须一起提交 |
2021-04-12 00:00:00 | |
| end_bill_to_time | String | Optional | 账单截至时间结束
北京时间, 186天跨度, 时间区间参数必须一起提交 |
2021-10-15 23:59:59 | |
| account_code | String | Optional | 账户编码（不传则查询所有账户） | ||
| page | Int | Required | 分页标签 | 1 | |
| page_size | Int | Required | 分页数量(最大200) | 10 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object[] | 详见参见 BillingListResp类型 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| list | Object[] | 参见BillingItemResp类型 |
| total | Int | 总数 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| bill_number | String | False | 交易流水号 |
| account_code | String | False | 账户编码 |
| bill_from_time | String | False | 账单开始日期 |
| bill_to_time | String | False | 账单结束日期 |
| bill_file_path | String | False | 账单文件地址 |
| sign_body_name | String | False | 签约主体 |
| sign_business_type_list_text | String | False | 签约业务 |
| service_body_name | String | False | 服务主体 |
| all_total | Object[] | False | 账单总金额 参见BillFundsResp类型 |
| start_balance | Object[] | False | 期初余额 参见BillFundsResp类型 |
| end_balance | Object[] | False | 期末余额 参见BillFundsResp类型 |
| cash_back_balance | Object[] | False | 返现金额 参见BillFundsResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| currency_code | String | False | 币种 |
| balance | String | False | 金额 |
根据账单号，下载单账单文件（.xlsx格式），多账单号为压缩包文件（.zip格式）。 该API会较严格的限流措施，请在得到base64文件内容后，在客户端及时保存内容，减少此api请求。
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| bill_number_list | String[] | Required | 账单号列表(列表最大值为500) | ["B20210728G2960029", "B20210601G2960007"] |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | String | BASE64文件字符串 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object[] | 参见 CurrencyRateItemResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| currency_code | string | False | 货币缩写 |
| currency_name | String | False | 货币名称 |
| symbol | String | False | 货币标识符 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object[] | 数组元素类型, 参见BankListItemResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| bank_code | String | True | 银行编码 |
| bank_name | String | True | 银行名称 |
| bank_name_cn | String | True | 银行中文名 |
| bank_name_en | String | True | 银行英文名 |
| is_third | String | True | 是否第三方, 1:是 0:否 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| code_type | String | Required | 查单类型，(枚举类型)
"io_code":查件单号 "order_code":订单号 "tracking_no":追踪号 |
io_code | |
| code_value_list | String[] | Optional | 单号值,用数组传递(最多200个元素) | ["CJ302107210002"] | |
| io_status | Int | Optional | 查件状态，(枚举类型)
1:草稿 2:待处理 3:处理中 7:已回复 8:完结 10:废弃 11:驳回) |
||
| trail_status | String | Optional | 轨迹状态，(枚举参见下述轨迹TrackingCode类型) | ||
| warehouse_code | String | Optional | 仓库编码 | USAE | |
| sm_code | String | Optional | 物流方式编码 | FEDEX-SMALLPARCEL | |
| platform | String | Optional | 销售平台(大写字母) | AMAZON | |
| it_type_id | Int | Optional | 查件类型ID，详见查件类型列表接口 | ||
| time_type | String | Optional | 时间类型，(枚举类型，存在时间区间参数时，此项必填)
"add_time":创建时间 "commit_time":提交时间 "reply_time":回复时间 |
add_time | |
| time_start | String | Optional | 开始时间（北京时间，186天跨度, 时间区间参数必须一起提交） | 2021-04-19 00:00:00 | |
| time_end | String | Optional | 结束时间（北京时间，186天跨度, 时间区间参数必须一起提交） | 2021-10-22 23:59:59 | |
| page | Int | Required | 分页页码 | 1 | |
| page_size | Int | Required | 分页数量(最大200) | 20 |
| TMS轨迹代码（新） | 轨迹描述 | 备注 | 总原则 |
|---|---|---|---|
| TMS_NTI | 查无轨迹 | 查无轨迹 | |
| TMS_OC | 订单创建 | 订单创建，服务商收到订单信息 | |
| TMS_AS | 预上网 | 预上网 | |
| TMS_PU | 揽件完毕 | 服务商揽件完毕 | 当揽收节点重复出现时，系统需取时间节点最早出现的轨迹映射为揽收 |
| TMS_IT | 运输中 | 货物运输途中（如到达某网点，到达某分拨中心等） | |
| TMS_OD | 派送中 | 货物到达目的地城市，准备派送给收方 | |
| TMS_WPU | 到达目的地 | 货物到达目的地城市，等待客户上门取件 | |
| TMS_RT | 退回寄放 | 退回给寄放 | |
| TMS_EXCP | 轨迹异常 | 轨迹异常（如货物无法投递，因服务商原因导致延迟等） | |
| TMS_FD | 派送完毕 | 派送完毕（如妥投，货物放在门口等） | 订单超过30个自然日，无签收轨迹，系统默认为签收。以订单预报时间为起始时间 |
| TMS_DF | 投递未遂 | 投递未遂（如客户不在家） | |
| TMS_UN | 无法匹配 | 指对抓回的轨迹系统找不到相应的匹配关系 | |
| TMS_NP | 未变化 | 未变化 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 详见LogisticTicketListDataResp参数 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| total | Int | False | 总数量 |
| list | Object[] | False | 列表数据 详见LogisticTicketListItem |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| io_code | String | False | 查件号 |
| order_code | String | False | 订单号 |
| tracking_no | String | False | 跟踪号 |
| it_type_name | String | False | 查件类型名 |
| warehouse_code | String | False | 仓库代码 |
| warehouse_name | String | False | 仓库名称 |
| sm_name | String | True | 物流产品 |
| add_time | String | True | 创建时间（北京时间） |
| commit_time | String | True | 提交时间（北京时间） |
| last_handle_time | String | True | 处理时间（北京时间） |
| reply_time | String | True | 回复时间（北京时间） |
| io_status | Int | True | 查件状态
1:草稿 2:待处理 3:处理中 7:已回复 8:完结 10:废弃 11:驳回 |
| io_status_text | String | True | 查件状态文本 |
| trail_status | String | True | 物流状态
枚举参见 TrackingCode 类型
|
| trail_status_text | String | True | 物流状态文本 |
| customer_service_reply | String | True | 客服回复 |
| replay_attachment_file_list | Object[] | True | 回复附件列表, 参见ReplyAttachmentItemResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| url | String | False | 链接 |
| name | String | False | 名称 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| sm_code | String | Optional | 30 | 物流方式编码 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object[] | 参见IOTypeResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| name | String | False | 类型名称 |
| value | Int | False | 值 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| order_code | String | Required | 50 | 订单号 | |
| tracking_no | String | Required | 50 | 跟踪号 | |
| it_type_id | Int | Required | 查件类型ID
参见获取查件单类型列表接口 |
1 | |
| save_type | Int | Required | 保存类型,枚举字段:
1: 保存
2: 提交
|
1 | |
| io_desc | String | Required | 300 | 查件需求【5-300字符】 | |
| customer_emails_list | String[] | Required | 通知邮箱（最多十个邮箱） | ["a@example.com", "b@example.com"] | |
| attachment_id_list | int[] | Optional | 附件ID列表（最多五个）
详见上传附件接口 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 参见IoCodeResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| io_code | String | False | 查件单号 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| io_code | String | Required | 查件单号 | ||
| io_desc | String | Required | 300 | 查件需求【5-300字符】 | |
| customer_emails_list | String[] | Required | 通知邮箱（最多十个邮箱） | ["a@example.com", "b@example.com"] | |
| save_type | Int | Required | 保存类型，(枚举类型)
1:保存 2:提交 |
1 | |
| attachment_id_list | Int[] | Optional | 附件ID列表
详见上传附件接口 |
[1,2,3] |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| io_code | String | Required | 查件单号 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 参考LogisticTicketDetailDataResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| base_info | Object | False | 基本信息,参见LogisticTicketDetailBaseInfo类型 |
| order_info | Object | False | 订单信息,参见LogisticTicketDetailOrderInfo类型 |
| recheck_info | Object | True | 复查信息,参见LogisticTicketDetailRecheckAppealInfo类型 |
| appeal_info | Object | True | 申诉信息,参见LogisticTicketDetailRecheckAppealInfo类型 |
| log_info | Object | False | 日志信息,参见LogisticTicketDetailLogInfo类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| io_code | String | False | 查件号 |
| io_status_text | String | False | 查件状态文本 |
| customer_emails | String | False | 通知邮箱\|客户邮箱（多个用逗号隔开） |
| add_time | String | False | 创建时间（北京时间） |
| io_desc | String | False | 查件需求\|问题描述 |
| it_type_name | String | False | 查件类型名称 |
| commit_time | String | True | 提交时间（北京时间） |
| finish_time | String | True | 完结时间（北京时间） |
| last_handle_time | String | True | 处理时间（北京时间） |
| reply_time | String | True | 回复时间（北京时间） |
| order_code | String | False | 订单号 |
| tracking_no | String | False | 跟踪号 |
| attachment_file_list | Object[] | False | 提交附件，详见InvestigateListAttachmentItemResp数据结构 |
| service_reply_list | Object[] | False | 处理回复信息，详见InvestigateDetailServiceReplyItemResp数据结构 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| handle_result | String | True | 回复结果 |
| handle_user | String | False | 处理人 |
| attachment_file_list | Object[] | False | 详见InvestigateListAttachmentItemResp数据结构 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| name | String | True | 名称 |
| url | String | False | 链接地址 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| order_code | String | True | 订单号 |
| platform | String | True | 销售平台 |
| reference_no | String | True | 参考号 |
| is_return | Int | True | 是否退件
-1:全部 0:否 1:是 |
| sm_name | String | True | 物流方式名称 |
| order_status_text | String | False | 订单状态文本 |
| tracking_number | String | True | 跟踪号 |
| create_type_text | String | True | 订单来源文本 |
| warehouse_code | String | True | 发货仓库编码 |
| fba_shipment_id | String | True | 发货仓库编码 |
| real_weight | String | False | 实际重(KG) |
| real_length | String | False | 实际尺寸(CM) |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| list | Object[] | False | 参见LogisticTicketDetailRecheckAppealInfoItem类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| add_time | String | True | 复查/申诉时间 |
| attachment_file_list | Object[] | True | 申诉附件 参见InvestigateListAttachmentItem类型 |
| io_desc | String | True | 申诉需求 |
| handle_info | Object[] | True | 回复结果 参见InvestigateHandleinfo类型 |
| reply_time | String | True | 回复时间 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| result | String | False | 回复结果信息 |
| attachment_file_list | Object[] | False | 回复附件, 参见InvestigateListAttachmentItem类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| name | String | True | 附件名称 |
| url | String | True | 附件地址 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| list | Object[] | False | 参见LogisticTicketDetailLogInfoItem类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| handle_user | String | True | 附件操作人 |
| io_status_text | String | False | 状态查件状态文本 |
| add_time | String | True | 操作时间 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| io_code_list | String[] | Required | 查件号列表(最多200) | ["io_code1"] | |
| status | Int | Required | 状态枚举值，枚举类型（待变更状态详见下表）
2:待处理 8:已完结 10:废弃 |
2 |
| 变更状态 | 数据值 | 待变更状态条件（枚举） | 说明 |
|---|---|---|---|
| 待处理 | 2 | 1:草稿 11:驳回 |
只允许草稿和驳回状态查件单转为待提交 |
| 已完结 | 8 |
7:已回复
|
只允许已回复状态查件单转为已完结 |
| 废弃 | 10 | 1:草稿 11:驳回 |
只允许草稿，驳回状态查件单转为废弃 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| io_code | String | Required | 查件单号 | ||
| io_desc | String | Required | 300 | 查件需求【5-300字符】 | |
| attachment_id_list | Int[] | Optional | 附件ID数组，最多5个
详情参见附件上传接口 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| warehouse_code | String | Required | 20 | 发货仓库 | USEA |
| dest_warehouse_type | Int | Required | 目的仓类型
1：FBA 2：第三方 |
1 | |
| reference_no | String | Optional | 50 | 参考号 | |
| is_change_label | Int | Required | 换标服务
0：否 1：是 |
||
| label_replacement_option | Int | Optional | 换标要求
换标服务为"是"时必填，否则不传或者传null。 1：外箱 2：内箱 |
||
| is_stick_label | Int | Required | 贴标服务
0：否 1：是 |
||
| order_product_list | object[] | Required | 3000 | 商品明细，参见对象 ProductLines。 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| product_sku | String | Required | 100 | 商品sku | |
| fnsku | String | Optional | 20 | FBA商品编码，当is_change_label=1时必填 | |
| euro_terms_code | String | Optional | 100 | 合规负责人编码
当贴标服务is_stick_label=0时无需填写。
|
|
| quantity | Int | Required | 商品数量 | ||
| change_label_qty | Int | Optional | 换标总数量
当换标要求label_replacement_option=1时无需填写。
|
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 参见PlanOrderCodeResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| plan_order_code | String | False | 计划单号 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| order_status | Int | Optional | 计划单状态
不传或传null：全部 0:废弃 1:草稿 2:异常 3:待配货 4:已完成 |
||
| code_type | int | Optional | 单号类型
1:计划单号（默认） 2:参考号 3:商品编码 4:箱唛号 |
||
| code_value_list | String[] | Optional | 100 | 单号值
用数组传递，最多100个
|
|
| warehouse_code | String | Optional | 20 | 发货仓库 | USEA |
| is_change_label | Int | Optional | 换标服务
0：否 1：是 |
||
| label_replacement_option | Int | Optional | 换标要求
1:外箱 2:内箱 |
||
| is_stick_label | Int | Optional | 贴标服务
0：否 1：是 |
||
| dest_warehouse_type | Int | Optional | 目的仓类型
不传或传null：全部 1:FBA 2:第三方 |
||
| time_type | Int | Optional | 时间类型
0：创建时间 1：提交时间 2：配货时间 |
0 | |
| start_time | String | Optional | 起始时间
若start_time有值，end_time字段也需要有值。
|
2022-03-19 00:00:00 | |
| end_time | String | Optional | 截止时间
若end_time有值，start_time字段也需要有值。
|
2022-03-19 23:59:59 | |
| page | Int | Required | 分页页码 | 1 | |
| page_size | Int | Required | 分页数量
最大200
|
20 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 订单数据，参见 BoxListResp。 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| total | Int | False | 总数量 |
| list | Object[] | False | 计划单信息列表，数组元素详见 OrderItemComposite类型。 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| plan_order_code | String | False | 计划单号 |
| reference_no | String | True | 参考号 |
| warehouse_code | String | False | 区域仓 |
| dest_warehouse_type | Int | False | 目的仓类型
1:FBA 2:第三方 |
| label_replacement_option | Int | False | 换标要求
0:无换标要求 1：外箱 2：内箱 |
| is_change_label | Int | False | 换标服务
0：否 1：是 |
| is_stick_label | Int | False | 贴标服务
0：否 1：是 |
| actual_fee_estimate | String | False | 费用总额 |
| currency_code | String | False | 币种 |
| order_status | Int | False | 状态
0:废弃 1:草稿 2:异常 3:待配货 4:已完成 |
| abnormal_reason | String | True | 异常原因 |
| create_time | String | False | 创建时间 |
| update_time | String | True | 更新时间 |
| submit_time | String | True | 提交时间 |
| finish_time | String | True | 完成时间（配货时间） |
| product_list | Object[] | False | 商品信息，参见 ProductListItem。 |
| box_list | Object[] | True | 暂存箱信息，参见 BoxListItem。 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| product_name | String | False | 商品名称 |
| product_sku | String | False | 商品编码 |
| quantity | Int | False | 商品数量 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| box_no | String | False | 箱号 |
| box_mark | String | False | 箱唛号 |
| quantity | Int | False | 总数量
sku总数量
|
| type_quantity | Int | False | 商品种类
SKU种类的数量，例如有sku1, sku2, 算2个种类
|
| product_list | Object[] | False | 商品信息，参见 ProductListIndividualItem。 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| product_sku | String | False | 商品编码 |
| quantity | Int | False | 商品数量 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| plan_order_code | String | Required | 计划单号 | JH-XXX-20220323-0102 | |
| reason | String | Optional | 100 | 取消原因 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| box_status | Int | Optional | 箱状态
0:可用 1:已用 |
||
| code_type | int | Optional | 单号类型
1:箱唛号（默认） 2:计划单号 3:关联单号 4:商品编码 |
||
| code_value_list | String[] | Optional | 100 | 单号值
用数组传递，最多100个
|
|
| warehouse_code | String | Optional | 20 | 发货仓库 | USEA |
| is_change_label | Int | Optional | 换标服务
0：否 1：是 |
||
| label_replacement_option | Int | Optional | 换标要求
1:外箱 2:内箱 |
||
| is_stick_label | Int | Optional | 贴标服务
0：否 1：是 |
||
| time_type | Int | Optional | 时间类型
1:装箱时间
|
1 | |
| start_time | String | Optional | 起始时间
若start_time有值，end_time字段也需要有值。
|
2022-03-19 00:00:00 | |
| end_time | String | Optional | 截止时间
若end_time有值，start_time字段也需要有值。
|
2022-03-19 23:59:59 | |
| page | Int | Required | 分页页码 | 1 | |
| page_size | Int | Required | 分页数量
最大200
|
20 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 订单数据，参见 BoxListResp。 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| total | Int | False | 总数量 |
| list | Object[] | False | 装箱信息列表，数组元素详见 OrderItemComposite类型。 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| box_no | String | False | 箱唛号 |
| plan_order_code | String | False | 计划单号 |
| relation_order_code | String | False | 关联单号 |
| warehouse_code | String | False | 区域仓 |
| temp_total_amount | String | False | 暂存费用总额 |
| currency_code | String | False | 币种 |
| is_change_label | Int | False | 换标服务
0：否 1：是 |
| label_replacement_option | Int | True | 换标要求
0:无换标要求 1:外箱 2:内箱 |
| is_stick_label | Int | False | 贴标服务
0：否 1：是 |
| euro_terms_code | String | False | 合规负责人编码 |
| box_status | Int | False | 箱状态
0:可用 1:已用 |
| length | String | False | 长 |
| width | String | False | 宽 |
| height | String | False | 高 |
| weight | String | False | 重量 |
| pack_time | String | True | 装箱时间 |
| sku_list | Object[] | False | 商品信息，参见 PlanBoxSkuListItem。 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| fnsku | String | False | FBA商品编码 |
| product_sku | String | False | 商品编码 |
| quantity | Int | False | 商品数量 |
| product_sku_name | String | False | 商品名称 |
| 参数名 | 数据类型 | 是否必填 | 最大数据长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| claim_code | String | Required | 认领单号 |
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| code | Int | 0 成功，其它值表示失败。 |
| message | String | 文本消息 |
| data | Object | 参见ClaimOrderDetailResp类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| asro_code | String | True | 退件单号 |
| claim_code | String | True | 认领单号 |
| tracking_no | String | True | 跟踪号 |
| reference_no | String | True | 参考号 |
| product_list | Object[] | False | 认领单商品信息,参见ProductItemInformation类型 |
| create_time | String | False | 添加时间 |
| claim_time | String | True | 认领时间 |
| customer_code | String | False | 客户代码 |
| expire_disposal_time | String | True | 超期销毁剩余时间 |
| disposal_time | String | True | 销毁时间 |
| internal_info_list | Object[] | False | 商品内件信息,参见InternalProductItemInformation类型 |
| return_pic_url_list | String[] | False | 退货图片列表， 冗余字段，谷仓暂不提供未预报退件的拆包拍照服务 |
| service_type | Int | True | 服务类型，(枚举类型)
1: 退件质检 2: 退件销毁 3: 退件暂存 |
| status | Int | True | 状态，(枚举类型)
1: 待认领 2: 已认领 3: 已销毁 |
| update_time | String | False | 更新时间 |
| warehouse_code | String | True | 退件仓 |
| warehouse_name | String | True | 退件仓中文名称 |
| log_list | Object[] | False | 日志列表，参见ClaimOrderLogItem数据类型 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| ref_product_sku | String | False | 参考商品编码
该参数内容不一定指向商品信息，可能是任何参考信息，可能是包装上的条码,也有可能是sku，等等
|
| quantity | Int | False | 数量 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| product_sku | String | False | 商品编码(sku) |
| quantity | Int | False | 数量 |
| replace_product_sku | String | False | 换标编码 |
| 参数名 | 数据类型 | 可为空 | 说明 |
|---|---|---|---|
| user_name | String | False | 操作人名称 |
| claim_code | String | False | 费用名称 |
| create_time | String | False | 费用名称 |
| type | Int | False | 类型，(枚举类型)
1: 状态 2: 服务类型 3: 退件参考号 4: 内件信息 5: 新增 |
| before | String | False | 之前 |
| after | String | False | 之后 |
| user_code | String | False | 操作人code |
| content | String | False | 日志内容 |
Copyright © 2023 海外仓, All Rights Reserved