新增订单

POST

/api/customer/operation/createOrder

请求参数

Header 参数

apiKey

string

API授权码

必需

默认值:

5ff6e6a70376ba11a42e277086598d4a

signature

string

签名

必需

默认值:

4590A48221F34CE299EA2D74036246F5

timestamp

string

请求时间戳

必需

默认值:

1717381423

sourceFrom

enum<string>

必需

平台标识，传拼音。（例如：领星：lingxing、易仓：yicang、店小秘：dianxiaomi、旺店通：wangdiantong、积加：jijia、千易：qianyi、赛狐：saihu、自研ERP：ziyan 等等...）

枚举值:

lingxingyicangdianxiaomiwangdiantongjijiaqianyisaihuziyan

默认值:

lingxing

Body 参数application/json

isMultiPack

string

是否一单多（默认为N）包

必需

warehouseCode

string

仓库编码

必需

channelCode

string

渠道编码

必需

PS：如果渠道为客户自提，则渠道编码为Upload_Shipping_Label

frtTrackNumber

string

物流追踪号

可选

PS：如果渠道为客户自提，则该字段需必填。

customerOrderNo

string

客户订单号

必需

platform

string

销售平台

可选

platformOrderId

string

平台订单号

可选

remark

string

可选

consigneeCCode

string

收件人国家简码

必需

consigneeProvince

string

收件人省州

必需

consigneeCity

string

收件人城市

必需

consigneeZipcode

string

收件人邮编

必需

consignee

string

收件人

必需

consigneeTelephone

string

收件人联系电话

必需

consigneeEmail

string

收件人邮箱

可选

consigneeTaxId

string

收件人税号

可选

consigneeHouseNumber

string

收件人门牌号

可选

consigneeAddress

string

收件人详细地址

必需

consigneeAddress2

string

收件人详细地址2

可选

consigneeAddress3

string

收件人详细地址3

可选

onlineLabelUrl

string

面单URL地址

可选

面单地址必须是以http或https开头的，且不能超过500个字符。
PS：如果渠道为【自提包裹】，则该字段需必填！！！

carrier

string

物流承运商

可选

PS：支持选项 UPS、USPS、FEDEX、DHL、Other

signatureService

string

签名服务

可选

PS：支持选项：直接签名、间接签名、成人签名

tWmsOrderHscodeList

array [object {5}]

SKU信息

必需

skuCode

string

SKU编码

必需

tradeNameCn

string

中文品名

可选

tradeNameEn

string

英文品名

可选

quantity

string

数量

必需

price

integer

申报单价

可选

示例

{
    "isMultiPack": "N",// 是否一单多包
    "warehouseCode": "wh",// 仓库编码
    "channelCode": "US-POSTAL-S",// 渠道编码
    "frtTrackNumber": "FRT1122",// 物流追踪号
    "customerOrderNo": "CUS20240601-1",// 客户订单号
    "platform": "",// 销售平台
    "platformOrderId": "",//平台订单号
    "remark": "zheshibeizhu",
    "insuranceAmount": "",
    "consignee": "jack",
    "consigneeCCode": "US",// 收件人国家简码
    "consigneeProvince": "CA",//收件人省州
    "consigneeCity": "San Francisco",//收件人城市
    "consigneeZipcode": "94102",// 收件人邮编
    "consigneeAddress": "San",// 收件人详细地址
    "consigneeTelephone": "13822222323",// 收件人联系电话
    "onlineLabelUrl":"http://labelurl2334455667", //面单URL地址
    "carrier":"UPS",//物流承运商
    "signatureService":"",//签名服务
    "tWmsOrderHscodeList": [// SKU信息
        {
            "skuCode": "4580796976186",// SKU编码
            "tradeNameCn": "便携式电子烟",// 中文品名
            "tradeNameEn": "ROO POD(3 PODS)",// 英文品名
            "quantity": "1",// 数量
            "price": 20 // 申报单价
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://192.168.8.18:3080/api/customer/operation/createOrder' \
--header 'apiKey;' \
--header 'signature;' \
--header 'timestamp;' \
--header 'sourceFrom;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "isMultiPack": "N",// 是否一单多包
    "warehouseCode": "wh",// 仓库编码
    "channelCode": "US-POSTAL-S",// 渠道编码
    "frtTrackNumber": "FRT1122",// 物流追踪号
    "customerOrderNo": "CUS20240601-1",// 客户订单号
    "platform": "",// 销售平台
    "platformOrderId": "",//平台订单号
    "remark": "zheshibeizhu",
    "insuranceAmount": "",
    "consignee": "jack",
    "consigneeCCode": "US",// 收件人国家简码
    "consigneeProvince": "CA",//收件人省州
    "consigneeCity": "San Francisco",//收件人城市
    "consigneeZipcode": "94102",// 收件人邮编
    "consigneeAddress": "San",// 收件人详细地址
    "consigneeTelephone": "13822222323",// 收件人联系电话
    "onlineLabelUrl":"http://labelurl2334455667", //面单URL地址
    "carrier":"UPS",//物流承运商
    "signatureService":"",//签名服务
    "tWmsOrderHscodeList": [// SKU信息
        {
            "skuCode": "4580796976186",// SKU编码
            "tradeNameCn": "便携式电子烟",// 中文品名
            "tradeNameEn": "ROO POD(3 PODS)",// 英文品名
            "quantity": "1",// 数量
            "price": 20 // 申报单价
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

success

boolean

成功标志

必需

code

integer <int32>

返回代码

必需

message

string

返回处理消息

必需

result

object

返回数据对象

必需

data

object

实际数据对象

必需

timestamp

integer <int64>

时间戳

必需

示例

成功示例成功示例

{
    "success": true,
    "message": "操作成功！",
    "code": 200,
    "result": {
        "data": {
            "trackNumber": "WTSUS0000940384YQ",
            "frtTrackNumber": "6AH00191847323",
            "preShippingFee": "98.8"
        }
    },
    "timestamp": 1717125145449
}

🟢200成功（重复推送订单）

🟢200失败（但会创建草稿订单）

修改于 2024-11-27 03:13:59

入库详情

取消订单