1. 订单模块API
API URL
post {HTTP(S)地址}/api/{version}/salesOrder
1.1. 订单创建接口
1.1.1. SERVICE_TYPE
CREATE_SALES_ORDER
1.1.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
shop |
Y |
String |
“Amazon美国” |
店铺 |
onlineOrderNumber |
Y |
String |
“ALI1238901” |
线上单号,最大50字符 |
paymentMethod |
Y |
String |
“在线支付” |
支付方式 |
codPayAmount |
N |
Decimal |
10.02 |
代收货款金额; 仅当支付方式为货到付款时必填,4位小数 |
freight |
N |
Decimal |
0 |
运费,默认为0 4位小数 |
currency |
Y |
String |
USD |
详见货币单位 |
buyerMessage |
N |
String |
|
留言,最大1024字符 |
sellerRemarks |
N |
String |
|
备注,最大1024字符 |
logisticsSelected |
N |
String |
|
买家选择的物流 |
payTime |
Y |
String |
|
订单支付时间(格式:YYYY-MM-DD) |
buyer |
Y |
Buyer |
|
见收件人详情 |
skuList |
Y |
List<Sku> |
|
见商品详情 |
orderCustomFieldValueVOList |
N |
List <SkuCustomFieldValueVO> |
|
自定义栏位信息 |
Sku(商品) |
|
|
|
参数 |
是否必须 |
类型 |
示例 |
备注 |
sku |
Y |
String |
“abc” |
SKU,最大255字符 |
payAmount |
Y |
Decimal |
1.1 |
实付价(包含运费),4位小数 商品单价*数量+商品运费(根据订单运费freight分摊得出)=商品实付价(包含运费)paymentPrice、payAmount二者必填一个,如果二者都传了,以panAmount为准 |
paymentPrice |
Y |
Decimal |
1.1 |
商品单价(不包含运费),4位小数 |
quantity |
Y |
Number |
1 |
数量 |
shippingPrice |
N |
Decimal |
0.1 |
商品运费 |
promotionDiscount |
N |
Decimal |
0.1 |
商品卖家优惠 |
Buyer(收件人)
参数 |
是否必须 |
类型 |
示例 |
备注 |
buyerId |
N |
String |
“sanzhang” |
买家ID,最大255字符 |
receiverName |
Y |
String |
“张三” |
收件人姓名,最大255字符 |
phone |
N |
String |
1571234567 |
手机/电话,最大50字符 |
email |
N |
String |
|
电子邮箱,最大255字符 |
country |
Y |
String |
US |
国家 |
province |
Y |
String |
|
省/州,最大100字符 |
city |
Y |
String |
|
城市,最大50字符 |
district |
N |
String |
|
区/县,最大50字符 |
postCode |
Y |
String |
|
邮编,最大50字符 |
address1 |
Y |
String |
|
地址1,最大255字符 |
address2 |
N |
String |
|
地址2,最大255字符 |
SkuCustomFieldValueVO(自定义栏位)
1.1.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
result |
Y |
Order |
|
请参考订单详情 |
1.2. 订单关闭接口
1.2.1. SERVICE_TYPE
CLOSE_SALES_ORDER
1.2.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
onlineOrderNumber |
Y |
String |
|
线上订单号 |
shop |
Y |
String |
|
店铺 |
1.2.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
1.3. 订单列表查询接口
1.3.1. SERVICE_TYPE
QUERY_SALES_ORDER_LIST
PS:因数据变更,此接口分页可能会漏单,推荐先调用 QUERY_SALES_ORDER_NUMBER_LIST 获取订单号,再调用此接口,查询效率高且不会漏单
1.3.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
status |
N |
String |
|
订单状态 |
shop |
N |
String |
Amazon美国 |
店铺,最大255字符 |
includesSoftDel |
N |
Number |
1 |
是否在返回结果里包含软删除数据,不传默认不包含, 1:包含; 0:不包含。和orderTag冲突,请勿同时发送 |
orderNumber |
N |
String |
S200222115613 |
系统订单号,最大50字符 |
orderNumbers |
N |
String |
S200222115613, S200222115614 |
多个订单号以英文逗号分隔,不得超过最长字符2000,查询订单数量最多不超过200 |
onlineOrderNumber |
N |
String |
20200119000035 |
线上订单号,最大500字符,支持多个以英文逗号分割 |
fuzzyOnlineOrderNumber |
N |
String |
20200119000035 |
线上订单号,模糊查询,最大500字符 |
orderTag |
N |
Number |
0;1 |
是否是常规系统单 0:常规系统单 1:拆合单之前的原始单号。和includesSoftDel冲突,请勿同时发送 |
shopIdList |
N |
List<Long> |
[1,2,3] |
批量店铺id |
shopGroupIdList |
N |
List<Long> |
[1,2,3] |
批量店铺组id |
fromPayTime |
N |
String |
2020-03-06 00:00:00 |
开始付款时间 |
toPayTime |
N |
String |
2020-03-07 00:00:00 |
结束付款时间 默认+1天 |
updateTimeFrom |
N |
String |
2020-03-07 00:00:00 |
订单更新开始时间 |
updateTimeTo |
N |
String |
2020-03-07 00:00:00 |
订单更新结束时间 |
latestShipTimeFrom |
N |
String |
2020-03-07 00:00:00 |
最晚发货时间起始 废弃请使用shippingTimeFrom |
latestShipTimeTo |
N |
String |
2020-03-07 00:00:00 |
最晚发货时间截止 废弃请使用shippingTimeTo |
shippingTimeFrom |
N |
String |
2020-03-07 00:00:00 |
发货时间起始 |
shippingTimeTo |
N |
String |
2020-03-07 00:00:00 |
发货时间截止 默认+1天 |
page |
Y |
Number |
1 |
页码,默认1 |
pageSize |
Y |
Number |
50 |
每页条数.不超过200条; 默认100 |
|
|
|
|
orderNumber orderNumbers onlineOrderNumber [fromPayTime,toPayTime] [updateTimeFrom, updateTimeTo] [latestShipTimeFrom, latestShipTimeTo] [shippingTimeFrom, shippingTimeTo] 11个查询条件必须指定其中一个,时间范围不能超过30天 如果只填写一个时间范围字段,则另外一个时间范围字段默认为+/-30天 |
orderByParam |
N |
String |
update_time |
目前仅支持update_time |
orderByOrder |
N |
String |
desc |
枚举值为: 1.desc 2.asc |
combineSku |
N |
Boolean |
true |
true/false/null 传true才会合并lazada订单明细 |
siteCodeList |
N |
List<String> |
[“SG”,”ID”] |
用于筛选有站点编码的店铺,进而筛选订单 |
isAfn |
N |
Number |
1 |
查询官方仓发货订单,传1生效 |
excludeCombineSkuList |
N |
Boolean |
true |
true/false/null 传true才会去掉组合品明细,只保留单品和子品明细 |
orderCustomFieldValueSoList |
N |
List<SkuCustomFieldValueSO> |
|
自定义栏位搜索条件 |
returnSnList |
N |
Boolean |
true |
是否返回商品序列号,涉及扫描商品序列号的业务,传true |
SkuCustomFieldValueSO(自定义栏位搜索)
参数 |
是否必须 |
类型 |
示例 |
备注 |
customFieldId |
Y |
Long |
3 |
SERVICE_TYPE中的CUSTOMER_FIELD_QUERY接口返回的id |
value |
N |
String |
“张三” |
自定义栏位对应的值 STRING:字符串; SELECT:下拉框格式支持。 |
from |
N |
String |
"1970/01/01" |
范围查询左区间 NUMBER:数字; DATE:日期格式支持。 |
to |
N |
String |
"1971/01/01" |
范围查询右区间 NUMBER:数字; DATE:日期格式支持。 |
1.3.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
total |
Y |
Number |
100 |
总条数 |
result |
Y |
List<Order> |
|
订单列表信息,详情参考订单详情 |
Order(订单)
参数 |
是否必须 |
类型 |
示例 |
备注 |
orderNumber |
Y |
String |
|
系统单号 |
parentOrderNumber |
N |
String |
|
拆单之后的子单对应的父单系统单号 |
subOrderNumberList |
N |
List <String> |
|
合单之后的父单对应的子单系统单号 |
isOriginalOrder |
N |
Boolean |
|
是否原始订单 |
onlineOrderNumber |
N |
String |
|
线上单号 |
shop |
Y |
String |
|
店铺名称 |
warehouse |
N |
String |
|
仓库 |
status |
Y |
String |
CLOSE |
订单状态 |
wmsStatus |
Y |
String |
picking |
仓库作业状态,目前仅支持千仓 |
currency |
Y |
String |
”USD“ |
货币单位 |
totalAmount |
Y |
Decimal |
20.1 |
总金额 |
freight |
Y |
Decimal |
2.1 |
运费 |
buyerMessage |
N |
String |
|
买家留言 |
sellerRemarks |
N |
String |
|
卖家留言 |
carrier |
N |
String |
|
承运商 |
platform |
Y |
String |
LAZADA |
平台 |
updateTime |
Y |
Date |
|
最近修改时间 |
trackingNumber |
N |
String |
|
运单号 |
payTime |
N |
Datetime |
|
付款时间 |
shippingTime |
N |
Datetime |
|
发货时间 |
createTime |
Y |
Datetime |
|
创建时间 |
buyer |
Y |
Buyer |
|
详见Buyer |
estimateFulfillmentFee |
N |
Decimal |
0.1 |
预估运费 |
totalDiscount |
N |
Decimal |
0.1 |
订单总优惠 |
sellerDiscount |
N |
Decimal |
0.1 |
订单卖家优惠 |
platformRebate |
N |
Decimal |
0.1 |
订单平台补贴 |
buyerPaidShippingFee |
N |
Decimal |
0.1 |
买家支付运费 |
finalProductProtection |
N |
Decimal |
0.1 |
保护费 |
sellerDiscountForWook |
N |
Decimal |
0.1 |
优惠券,wook定制 |
platformRebateForWook |
N |
Decimal |
0.1 |
平台补贴,wook定制 |
auditTime |
Y |
Datetime |
|
审核时间 |
latestShipDate |
N |
Datetime |
|
最晚发运时间 |
skuList |
Y |
List<Sku> |
|
详见Sku |
tag |
N |
Tag |
|
订单标记 |
platformReturnToSeller |
N |
Decimal |
0.1 |
订单中平台返还卖家金额 |
isBusinessOrder |
N |
Boolean |
true |
是否企业买家订单 |
salesRecordNumber |
N |
String |
|
卖家销售记录ID,Shopify平台的短单号(客户自定义的单号) |
siteCode |
N |
String |
SG |
订单所属店铺的站点编码 |
isAfn |
Y |
Number |
1 |
是否官方仓发货订单,仅亚马逊订单 |
platformShippingTime |
N |
Datetime |
|
平台发货时间 |
paymentMethod |
Y |
String |
PAY_ONLINE |
支付方式,COD:货到付款、PAY_ONLINE:在线支付、OPEN_ACCOUNT:赊销 |
isDeleted |
Y |
Number |
1 |
是否为软删除订单, 0没被软删除,!0软删除 |
orderCustomFieldValueVOList |
N |
SkuCustomFieldValueVO |
|
自定义栏位信息 |
subOrderNumberList
SkuCustomFieldValueVO(自定义栏位信息)
参数 |
是否必须 |
类型 |
示例 |
备注 |
tableName |
Y |
String |
SYS_ITEM |
SYS_ITEM:系统商品自定义栏位; SYS_ORDER:订单自定义栏位; SYS_ODO:出库单自定义栏位; SYS_ASN:入库单自定义栏位。 |
columType |
Y |
String |
NUMBER |
筛选不同填入类型的自定义栏位 NUMBER:数字; DATE:日期; STRING:字符串; SELECT:下拉框。 |
columName |
Y |
String |
生产日期 |
用户自己定义的栏位名称 |
defaultValue |
N |
String |
"1970/01/01"(无双引号) |
自定义栏位默认值 |
candidateValue |
N |
String |
["1970/01/01","1970/01/02"] |
下拉框的候选值 |
remark |
N |
String |
上架日期区分于出厂日期 |
备注 |
required |
N |
Integer |
1 |
是否只查询必填栏位 1:true;0:false |
isQuery |
N |
Integer |
1 |
是否只查询支持查询的栏位 1:true;0:false |
isShow |
N |
Integer |
1 |
是否只查询支持列配置的栏位 1:true;0:false |
Tag(订单标记)
参数 |
是否必须 |
类型 |
示例 |
备注 |
hasRefund |
N |
Number |
0 |
有退款(1:是,0否) |
itemReturned |
N |
Number |
0 |
有退货 |
consolidated |
N |
Number |
0 |
已合并 |
split |
N |
Number |
0 |
已拆分 |
locked |
N |
Number |
0 |
已锁定 |
sendWms |
N |
Number |
0 |
已下发 |
sendFailed |
N |
Number |
0 |
下发失败 |
onlineShipFeedbackAlready |
N |
Number |
0 |
已标记平台发货 |
onlineShipFeedbackFailed |
N |
Number |
0 |
标记平台发货失败 |
outOfStock |
N |
Number |
0 |
缺货 |
preSale |
N |
Number |
0 |
预售 |
onlineShipped |
N |
Number |
0 |
订单已发货标记 |
platformFulfillment |
N |
Number |
0 |
是否平台发货订单,1:是;0:否,除了亚马逊订单 |
Buyer(收件人)
参数 |
是否必须 |
类型 |
示例 |
备注 |
buyerId |
N |
String |
“sanzhang” |
买家ID |
receiverName |
Y |
String |
“张三” |
收件人姓名 |
phone |
N |
String |
|
手机号1 |
email |
N |
String |
|
电子邮箱 |
country |
Y |
String |
US |
国家 |
province |
Y |
String |
|
省/州 |
city |
Y |
String |
|
城市 |
postCode |
N |
String |
|
邮编 |
address1 |
Y |
String |
|
地址1 |
address2 |
N |
String |
|
地址2 |
Sku(订单商品)
参数 |
是否必须 |
类型 |
示例 |
备注 |
orderSkuId |
Y |
Number |
11 |
销售订单商品ID |
sku |
Y |
String |
“abc” |
系统SKU |
sourceCombinedSku |
N |
String |
“abc” |
若该明细行是从组合品里拆出的子品,则该字段展示其来源的组合品商品编码 |
quantity |
Y |
String |
1 |
商品数量 |
onlineItemId |
Y |
String |
|
线上商品ID |
payAmount |
Y |
Decimal |
|
实付价 |
totalTax |
Y |
Decimal |
|
税费 |
totalDiscount |
Y |
Decimal |
|
折扣 |
platformDiscount |
N |
Decimal |
0.1 |
商品平台优惠 |
originalPrice |
N |
Decimal |
0.1 |
商品原始单价 |
paymentPrice |
N |
Decimal |
0.1 |
商品实付单价 |
shippingPrice |
N |
Decimal |
0.1 |
商品运费 |
promotionDiscount |
N |
Decimal |
0.1 |
商品卖家优惠 |
discountPrice |
N |
Decimal |
0.1 |
折扣价 |
subSkuList |
N |
List<Sku> |
|
子商品List |
tag |
N |
SkuTag |
|
订单商品标记 |
points |
N |
String |
500 |
Amazon订单商品的抵扣积分 |
onlineProductCode |
N |
String |
10011 |
线上商品编码 |
onlineProductTitle |
N |
String |
碎花连衣裙 |
线上商品名称 |
onlineProductPicUrl |
N |
String |
https://www.test.com/aaa.png |
线上商品图片 |
onlineTransactionId |
N |
String |
"1111111111" |
商品业务id |
snList |
N |
List |
["111","222"] |
商品序列号列表 |
SkuTag (订单商品标记)
参数 |
是否必须 |
类型 |
示例 |
备注 |
isGift |
N |
Number |
0 |
赠品(1:是,0否) |
preSale |
N |
Number |
0 |
预售 |
1.4. 订单号列表查询接口
1.4.1. SERVICE_TYPE
QUERY_SALES_ORDER_NUMBER_LIST
PS:入参同订单列表查询
1.4.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
status |
N |
String |
|
订单状态 |
shop |
N |
String |
Amazon美国 |
店铺,最大255字符 |
includesSoftDel |
N |
Number |
1 |
是否在返回结果里包含软删除数据,不传默认不包含, 1:包含; 0:不包含。和orderTag冲突,请勿同时发送 |
orderNumber |
N |
String |
S200222115613 |
系统订单号,最大50字符 |
orderNumbers |
N |
String |
S200222115613, S200222115614 |
多个订单号以英文逗号分隔,不得超过最长字符2000,查询订单数量最多不超过200 |
onlineOrderNumber |
N |
String |
20200119000035 |
线上订单号,最大500字符,支持多个以英文逗号分割 |
fuzzyOnlineOrderNumber |
N |
String |
20200119000035 |
线上订单号,模糊查询,最大500字符 |
orderTag |
N |
Number |
0;1 |
是否是常规系统单 0:常规系统单 1:拆合单之前的原始单号。和includesSoftDel冲突,请勿同时发送 |
shopIdList |
N |
List<Long> |
[1,2,3] |
批量店铺id |
shopGroupIdList |
N |
List<Long> |
[1,2,3] |
批量店铺组id |
fromPayTime |
N |
String |
2020-03-06 00:00:00 |
开始付款时间 |
toPayTime |
N |
String |
2020-03-07 00:00:00 |
结束付款时间 默认+1天 |
updateTimeFrom |
N |
String |
2020-03-07 00:00:00 |
订单更新开始时间 |
updateTimeTo |
N |
String |
2020-03-07 00:00:00 |
订单更新结束时间 |
latestShipTimeFrom |
N |
String |
2020-03-07 00:00:00 |
最晚发货时间起始 |
latestShipTimeTo |
N |
String |
2020-03-07 00:00:00 |
最晚发货时间截止 |
shippingTimeFrom |
N |
String |
2020-03-07 00:00:00 |
发货时间起始 |
shippingTimeTo |
N |
String |
2020-03-07 00:00:00 |
发货时间截止 |
page |
Y |
Number |
1 |
页码,默认1 |
pageSize |
Y |
Number |
50 |
每页条数.不超过200条; 默认100 |
|
|
|
|
orderNumber orderNumbers onlineOrderNumber [fromPayTime,toPayTime] [updateTimeFrom, updateTimeTo] [latestShipTimeFrom, latestShipTimeTo] [shippingTimeFrom, shippingTimeTo] 11个查询条件必须指定其中一个,时间范围不能超过30天 如果只填写一个时间范围字段,则另外一个时间范围字段默认为+/-30天 |
orderByParam |
N |
String |
update_time |
目前仅支持update_time |
orderByOrder |
N |
String |
desc |
枚举值为: 1.desc 2.asc |
combineSku |
N |
Boolean |
true |
true/false/null 传true才会合并lazada订单明细 |
siteCodeList |
N |
List<String> |
[“SG”,”ID”] |
用于筛选有站点编码的店铺,进而筛选订单 |
isAfn |
N |
Number |
1 |
查询官方仓发货订单,传1生效 |
excludeCombineSkuList |
N |
Boolean |
true |
true/false/null 传true才会去掉组合品明细,只保留单品和子品明细 |
orderCustomFieldValueSoList |
N |
List<SkuCustomFieldValueSO> |
|
自定义栏位搜索条件 |
SkuCustomFieldValueSO(自定义栏位搜索)
参数 |
是否必须 |
类型 |
示例 |
备注 |
customFieldId |
Y |
Long |
3 |
SERVICE_TYPE中的CUSTOMER_FIELD_QUERY接口返回的id |
value |
N |
String |
“张三” |
自定义栏位对应的值 STRING:字符串; SELECT:下拉框格式支持。 |
from |
N |
String |
"1970/01/01" |
范围查询左区间 NUMBER:数字; DATE:日期格式支持。 |
to |
N |
String |
"1971/01/01" |
范围查询右区间 NUMBER:数字; DATE:日期格式支持。 |
1.4.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
total |
Y |
Number |
100 |
总条数 |
result |
Y |
List<String> |
|
订单号列表 |
1.5. 订单物流信息推送接口
1.5.1. SERVICE_TYPE
PUSH_SALES_ORDER_SHIPPING_INFO
1.5.2. 推送消息内容
参数 |
是否必须 |
类型 |
示例 |
备注 |
orderNumber |
Y |
String |
“S200222115613” |
系统订单号 |
onlineOrderNumber |
Y |
String |
|
订单创建时设置的线上单号 |
trackingNumber |
Y |
String |
|
运单号 |
carrier |
Y |
String |
|
承运商 |
shippingTime |
Y |
Datetime |
|
发货时间,"yyyy-MM-dd hh:mm:ss SSS" |
status |
Y |
String |
|
订单状态 |
1.6. 订单创建并审核接口
1.6.1. SERVICE_TYPE
CREATE_AND_AUDIT_SALES_ORDER
1.6.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
shop |
Y |
String |
“Amazon美国” |
店铺 |
onlineOrderNumber |
Y |
String |
“ALI1238901” |
线上单号,最大50字符 |
paymentMethod |
Y |
String |
“在线支付” |
支付方式 |
codPayAmount |
N |
Decimal |
10.02 |
代收货款金额; 仅当支付方式为货到付款时必填,4位小数 |
freight |
N |
Decimal |
0 |
运费,默认为0 4位小数 |
currency |
Y |
String |
USD |
详见货币单位 |
buyerMessage |
N |
String |
|
留言,最大1024字符 |
sellerRemarks |
N |
String |
|
备注,最大1024字符 |
logisticsSelected |
N |
String |
|
买家选择的物流 |
payTime |
Y |
Timestamp |
|
订单支付时间 |
buyer |
Y |
Buyer |
|
见收件人详情 |
skuList |
Y |
List<Sku> |
|
见商品详情 |
warehouse |
Y |
String |
“BEST泰国仓” |
订单发货仓库 |
logistics |
Y |
String |
“AUTO” |
订单发货物流方式 |
Sku(商品)
参数 |
是否必须 |
类型 |
示例 |
备注 |
sku |
Y |
String |
“abc” |
SKU,最大255字符 |
payAmount |
Y |
Decimal |
1.1 |
实付价(包含运费),4位小数 |
quantity |
Y |
Number |
1 |
数量 |
Buyer(收件人)
参数 |
是否必须 |
类型 |
示例 |
备注 |
buyerId |
N |
String |
“sanzhang” |
买家ID,最大255字符 |
receiverName |
Y |
String |
“张三” |
收件人姓名,最大255字符 |
phone |
N |
String |
1571234567 |
手机/电话,最大50字符 |
email |
N |
String |
|
电子邮箱,最大255字符 |
country |
Y |
String |
US |
国家 |
province |
Y |
String |
|
省/州,最大100字符 |
city |
Y |
String |
|
城市,最大50字符 |
district |
N |
String |
|
区/县,最大50字符 |
postCode |
Y |
String |
|
邮编,最大50字符 |
address1 |
Y |
String |
|
地址1,最大255字符 |
address2 |
N |
String |
|
地址2,最大255字符 |
1.6.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
业务错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
result |
Y |
Order |
|
请参考订单详情 |
1.7. 订单审核接口
1.7.1. SERVICE_TYPE
AUDIT_SALES_ORDER
1.7.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
shop |
Y |
String |
“Amazon美国” |
店铺 |
onlineOrderNumber |
Y |
String |
“ALI1238901” |
线上单号,最大50字符 |
warehouse |
Y |
String |
“BEST泰国仓” |
订单发货仓库 |
logistics |
Y |
String |
“AUTO” |
订单发货物流方式 |
1.7.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
业务错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
1.8. 订单下发接口
1.8.1. SERVICE_TYPE
SEND_SALES_ORDER
1.8.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
onlineOrderNumber |
Y |
String |
|
线上订单号 |
shop |
Y |
String |
|
店铺 |
1.8.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
业务错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
1.9. 订单商品的原始业务单查询接口
1.9.1. SERVICE_TYPE
QUERY_SKU_SOURCE_ORDER
1.9.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
orderNumbers |
Y |
String |
O123,O456 |
多个订单号以英文逗号分隔,不得超过最长字符2000,查询订单数量最多不超过50 |
1.9.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
total |
Y |
Number |
100 |
总条数 |
result |
Y |
List<Order> |
|
订单列表信息,详情参考订单详情 |
Order(订单)
参数 |
是否必须 |
类型 |
示例 |
备注 |
orderNumber |
Y |
String |
|
系统单号 |
parentOrderNumber |
N |
String |
|
拆单之后的子单对应的父单系统单号 |
subOrderNumberList |
N |
List <String> |
|
合单之后的父单对应的子单系统单号 |
onlineOrderNumber |
N |
String |
|
线上单号 |
shop |
Y |
String |
|
店铺名称 |
warehouse |
N |
String |
|
仓库 |
status |
Y |
String |
CLOSE |
订单状态 |
currency |
Y |
String |
”USD“ |
货币单位 |
totalAmount |
Y |
Decimal |
20.1 |
总金额 |
freight |
Y |
Decimal |
2.1 |
运费 |
buyerMessage |
N |
String |
|
买家留言 |
sellerRemarks |
N |
String |
|
卖家留言 |
carrier |
N |
String |
|
承运商 |
trackingNumber |
N |
String |
|
运单号 |
payTime |
N |
Datetime |
|
付款时间,"yyyy-MM-dd hh:mm:ss SSS" |
shippingTime |
N |
Datetime |
|
发货时间 |
createTime |
Y |
Datetime |
|
创建时间 |
buyer |
Y |
Buyer |
|
详见Buyer |
skuList |
Y |
List<Sku> |
|
详见Sku |
auditTime |
Y |
Datetime |
|
审核时间,"yyyy-MM-dd hh:mm:ss SSS" |
tag |
N |
Tag |
|
订单标记 |
paymentMethod |
Y |
String |
PAY_ONLINE |
支付方式,COD:货到付款、PAY_ONLINE:在线支付、OPEN_ACCOUNT:赊销 |
Tag(订单标记)
参数 |
是否必须 |
类型 |
示例 |
备注 |
hasRefund |
N |
Number |
0 |
有退款(1:是,0否) |
itemReturned |
N |
Number |
0 |
有退货 |
consolidated |
N |
Number |
0 |
已合并 |
split |
N |
Number |
0 |
已拆分 |
locked |
N |
Number |
0 |
已锁定 |
sendWms |
N |
Number |
0 |
已下发 |
sendFailed |
N |
Number |
0 |
下发失败 |
onlineShipFeedbackAlready |
N |
Number |
0 |
已标记平台发货 |
onlineShipFeedbackFailed |
N |
Number |
0 |
标记平台发货失败 |
outOfStock |
N |
Number |
0 |
缺货 |
Buyer(收件人)
参数 |
是否必须 |
类型 |
示例 |
备注 |
buyerId |
N |
String |
“sanzhang” |
买家ID |
receiverName |
Y |
String |
“张三” |
收件人姓名 |
phone |
N |
String |
|
手机号1 |
email |
N |
String |
|
电子邮箱 |
country |
Y |
String |
US |
国家 |
province |
Y |
String |
|
省/州 |
city |
Y |
String |
|
城市 |
postCode |
N |
String |
|
邮编 |
address1 |
Y |
String |
|
地址1 |
address2 |
N |
String |
|
地址2 |
Sku(订单商品)
参数 |
是否必须 |
类型 |
示例 |
备注 |
orderSkuId |
Y |
Number |
11 |
销售订单商品ID |
sku |
Y |
String |
“abc” |
系统SKU |
quantity |
Y |
String |
1 |
商品数量 |
payAmount |
Y |
Decimal |
|
实付价 |
totalTax |
Y |
Decimal |
|
税费 |
taxRate |
Y |
Decimal |
0.12 |
税率 |
totalDiscount |
Y |
Decimal |
|
折扣 |
subSkuList |
N |
List<Sku> |
|
子商品List |
sourceOrderList |
Y |
List<SourceOrderList> |
|
参见SourceOrderList, 如果商品为组合品,则原始业务单只会出现在subSkuList中 |
SourceOrderList(原始业务单)
参数 |
是否必须 |
类型 |
示例 |
备注 |
type |
Y |
String |
PURCHASE |
业务单类型 |
businessNumber |
Y |
String |
P123456 |
业务单号 |
purchasePrice |
|
Decimal |
0.1 |
采购费用(单件) |
purchasePriceUnit |
|
String |
CNY |
采购费用币种 |
firstLegPrice |
|
Decimal |
0.1 |
头程费用(单件) |
firstLegPriceUnit |
|
String |
CNY |
头程费用币种 |
transferPrice |
|
Decimal |
0.1 |
调拨费用(单件) |
transferPriceUnit |
|
String |
CNY |
调拨费用币种 |
quantity |
|
Number |
1 |
订单商品占用的该类型的业务单商品数量 |
1.10. 查询订单揽收状态接口
1.10.1. SERVICE_TYPE
QUERY_ORDER_PICK_UP_STATUS
1.10.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
orderNumbers |
Y |
List<String> |
["order001", "order002"] |
订单号列表 |
1.10.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
业务错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
result |
Y |
List<OrderLogisticsInfo> |
|
订单揽收状态信息 |
OrderLogisticsInfo
参数 |
是否必须 |
类型 |
示例 |
备注 |
orderNumber |
Y |
String |
|
系统单号 |
trackingNumber |
N |
String |
|
运单号 |
status |
Y |
String |
SHIPPED |
订单状态 |
isPicked |
N |
Boolean |
true |
订单是否已揽收 true-是 false-否 |