元仓开放平台

订单新增

POST

/api/openPlatform/order/add

状态码

状态码	描述
000001	成功
000400	请求失败，详细见描述（msg）
000401	鉴权失败 (token已过期或者token无效)
000403	无权限访问
000405	请求方法不允许
000422	请求数据异常
000429	请求太频繁
000500	程序内部错误
011001	sku库存不足
011002	存在已锁定库存的sku
011003	订单已存在

请求参数

Header 参数

Authorization

string

必需

例: Bearer 2296|M9DlZJI54pxcbdtdapSOy4wNkzYKijw5jpjJIhS7

默认值:

Bearer {{token}}

Content-Type

string

必需

默认值:

application/json

Body 参数application/json

customerOrderSn

string

客户订单号(唯一)

必需

限制50个字符

platformOrderId

string

平台订单号

可选

限制50个字符
tiktok平台订单必填

platformCode

string

平台code

可选

outboundType="2-10" 必填点我查看平台code

shopName

string

店铺名称

可选

限制50个字符
outboundType="2-10" 必填

shopAlias

string

店铺别名

可选

限制50个字符

siteCode

string

站点code

可选

填国家二字码，如马来西亚的国家二字码 MY
outboundType="2-10" 必填

currency

string

币种

可选

默认CNY，更多币种见

totalAmount

number

订单总金额

可选

两位小数

payTime

string

付款时间(UTC+8)

可选

格式：Y-m-d H:i:s

createTime

string

下单时间(UTC+8)

可选

格式：Y-m-d H:i:s
tiktok平台订单必填

buyerId

string

买家id

可选

限制50个字符

warehouseCode

string

发货仓库

必需

isCod

integer

是否货到付款订单

可选

1是0否,默认0 元仓线下渠道业务层面不支持COD，元仓不做线下收款

outboundType

string

出库类型

可选

可用值：
2-10销售订单出库（默认）
2-170赠送出库
2-200报销出库
2-210样品出库
2-220发货出库
2-140其他出库

packageId

string

平台订单package_id

可选

限制50个字符
对应tiktok /order/202309/orders 接口中的line_items.package_id字段，点我跳转到平台接口文档
tiktok平台订单必填

shippingProviderName

string

平台订单shipping_provider_name

可选

限制255个字符
对应tiktok /order/202309/orders 接口中的shipping_provider字段，点我跳转到平台接口文档
tiktok平台订单必填

shippingProviderId

string

平台订单shipping_provider_id

可选

限制50个字符
对应tiktok /order/202309/orders 接口中的shipping_provider_id字段，点我跳转到平台接口文档
tiktok平台订单必填

isCrossBorder

integer

是否跨境订单

可选

1是0否,默认0。tiktok平台订单必填（跨境店铺海外仓发的订单为跨境订单）

address

object

收件信息

必需

logistics.channelType=2是必须按照元仓给的地址库准确填写,否则无法正常获取到物流单号

name

string

收件人

可选

限制255个字符
logistics.channelType=2 必填

phone

string

电话

可选

限制100个字符
logistics.channelType=2 必填

state

string

州/省

可选

限制100个字符
logistics.channelType=2 必填

city

string

城市

可选

限制100个字符
logistics.channelType=2 必填

district

string

区

可选

限制100个字符
logistics.channelType=2 必填

zipcode

string

邮编

可选

限制100个字符
logistics.channelType=2 必填

fullAddress

string

详细地址

可选

限制1000个字符
完整的收货地址(包括国家、州/省、城市),logistics.channelType=2 必填

email

string

email

可选

限制50个字符

logistics

object

物流信息

可选

outboundType="2-10" 必填

channelCode

string

渠道code

必需

限制255个字符
1.如果是线下渠道发货，请准确填写元仓的渠道编码
2.如果是平台线上渠道发货，可以填写匹配的元仓编码，可以填写平台的买家自选物流。买家自选物流请确填写准确，以免影响仓库分拣揽收

更多channelCode见

channelType

integer

渠道类型

可选

可用值:1:线上,2:线下默认1

trackingNumber1

string

追踪码1

可选

限制32个字符
channelType=1 必填

trackingNumber2

string

追踪码2

可选

限制32个字符

labelUrl1

string

面单地址1

可选

限制500个字符
channelType=1 必填

labelUrl2

string

面单地址2

可选

限制500个字符

labelType

string

面单类型

可选

可用值：pdf ，channelType=1 必填

labelSize

integer

面单尺寸

可选

可用值:1:100150,2:100100,3:A4,4:A5 channelType=1 必填

labelDirection

integer

面单指向

可选

可用值:1竖向,2横向 channelType=1 必填

freight

number

物流运费

可选

两位小数

shipByDate

string

最晚发货时间(UTC+8)

可选

格式：Y-m-d H:i:s

skuList

array [object {4}]

必需

customerSku

string

客户sku

必需

限制50个字符

quantity

integer

数量

必需

sellerPrice

number

售价(单价)

可选

skuId

string

平台sku_id

可选

限制50个字符
对应tiktok /order/202309/orders 接口中的line_items.sku_id字段，点我跳转到平台接口文档
tiktok平台订单必填

示例

{
    "platformCode": "SE",
    "shopName": "kokoye",
    "siteCode": "MY",
    "customerOrderSn": "SE2208222012110004113",
    "warehouseCode": "001",
    "address": {
        "name": "才体将及调济",
        "phone": "18191082024",
        "state": "voluptate dolore",
        "city": "连江县",
        "district":"XX区",
        "zipcode": "2",
        "fullAddress": "宁夏回族自治区海口市利津县",
        "email": "y.xluzw@qq.com"
    },
    "logistics": {
        "channelCode": "Y7002S",
        "trackingNumber1": "74",
        "labelUrl1": "http://www.baidu.com",
        "labelType": "pdf",
        "labelSize": 1,
        "labelDirection": 1,
        "shipByDate": "2022-08-22 17:45:00",
        "freight": 3.45,
        "labelUrl2": "",
        "trackingNumber2": "62"
    },
    "skuList": [
        {
            "customerSku": "JAY1350",
            "quantity": 1,
            "sellerPrice": 12.5
        },
        {
            "customerSku": "JAY1349",
            "quantity": 1,
            "sellerPrice": 12.5
        }
    ],
    "currency": "CNY",
    "platformOrderId": "220822S7H3098H3",
    "buyerId": "7494018952640169163",
    "payTime": "2022-08-22 17:45:00",
    "totalAmount": 34.52
}

返回响应

🟢200成功

application/json

Body

state

string

状态码

必需

msg

string

消息

必需

data

array[string]

返回数据

必需

示例

{
    "state": "string",
    "msg": "string",
    "data": [
        "string"
    ]
}

修改于 2025-06-12 04:13:11

几大平台对应channelCode字段的取值