开放平台接口文档
目录

预报订单

POST /order/create

注意

预报订单时，平台会根据用户提供的商家单号 order_no 生成唯一的系统单号platform_no

# 请求参数

请求参数列表：

参数名称 类型（限制） 必须 描述 示例
order_no String(限5-32位字符) 是 商家单号 TESTJ238424GSD
service_code String(限50位字符) 是 物流服务代码（请在平台系统API接口查看） Ground_UPS
sender.name String(限32位字符) 是 发件人全名 Tom
sender.company String(限32位字符) 是 发件人公司名称 Lineage Logistics
sender.country String(限16位字符) 是 发件人国家 US
sender.state String(限20位字符) 是 发件人州/省 CA
sender.city String(限32位字符) 是 发件人城市 Bell
sender.address Array[String]
(地址1限48位字符，地址2限40位字符)		 是 发件人地址 ['5660 Lindbergh Ln', '']
sender.phone String(限16位字符) 是 发件人电话 1234567890
sender.zipcode String(限5位或10位) 是 发件人邮编 12201
recipient.name String(限32位字符) 是 收件人全名 Jack
recipient.company String(限32位字符) 是 收件人公司名称 XPO Logistics Inc.
recipient.country String(限16位字符) 是 收件人国家 US
recipient.state String(限20位字符) 是 收件人州/省 CA
recipient.city String(限32位字符) 是 收件人城市 Thousand Palms
recipient.address Array[String]
(地址1限48位字符，地址2限40位字符)		 是 收件人地址 ['31793 Sierra Del Sol','']
recipient.phone String(限16位字符) 是 收件人电话 1234567890
recipient.zipcode String(限5位或10位) 是 收件人邮编 94501-12345
package.dimensions.length Number(限0-999.999，精确到小数点后三位) 是 包裹尺寸长(英寸) 1.158
package.dimensions.width Number(限0-999.999，精确到小数点后三位) 是 包裹尺寸宽(英寸) 1.158
package.dimensions.height Number(限0-999.999，精确到小数点后三位) 是 包裹尺寸高(英寸) 1.158
package.dimensions.weight Number(限0-999.999，精确到小数点后三位) 是 包裹重量(磅) 8.160
package.dimensions.sku String(限32位字符) 否 包裹内产品SKU abcd
package.dimensions.quantity Number(限1-999，整型) 否 包裹内产品数量 20
package.dimensions.insurance_value Number(限16位数字，精确到小数点后两位) 否 保险金额（部分服务不支持，请在我的账号-API接口查看）
大于100美金生效		 0
signature_type Number(限1位数字) 否 签名服务（仅支持部分服务代码）
0: 无签名
1: AdultSignature
2: DirectSignature
3: IndirectSignature		 0
remark String(限30位字符) 否 备注（英文符号、空格占用1个字符长度） 面单上显示 test remark
allow_duplicate_order （已弃用） Boolean 否 是否允许相同商家单号
false 不允许（默认）
true 允许		 false

注意

本接口的 allow_duplicate_order 字段已弃用，已变更为手动控制，可以在用户中心的 API接口 中修改配置



完整请求body示例：

{
    "order_no": "TESTJ238424GSD",
    "service_code": "USPS001",
    "sender": {
        "name": "Tom",
        "company": "Kevin Lineage Logistics",
        "country": "US",
        "state": "CA",
        "city": "Bell",
        "address": [
            "56** Lindbergh Ln",
            ""
        ],
        "zipcode": "90201",
        "phone": "765****391"
    },
    "recipient": {
        "name": "Jack",
        "company": "XPO Logistics Inc.",
        "country": "US",
        "state": "CA",
        "city": "Thousand Palms",
        "address": [
            "31** Sierra Del Sol",
            ""
        ],
        "zipcode": "92276-3195",
        "phone": "765****391"
    },
    "package": {
        "dimensions": [
            {
                "width": 1.158,
                "height": 1.158,
                "length": 1.158,
                "weight": 8.160,
                "sku": "abcd",
                "quantity": 20,
                "insurance_value": 0
            }
        ]
    },
    "remark": "SW0012600862",
    "signature_type": "0",
    "allow_duplicate_order": false
}

# 返回信息

接口返回预报订单结果的json数据。

# 预报成功

其中code等于200时表示订单预报成功，可在获取面单接口查询到信息。

响应参数列表：

参数名称 描述
platform_no 系统单号 (获取面单状态信息使用)
order_no 商家单号
service 当前服务名称
time 下单时间
price 订单预收费用
currency 费用币种
price_detail 订单预收费用详情

注意

请保存好请求成功后得到的 platform_no，系统单号是获取面单信息的必须字段。

完整响应数据示例：

{
    "code": 200,
    "msg": "success",
    "data": {
        "platform_no": "PQEOQhiuW6a",
        "order_no": "TESTJ238424GSD",
        "service": "USPS001",
        "time": "2020-01-01 16:11:25",
        "price": 3.61,
        "currency": "USD",
        "price_detail": "运费:3.08,燃油费:0.29,处理费:0.06,附加费:0.18"
    }
}

# 请求失败

如果返回的json数据中，code等于100时表示预报订单失败。

完整响应数据示例：

// 请求响应失败
{
    "code": 100,
    "msg": "订单创建失败，XXX参数错误",
    "data": []
}
返回信息代码含义
获取面单

← 获取面单→