元仓开放平台
首页
元仓客户端
首页
元仓客户端
订单
复制页面
开发者必读
对接说明
枚举描述
元仓建议对接接口
授权
授权
POST
基础资料
国家
POST
币种
POST
元仓渠道(物流公司)
POST
客户开启的元仓渠道(物流公司)
POST
元仓仓库
POST
客户开启的元仓仓库
POST
元仓平台
POST
文件上传
POST
商品
商品分类
POST
商品货物属性
POST
商品成交单位
POST
商品新增
POST
商品修改
POST
商品作废
POST
商品打印标签
POST
商品列表
POST
商品详情
POST
商品发货仓库匹配
POST
入库
预报入库
运输方式
货物属性
入库新增
入库作废
入库确认
入库详情
入库列表
头程物流成本修改
入库箱唛打印标签
入库完结
入库(不带箱唛)
入库新增
入库作废
入库确认
入库详情
入库列表
入库完结
订单
几大平台对应channelCode字段的取值
订单新增
POST
订单取消
POST
订单列表
POST
订单详情
POST
标记订单是否上网
POST
更新物流追踪信息
POST
库存
库存动态列表
库存盘点列表
库存列表
库龄报表(非实时)
换单
新增订单
订单列表
取消订单
退货
退货单新增
退货单列表
退货单作废
退货单详情
退货单决策
订阅
签名推送测试
预报入库/入库(不带箱唛)推送(状态)
预报入库/入库(不带箱唛)推送(上架明细)
订单推送
退货单推送
库存盘点完结推送
费用
获取预估操作费
订单
复制页面
订单新增
POST
/api/openPlatform/order/add
调试
Run in Apifox
Run in Apifox
状态码
#
状态码
描述
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:100
150,2:100
100,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