GET /open/api/v1/orders/:id/logistics
鉴权:接入方后台 HMAC
调用方:接入方后台
功能描述
按小鹅订单号或接入方订单号读取当前运单和轨迹。轨迹来自小鹅已经同步的物流记录。没有发货时 shipments 为空数组。
参数
路径参数
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
id | string | 是 | 小鹅订单号或接入方订单号。 |
返回值
成功时 code 为 0,下面的字段在 data 里。
Object data
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
order_no | string | 是 | 小鹅订单号。 | |
partner_order_no | string | 否 | 接入方订单号。 | |
shipments | Array.<Object> | 是 | 运单列表。没有发货时为空数组。 |
Object shipments
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
tracking_no | string | 是 | 运单号。 | |
express_company | string | 否 | 物流公司名称。 | |
express_code | string | 否 | 物流公司编码。 | |
shipment_status | string | 是 | 运单状态。 | |
shipped_at | string | 否 | 发货时间。 | |
received_at | string | 否 | 签收时间。 | |
events | Array.<Object> | 是 | 轨迹节点。没有轨迹时为空数组。 |
Object events
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
time | string | 是 | 节点时间。 | |
status | string | 是 | 节点状态。 | |
desc | string | 是 | 节点说明。 | |
provider | string | 否 | 轨迹来源。 |
示例代码
curlbash
# 先设置 CHANNEL_ACCESS_KEY、CHANNEL_SECRET_KEY,并按接口说明计算 signature
curl --request GET 'https://api.channel.suiinn.com/open/api/v1/orders/YD202601010001/logistics' \
--header 'X-Channel-Key: $CHANNEL_ACCESS_KEY' \
--header 'X-Channel-Timestamp: $timestamp' \
--header 'X-Channel-Nonce: $nonce' \
--header 'X-Channel-Signature: $signature'