Api对接文档
  1. 外部API
Api对接文档
  • 外部API
    • 用户登录
      POST
    • 获取用户发货地址列表
      GET
    • 获取用户的产品信息
      GET
    • 订单费用试算
      POST
    • 异步创建订单
      POST
    • 重新下单
      POST
    • 获取订单详情
      GET
    • 取消订单
      DELETE
    • 创建交运清单
      POST
    • 获取历史 scanform 列表
      GET
  1. 外部API

异步创建订单

POST
/external/orders/async
该接口为异步下单接口,下单之后不会立即返回面单地址和面单号,需要通过订单详情异步获取,建议获取间隔在1s以上。产品代码如果不填,系统会自动计算最优价格产品下单。

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Body 参数application/json

示例
[
    {
        "customerOrderNo": "string",
        "notes": "string",
        "productCode": "string",
        "consigneeName": "string",
        "consigneeCompanyName": "string",
        "consigneeStateOrProvince": "string",
        "consigneeCity": "string",
        "consignessArea": "string",
        "consigneeAddress1": "string",
        "consigneeAddress2": "string",
        "consigneeAddress3": "string",
        "consigneePostCode": "string",
        "consigneePhone": "string",
        "shipperAddressId": 0,
        "signatureService": "ASS",
        "insuredValue": 0,
        "sizeWeightUnit": "MET",
        "boxes": [
            {
                "no": "string",
                "weight": "string",
                "length": "string",
                "width": "string",
                "height": "string",
                "skus": [
                    {
                        "chineseName": "string",
                        "englishName": "string",
                        "quantity": 0,
                        "sku": "string"
                    }
                ]
            }
        ]
    }
]

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/external/orders/async' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "customerOrderNo": "string",
        "notes": "string",
        "productCode": "string",
        "consigneeName": "string",
        "consigneeCompanyName": "string",
        "consigneeStateOrProvince": "string",
        "consigneeCity": "string",
        "consignessArea": "string",
        "consigneeAddress1": "string",
        "consigneeAddress2": "string",
        "consigneeAddress3": "string",
        "consigneePostCode": "string",
        "consigneePhone": "string",
        "shipperAddressId": 0,
        "signatureService": "ASS",
        "insuredValue": 0,
        "sizeWeightUnit": "MET",
        "boxes": [
            {
                "no": "string",
                "weight": "string",
                "length": "string",
                "width": "string",
                "height": "string",
                "skus": [
                    {
                        "chineseName": "string",
                        "englishName": "string",
                        "quantity": 0,
                        "sku": "string"
                    }
                ]
            }
        ]
    }
]'

返回响应

🟢200成功
application/json
创建订单成功返回结果
Body

示例
[
    {
        "customerNo": "string",
        "orders": [
            {
                "orderNo": "string",
                "sellingPrice": "string",
                "status": "PENDING (已经存入数据库,准备出单)",
                "failReason": "string"
            }
        ]
    }
]
🟠400请求有误
🔴500服务器错误
修改于 2025-09-30 07:35:40
上一页
订单费用试算
下一页
重新下单
Built with