1. 物流模块API
1.1. 头程查询接口
post {HTTP(S)地址}/api/{version}/firstLeg
1.1.1. SERVICE_TYPE
QUERY_FIRST_LEG_ORDER_LIST
1.1.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| firstLegNumber | N | String | T987654321 | 头程单号，最大50个字符 |
| status | N | String | NEW | 参见头程状态 |
| updateTimeFrom | N | String | 2021-08-01 | 更新时间（范围开始） |
| updateTimeTo | N | String | 2021-08-31 | 更新时间（范围结束） |
| page | Y | Number | 1 | 页码，默认1 |
| pageSize | Y | Number | 100 | 每页条数.不超过200条; 默认100 |
1.1.3. 返回参数
Base
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| errorCode | Y | String | “DATA_INPUT_ERROR” | 错误码 |
| errorMsg | Y | String | “输入参数不对” | 业务错误信息 |
| state | Y | String | success | 请求结果 |
| total | Y | Number | 100 | 总条数 |
| result | Y | List | 详见FirstLegOrder |
FirstLegOrder 头程
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| firstLegNumber | Y | String | T210824125209 | 头程单号 |
| asnNumber | Y | String | A210824125208 | 入库单号 |
| customNumber | Y | String | X123987 | 参考号 |
| status | Y | String | NEW | 状态 NEW：新建 COMMITTED：已提交 SHIPPING：在途 RECEIVING：收货中 FINISHED：已完成 CLOSED：已关闭 |
| createTime | Y | String | 2021-08-01 00:00:00 | 创建时间 |
| updateTime | Y | String | 2021-08-02 00:00:00 | 更新时间 |
| warehouseName | Y | String | W1 | 出货仓库 |
| destWarehouseName | Y | String | W2 | 目的仓库 |
| portFrom | Y | String | P1 | 出运港口 |
| portTo | Y | String | P2 | 目的港口 |
| buyerTitle | Y | String | 自定义买方抬头 | 买方抬头 |
| logisticsName | Y | String | 物流名称 | 物流方式 |
| carrierName | Y | String | 服务商名称 | 服务商 |
| trackNumber | Y | String | 123456 | 跟踪号 |
| preReceiveTime | Y | String | 2021-08-03 | 预计到货时间 |
| shippingTime | Y | String | 2021-08-03 | 实际出运时间 |
| forwarder | Y | String | 货代信息 | 货代信息 |
| feeList | Y | List<FirstLegFee> | 详见FirstLegOrderFee | |
| skuList | Y | List | 详见 FirstLegOrderSku |
FirstLegOrderFee 费用清单
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| name | Y | String | B200308115691 | 费用名称 |
| amount | Y | String | S200222115613 | 应付金额 |
| appliedAmount | Y | Decimal | 0.1 | 已申请金额 |
| paidAmount | Y | Decimal | 0.1 | 已付金额 |
| invalidAmount | Y | Decimal | 0.1 | 已关闭/作废金额 |
| status | Y | String | NEW | 状态 NEW：新增 APPLIED：已申请 PAID：已付 |
FirstLegOrderSku 头程商品
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| sku | Y | String | B200308115691 | 商品SKU |
| title | Y | String | S200222115613 | 商品名称 |
| expectedQuantity | Y | Number | 1 | 预计数量 |
| receiveQuantity | Y | Number | 1 | 实收数量 |
| packSpecification | Y | Number | 1 | 装箱率 |
| netWeight | Y | Decimal | 1.0 | 净重 |
| weight | Y | Decimal | 1.0 | 毛重 |
| weightUnit | Y | String | KG | 参见重量单位 |
| length | Y | Decimal | 1 | 外箱长 |
| width | Y | Decimal | 1 | 外箱宽 |
| height | Y | Decimal | 1 | 外箱高 |
| dimensionUnit | Y | String | cm | 参见长度单位 |
1.2. 创建头程单
1.2.1. SERVICE_TYPE
CREATE_FIRST_LEG_ORDER
1.2.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| destWarehouseType | Y | String | FBA | FBA/ERSEA 目的仓类型 |
| skuDetailList | Y | List | 见skuDetail |
skuDetail 商品信息
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| lineId | Y | String | 序号 | 正整数0开始，相同相同序号为同单据内容 |
| warehouseName | Y | String | 出货仓库 | |
| destWarehouseName | Y | String | 目的仓库 | |
| logisticsName | Y | String | 物流方式 | |
| customNumber | N | String | 参考号 | |
| portFrom | N | String | 出运港口 | |
| portTo | N | String | 目的港口 | |
| buyerTitle | N | String | 买方抬头 | |
| trackNumber | N | String | 跟踪号 | |
| preReceiveTime | N | String | 2023/10/23 | 预计到货时间 |
| preShipTime | N | String | 2023/10/23 | 预计发货时间 |
| remark | N | String | 单据备注 | |
| containerNumber | N | String | 海运货柜号 | |
| sku | Y | String | 商品SKU | |
| originalAsnNumber | N | String | 入库单号 | |
| preExpectedQuantity | Y | String | 发货数量 | |
| packingRate | N | String | 单箱数量（pcs） | |
| netWeight | N | String | 净重（KG） | |
| length | N | String | 长度（cm） | |
| width | N | String | 宽度（cm） | |
| height | N | String | 高度（cm） | |
| skuRemark | N | String | 商品备注 | |
| fbaNo | Y | String | 货件编号，FBA时必填 | |
| refId | N | String |
1.3. 仓库物流查询接口
1.3.1. SERVICE_TYPE
1.3.2. QUERY_FIRST_LRG_LOGISTICS
1.3.3. 推送消息内容
1.3.4. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| warehouseName | Y | String | 仓库名称 |
1.3.5. 返回参数
Base
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| errorCode | Y | String | “DATA_INPUT_ERROR” | 错误码 |
| errorMsg | Y | String | “输入参数不对” | 业务错误信息 |
| state | Y | String | success | 请求结果 |
| bizContent | Y | List | 详见logisticsInfo |
logisticsInfo
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| id | Y | String | 物流ID | |
| logisticsName | Y | String | 物流名称 |
1.4. 物流跟踪状态变更推送接口
1.4.1. SERVICE_TYPE
1.4.2. PUSH_TRACKING_PACKAGE
1.4.3. 推送消息内容
Base
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| orderNumber | Y | String | “S230109129883” | 系统单号 |
| onlineOrderId | Y | String | xsasx | 线上订单号 |
| trackingNumber | Y | String | 运单号 | 11111 |
| carrier | Y | String | 承运商 | LEX TH |
| status | Y | String | CREATED | 状态枚举 |
1.5. 物流状态查询接口
1.5.1. SERVICE_TYPE
QUERY_FIRST_LRG_TRACKING_PACKAGE
1.5.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| updateTimeFrom | N | String | 2021-08-01 00:00:00 | 更新时间（范围开始），查询范围不超过31天 |
| updateTimeTo | N | String | 2021-08-31 00:00:00 | 更新时间（范围结束），查询范围不超过31天 |
| orderNumbers | N | List | ["111111","22222"] | 订单号集合，不超过200个 |
| onlineOrderIds | N | List | ["111111","22222"] | 线上单号集合，不超过200个 |
| trackingNumbers | N | List | ["111111","22222"] | 物流跟踪号集合，不超过200个 |
| returnDetails | N | boolean | true | 是否返回物流详情，默认false |
| page | Y | Number | 1 | 页码，默认1 |
| pageSize | Y | Number | 100 | 每页条数.不超过200条; 默认100 |
1.5.3. 返回参数
Base
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| errorCode | Y | String | “DATA_INPUT_ERROR” | 错误码 |
| errorMsg | Y | String | “输入参数不对” | 业务错误信息 |
| state | Y | String | success | 请求结果 |
| bizContent | Y | String | json | 详见PageData |
PageData
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| result | Y | String | 详见TrackingPackage | |
| total | Y | number | 5 | 总条数 |
TrackingPackage
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| orderNumber | Y | String | “S230109129883” | 系统单号 |
| onlineOrderId | Y | String | xsasx | 线上订单号 |
| trackingNumber | Y | String | 运单号 | 11111 |
| carrier | Y | String | 承运商 | LEX TH |
| status | Y | String | CREATED | 状态枚举 |
| eventList | N | List | 物流详情，详见Event |
Event
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| eventDate | Y | number | 事件时间戳 | 1706011481000 |
| event | Y | String | 事件 | |
| timeZoneId | Y | String | Asia/Manila | 时区 |