创建订单

POST

对接系统的域名/api/createOrder

旧接口： /api/createTOrder

请求参数

Header 参数

Authorization

string

必需

默认值:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJkYXRlIjoxNzExMjg3NzUyNjE5LCJ0b2tlbiI6IjRlNTQzMDZhNDdhNGY3NGQ0YjZiN2VhOTlmNDZjMDhjIn0.q7cqP3xlSG1xY1WdTGO33u5z0fwpT3pxVeweX6EHgxnZCgtqWUpph6xZn6tt4KjYJoYOvFZ-1tDMbwXtEXDy1w

Body 参数application/json

orderData

object

数据

可选

toStatus

integer

提交状态

必需

0:草稿 1:预报;

channel

string

下单渠道编码

可选

customerNo

string

客户参考号

可选

senderCode

string

寄件人编码

可选

设置系统已备案的寄件人地址，与寄件人信息二选一

sender

object

寄件人信息

可选

recipient

object

收件人信息

可选

volumeList

array [object {6}]

材积信息

可选

itemList

array [object {18}]

物品申报信息

可选

labelMemo

string

面单备注

可选

部分渠道支持面单显示，具体请与系统方确认。

measurementUnit

string

计量单位

可选

MM：公制，kg/cm；BSW：英制，lbs/inch。默认公制，提交英制信息前请联系系统管理员确认是否开启英制计量单位

signature

string

签名方式

可选

no：不需签名；normal：普通签名；adult：成人签名。默认不签名

goodType

string

货物类型

可选

WPX：包裹；DOC：文件；PAK：PAK袋。默认包裹

declareType

string

报关方式

可选

通过系统基础数据接口查询值

saleTerm

string

销售条款

可选

通过系统基础数据接口查询值

exportReason

string

出口原因

可选

通过系统基础数据接口查询值

insureType

string

保险类型

可选

通过系统基础数据接口查询值

productType

string

物品类别

可选

通过系统基础数据接口查询值

insureCost

number

保险金额

可选

freightCost

number

运费

可选

otherCost

number

杂费

可选

declareCost

number

申报价值合计

可选

declareCurrency

string

申报币别

可选

taxPayType

string

税金支付方式

可选

PP：预付；CC：到付；TP：第三方付

taxPayAccount

string

税金支付账号

可选

freightPayType

string

运费支付方式

可选

PP：预付；CC：到付；TP：第三方付

freightPayAccount

string

运费支付账号

可选

orderNote

string

内部备注

可选

trackNo

string

物流商单号

可选

物流商单号。针对Y2模式，下单推送服务商单号给系统，系统版本20250526以上

base64Label

string

物流标签

可选

物流标签PDF文件转成的Base64字符串。针对Y2模式，下单推送服务商面单给系统，系统版本20250526以上

示例

{
    "orderData": {
        "channel": "U2",
        "customerNo": "15880004",
        "trackNo": "",
        "labelMemo":"测试备注",
        "sender": {
            "name": "寄件人",
            "country": "US",
            "province": "NV",
            "city": "HENDERSON",
            "zipcode": "89044-8746",
            "tel": "18132831856",
            "phone": "18138158243",
            "company": "velit cupidatat non laboris tempor",
            "address1": "commodo adipisicing",
            "address2": "sed dolor sit fugiat"
        },
        "recipient": {
            "name": "收件人",
            "country": "US",
            "province": "NV",
            "city": "HENDERSON",
            "zipcode": "89044-8746",
            "company": "adipisicing amet incididunt",
            "tel": "18171313776",
            "phone": "18148739909",
            "address1": "dolore consectetur",
            "address2": "ut cillum tempor"
        },
        "volumeList": [
            {
                "boxLength": 11,
                "boxWidth": 63,
                "boxHeight": 57,
                "boxWeight": 58,
                "customerNo": "1"
            }
        ],
        "toStatus": 1,
        "itemList": [
            {
                "cnName": "产品中文",
                "enName": "产品英文",
                "customsCode": "74",
                "num": 19,
                "price": 76,
                "priceCurrency": "USD"
            }
        ]
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '对接系统的域名/api/createOrder' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orderData": {
        "channel": "U2",
        "customerNo": "15880004",
        "trackNo": "",
        "labelMemo":"测试备注",
        "sender": {
            "name": "寄件人",
            "country": "US",
            "province": "NV",
            "city": "HENDERSON",
            "zipcode": "89044-8746",
            "tel": "18132831856",
            "phone": "18138158243",
            "company": "velit cupidatat non laboris tempor",
            "address1": "commodo adipisicing",
            "address2": "sed dolor sit fugiat"
        },
        "recipient": {
            "name": "收件人",
            "country": "US",
            "province": "NV",
            "city": "HENDERSON",
            "zipcode": "89044-8746",
            "company": "adipisicing amet incididunt",
            "tel": "18171313776",
            "phone": "18148739909",
            "address1": "dolore consectetur",
            "address2": "ut cillum tempor"
        },
        "volumeList": [
            {
                "boxLength": 11,
                "boxWidth": 63,
                "boxHeight": 57,
                "boxWeight": 58,
                "customerNo": "1"
            }
        ],
        "toStatus": 1,
        "itemList": [
            {
                "cnName": "产品中文",
                "enName": "产品英文",
                "customsCode": "74",
                "num": 19,
                "price": 76,
                "priceCurrency": "USD"
            }
        ]
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态编码

可选

参考对接需知状态码

message

string

返回信息

可选

data

object

响应数据

必需

orderNo

string

订单号

必需

下单成功后，需要保存该单号，后续接口交互需要使用

customerNo

string

客户单号

可选

trackNo

string

物流商单号

可选

可能需要异步获取

costList

object

预报费用明细

可选

预报扣费成功将返回扣费信息。无费用返回需调用查询订单接口获取订单扣费

trackStatus

integer

物流商状态

必需

可根据这个字段标志决定是否同步还是异步获取
0:获取成功，可立刻调用打印标签接口获取标签和物流单号
1：异步获取，预计时间30s后可调用打印标签接口获取标签和物流单号

downLabelUrl

string

物流标签下载地址

可选

拼接了系统域名的完整的物流标签下载地址，系统版本20250626以上新增

base64Label

string

base64标签

可选

标签转base64的字符，系统版本20250626以上新增

invoiceLabel

string

发票文件

可选

可选，部分渠道支持

copyLabel

string

copy联

可选

可选，部分渠道支持

childLabelList

array [object {3}]

子单标签

必需

可选，部分渠道支持

示例

{
    "code": 0,
    "message": "string",
    "data": {
        "orderNo": "string",
        "customerNo": "string",
        "trackNo": "string",
        "costList": {
            "costName": "string",
            "cost": 0,
            "currency": "string"
        },
        "trackStatus": 0,
        "downLabelUrl": "string",
        "base64Label": "string",
        "invoiceLabel": "string",
        "copyLabel": "string",
        "childLabelList": [
            {
                "boxNo": "string",
                "trackNo": "string",
                "labelUrl": "string"
            }
        ]
    }
}

修改于 2025-06-26 10:26:17

费用试算

取消订单