获取面单
GET /order/label
# 请求参数
请求参数列表:
参数名称 | 必须 | 描述 |
---|---|---|
platform_no | 是 | 系统单号 |
?platform_no=PQEOQhiuW6a
# 返回信息
接口返回订单查询结果的json数据
如果pws_status=1
表示订单正在创建中,pws_status=2
时返回运单号和面单地址。
响应参数列表:
参数名称 | 描述 |
---|---|
platform_no | 系统单号/平台订单号 |
order_no | 商家单号 |
pws_status | 运单状态 0: 草稿 1: 订单创建中 2: 已生成 3: 取消中 4: 已取消 5: 作废 6: 异常 |
service | 当前服务名称 |
price | 订单预收费用 |
currency | 费用币种 |
price_detail | 订单预收费用详情 |
logistics_company | 物流公司 |
zone | 区号 |
tracking_no | 运单号 |
tracking_nos | 所有运单号json |
label_url | 面单地址(完整URL地址示例:API网关/example/93002******.pdf) |
address_type | 收件人地址类型 commercial:商业, residential:住宅 |
packages.length | 包裹尺寸长(英寸) |
packages.width | 包裹尺寸宽(英寸) |
packages.height | 包裹尺寸高(英寸) |
packages.weight | 包裹重量(磅) |
packages.sku | 包裹中包含的SKU |
packages.quentity | 包裹中标记的SKU数量 |
packages.tracking_number | 包裹运单号 |
完整响应数据示例:
- 订单创建中,此时需要用
异步/循环
的方法来继续请求此接口,确认运单状态pws_status
。
{
"code": 100,
"msg": "订单创建中",
"data": {
"platform_no": "PQEOQhiuW6a",
"order_no": "TESTJ238424GSD",
"pws_status": 1,
"address_type": "commercial"
}
}
- 运单创建成功。
{
"code": 200,
"msg": "success",
"data": {
"platform_no": "PQEOQhiuW6a",
"order_no": "TESTJ238424GSD",
"pws_status": 2,
"service": "USPS001",
"price": 3.61,
"currency": "USD",
"price_detail": "运费:3.08,燃油费:0.29,处理费:0.06,附加费:0.18",
"logistics_company": "USPS",
"zone": 8,
"tracking_no": "93001109230002********",
"tracking_nos": "[\"93001109230002********\", \"93001109230002********\"]",
"label_url": "/example/93001109230002********.pdf",
"address_type": "commercial",
"packages": [
{
"length": 0.79,
"width": 0.79,
"height": 0.79,
"weight": 1,
"sku": "",
"quentity": 0,
"tracking_number": "93001109230002********"
}
]
}
}