开放平台接口文档
  • 基础

    • 调用方法
    • 关于鉴权
    • 业务建议
    • 文字符号
    • 返回信息代码含义
  • 物流接口

    • 预报订单
    • 获取面单
    • 费用查询
    • 取消订单
    • 批量取消订单
    • 订单轨迹
    • 预上网推送
    • 获取订单列表
      • 请求参数
      • 返回信息
    • 获取用户信息
    • 获取物流服务列表
  • 仓库接口

    • 出库业务流程
    • 创建出库订单
    • 获取出库订单
    • 获取仓库列表
    • 拦截出库订单
    • 获取库存信息
    • 入库业务流程
    • 创建商品
    • 更新商品
    • 获取商品列表
    • 创建入库订单
    • 取消入库订单
    • 获取入库订单
    • 获取箱唛文件
目录

获取订单列表

POST /order/getlist

# 请求参数

请求参数列表:

参数名称 必须 类型(限制) 描述 示例
since 否 String(限19位字符) 查询的起始时间 2020-01-01 00:00:00
status 否 Number(限1位数字) 运单状态
0: 草稿 1: 订单创建中 2: 已列印 3: 取消中 4: 已取消 5: 作废 6: 异常
0
limit 否 Number(限1-300整数) 分页最大显示数 默认50 50
page 否 Number(限大于1整数) 分页数,默认1 1

完整请求body示例:

{
    "since": "2020-01-01 00:00:00",
    "status": "1",
    "limit": 50,
    "page": 1
}

# 返回信息

响应参数列表:

参数名称 描述
platform_no 平台订单号
order_no 商家单号
tracking_no 运单号
tracking_nos 所有运单号
label_url 面单地址(完整URL地址示例:API网关/example/93002******.pdf)
label_size 面单格式
create_time 创建时间
print_time 生成时间
remark 备注
price 总费用
price_detail 总费用详情
zone 区号
pws_status 订单状态
0: 草稿 1: 订单创建中 2: 已列印 3: 取消中 4: 已取消 5: 作废 6: 异常
packages 包裹信息json
service_code 服务代码
address_type 收件人地址类型 commercial:商业, residential:住宅

完整响应数据示例:

{
    "code": 200,
    "msg": "success",
    "data": [
        {
            "platform_no": "PQEOQhiuW6a",
            "order_no": "TEST001",
            "tracking_no": "",
            "tracking_nos": null,
            "label_url": "",
            "label_size": "4*6",
            "create_time": "2021-01-05 11:17:20",
            "print_time": null,
            "remark": "TEST",
            "price": "0.000",
            "price_detail": "",
            "zone": 0,
            "pws_status": 0,
            "packages": "[{\"length\":\"6\",\"width\":\"7\",\"height\":\"8\",\"weight\":0.25},{\"length\":\"6\",\"width\":\"7\",\"height\":\"8\",\"weight\":2.0625},{\"length\":\"6\",\"width\":\"7\",\"height\":\"8\",\"weight\":2.0625},{\"length\":\"6\",\"width\":\"7\",\"height\":\"8\",\"weight\":2.0625}]",
            "service_code": "USPSAZ",
            "address_type": "residential"
        },
        {
            "platform_no": "PQEOQhiuW6a",
            "order_no": "TEST002",
            "tracking_no": "93001109230002********",
            "tracking_nos": "[\"93001109230002********\"]",
            "label_url": "/example/93001109230002********.pdf",
            "label_size": "4*6",
            "create_time": "2021-01-05 11:17:19",
            "print_time": "2021-01-05 11:17:22",
            "remark": "TEST",
            "price": "3.61",
            "price_detail": "运费:3.08,燃油费:0.29,处理费:0.06,附加费:0.18",
            "zone": 8,
            "pws_status": 2,
            "packages": "[{\"length\":\"8\",\"width\":\"7\",\"height\":\"8\",\"weight\":\"3\"}]",
            "service_code": "USPSAZ",
            "address_type": "commercial"
        }
    ]
}
预上网推送
获取用户信息

← 预上网推送 获取用户信息→

  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式