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 | 2024-05-20 15:40:30+08:00 | 订单支付时间(格式:YYYY-MM-DD HH:MM:SS+08:00) |
buyer | Y | Buyer | 见收件人详情 | |
skuList | Y | List<Sku> | 见商品详情 | |
orderCustomFieldValueVOList | N | List <SkuCustomFieldValueVO> |
自定义栏位信息 | |
customerType | N | String | 客户类型,shipper客户请传SHIPPER,无合作勿填写 | |
isSpecifyBatch | N | String | false | 是否指定货物批次,仅对千易wms生效 |
shippingLabel | N | String | 面单文件,base64格式 | |
imgType | N | String | "PDF" | 面单文件类型,PDF/PNG |
documentFile | N | String | 附件文件,base64格式 | |
documentType | N | String | "PDF" | 附件文件类型,PDF/PNG |
documentName | N | String | "附件1" | 附件文件名 |
trackingNumber | N | String | "NO123" | 运单号 |
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 | Y | Decimal | 0.1 | 商品卖家优惠 |
batchNo | N | String(255) | 批次号,仅对千易wms生效 | |
mfgDate | N | String | 2025-10-01 | 生产日期,仅对千易wms生效 |
expDate | N | String | 2025-10-01 | 失效日期,仅对千易wms生效 |
originCountry | N | String | CN | 生产地国家,仅对千易wms生效 |
Buyer(收件人)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
buyerId | N | String | “sanzhang” | 买家ID,最大255字符 |
receiverName | Y | String | “张三” | 收件人姓名,最大255字符 |
phone | N | String | 1571234567 | 手机/电话,最大50字符 |
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字符 | |
houseNumber | N | String | 门牌号 |
SkuCustomFieldValueVO(自定义栏位)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
customFieldId | Y | Long | 3 | SERVICE_TYPE中的CUSTOMER_FIELD_QUERY接口返回的id |
value | Y | String | “张三” | 自定义栏位对应的值 |
1.1.3. 返回参数
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
errorCode | Y | String | “DATA_INPUT_ERROR” | 错误码 |
errorMsg | Y | String | “输入参数不对” | 业务错误信息 |
state | Y | String | success | 请求结果 |
result | Y | Order | 请参考订单详情 |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/salesOrder' \
--form 'appId="TEST"' \
--form 'serviceType="CREATE_SALES_ORDER"' \
--form 'bizParam="{
\"trackingNumber\": \"OUTBOUNDSMOKE7\",
\"shop\": \"Solaso-ERP\",
\"onlineOrderNumber\": \"OUTBOUNDSMOKE7\",
\"paymentMethod\": \"COD\",
\"codPayAmount\": 100000,
\"currency\": \"IDR\",
\"buyerMessage\": \"buyer-remark\",
\"sellerRemarks\": \"test\",
\"logisticsSelected\": \"YT-THZXR\",
\"payTime\": \"2024-05-20 15:40:30+08:00\",
\"buyer\": {
\"buyerID\": \"Riza Budi 2\",
\"receiverName\": \"Riza Budi 2\",
\"phone\": \"0857101739512\",
\"email\": \"apriyadhi@kanmogroup.com\",
\"country\": \"ID\",
\"province\": \"DKI Jakarta\",
\"city\": \"Kota Jakarta Selatan\",
\"postCode\": \"12940\",
\"address1\": \"Plaza 89 Rasuna Said\",
\"address2\": \"\"
},
\"skuList\": [
{
\"sku\": \"DP001\",
\"payAmount\": 0,
\"quantity\": 1
}
]
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="39c2cacfe7a6afb55e2cc62ee5a8d738"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":{\"auditTime\":1754639619000,\"buyer\":{\"address1\":\"Plaza 89 Rasuna Said\",
\"address2\":\"\",\"buyerId\":\"Riza Budi 2\",\"city\":\"Kota Jakarta Selatan\",\"country\":\"ID\",\"email\":\"apriyadhi@kanmogroup.com\",
\"isDeleted\":0,\"phone\":\"0857101739512\",\"postCode\":\"12940\",\"province\":\"DKI Jakarta\",\"receiverName\":\"Riza Budi 2\"},\"buyerMessage\":\"buyer-remark\",
\"buyerPaidShippingFee\":0,\"carrier\":\"YT\",\"codPayAmount\":100000.0000,\"createTime\":1754639574000,\"currency\":\"IDR\",
\"finalProductProtection\":0,\"forceSys\":true,\"freight\":0.0000,\"isAFN\":0,\"isDeleted\":0,\"isSpecifyBatch\":true,\"isSys\":false,
\"logisticsSelected\":\"YT-THZXR\",\"onlineOrderNumber\":\"OUTBOUNDSMOKE7\",\"onlineStatus\":\"WAIT_AUDIT\",
\"orderCustomFieldValueVOList\":[{\"candidateValue\":[],\"columCode\":1,\"columName\":\"订单来源\",\"columType\":\"STRING\",\"customFieldId\":18,
\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":18,\"isQuery\":1,\"isShow\":0,\"required\":0},
{\"candidateValue\":[],\"columCode\":3,\"columName\":\"134234\",\"columType\":\"STRING\",\"customFieldId\":32,\"customFieldValueVOList\":[],
\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":32,\"isQuery\":0,\"isShow\":0,\"required\":0},
{\"candidateValue\":[\"1\",\"2\",\"3\",\"4\",\"5\"],\"columCode\":5,\"columName\":\"JJtest\",\"columType\":\"SELECT\",\"customFieldId\":48,
\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"1\",\"id\":48,\"isQuery\":1,\"isShow\":1,\"required\":1},
{\"candidateValue\":[],\"columCode\":9,\"columName\":\"ceshi3\",\"columType\":\"NUMBER\",\"customFieldId\":54,\"customFieldValueVOList\":[],
\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":54,\"isQuery\":0,\"isShow\":0,\"required\":0}],\"orderNumber\":\"S250808148148\",
\"payTime\":1751299200000,\"paymentMethod\":\"COD\",\"platform\":\"INDEPENDENT\",\"platformRebate\":0,\"platformRebateForWook\":0,\"platformReturnToSeller\":0,
\"returnGiftFlag\":false,\"returnSnList\":false,\"sellerDiscount\":0,\"sellerDiscountForWook\":0,\"sellerRemarks\":\"test\",\"shop\":\"Solaso-ERP\",\"shopId\":30051,
\"skuList\":[{\"discountPrice\":0,\"onlineItemId\":\"10001606\",\"onlineProductCode\":\"DP001\",
\"onlineProductPicUrl\":\"https://qianyierp-test.oss.aliyuncs.com/image_thumbnail/YjIwMDdhMTFkZTA1MDIwYjhjNDA1Y2U0OWJhYWEzZTE%3D.jpg\",
\"onlineProductTitle\":\"单品测试001\",\"onlineTransactionId\":\"OUTBOUNDSMOKE7\",\"orderSkuId\":92169660,\"originalPrice\":0,\"payAmount\":0.0000,
\"paymentPrice\":0,\"platformDiscount\":0,\"promotionDiscount\":0.0000,\"quantity\":1,\"shippingPrice\":0.0000,\"sku\":\"DP001\",\"subSkuList\":[],
\"tag\":{\"allReturned\":0,\"hasRefund\":0,\"isGift\":0,\"onlineShipped\":0,\"preSale\":0}}],\"status\":\"WAIT_SHIP\",\"tag\":{\"allRefund\":0,\"allReturned\":0,
\"consolidated\":0,\"hasRefund\":0,\"itemReturned\":0,\"locked\":0,\"onlineShipFeedbackAlready\":0,\"onlineShipFeedbackFailed\":0,\"onlineShipped\":0,\"outOfStock\":0,
\"partRefund\":0,\"partReturned\":0,\"platformFulfillment\":0,\"preSale\":0,\"reShip\":0,\"sampleOrder\":0,\"sendFailed\":0,\"sendWms\":0,\"split\":0},
\"totalAmount\":0.0000,\"totalDiscount\":0,\"trackingNumber\":\"OUTBOUNDSMOKE7\",\"updateTime\":1754639644000},
\"state\":\"success\"}",
"requestId": "e9445212-3dc7-4cc5-b74c-6b2e8f0339b4"
}
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 | 请求结果 |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/salesOrder' \
--form 'appId="TEST"' \
--form 'serviceType="CLOSE_SALES_ORDER"' \
--form 'bizParam="{\"onlineOrderNumber\":\"OUTBOUNDSMOKE7\",\"shop\":\"myShop\"}"' \
--form 'timestamp="1731742317"' \
--form 'sign="67f07f0f822221e84e4172fd83c88077"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"errorMsg\":null,\"notSuccess\":false,\"state\":\"success\"}",
"requestId": "abfa3c20-9d49-4838-bb2e-4f8ebb29bf92"
}
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"errorCode\":\"SHOP_NOT_AUTHORIZED_OR_NOT_EXIST\",\"errorMsg\":\"店铺无授权或不存在\",\"notSuccess\":true,\"state\":\"failure\"}",
"requestId": "fd6dfb35-b58d-4c35-8921-2caf84293a54"
}
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 | 订单更新结束时间 |
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 |
returnGiftFlag | N | Boolean | true | 是否返回商品赠品标识, 填true返回 |
ifNeedPackageInfo | N | boolean | true | 默认false,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 | N | List <String> |
合单之后的父单对应的子单系统单号 | |
onlineStatus | N | String | 线上订单状态 | |
odoPackageVOList | N | List<OdoPackage> | 包裹信息 |
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:否,除了亚马逊订单 |
partRefund | N | Number | 0 | 部分退款(1:是,0否) |
allRefund | N | Number | 0 | 全部退款(1:是,0否) |
allReturned | N | Number | 0 | 全部退货(1:是,0否) |
partReturned | N | Number | 0 | 部分退货(1:是,0否) |
sampleOrder | N | Number | 0 | 样品订单 |
Buyer(收件人)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
buyerId | N | String | “sanzhang” | 买家ID |
receiverName | Y | String | “张三” | 收件人姓名 |
phone | N | String | 手机号1 | |
N | String | 电子邮箱 | ||
country | Y | String | US | 国家 |
province | Y | String | 省/州 | |
city | Y | String | 城市 | |
postCode | N | String | 邮编 | |
address1 | Y | String | 地址1 | |
address2 | N | String | 地址2 | |
houseNumber | N | String | 门牌号 |
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 <String> |
["111","222"] | 商品序列号列表 |
giftFlag | N | Number | 1 | 0 - 平台活动产生的赠品; 1 - ERP赠品规则产生的赠品 |
wmsSendAvailableQuantity | N | Number | 11 | 实际出库数量 |
SkuTag (订单商品标记)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
isGift | N | Number | 0 | 赠品(1:是,0否) |
preSale | N | Number | 0 | 预售 |
hasRefund | N | Number | 0 | 有退款 (1:是,0否) |
allReturned | N | Number | 0 | 全部退货 (1:是,0否) |
OdoPackage(包裹信息)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
orderNumber | N | String | S202502101123 | |
carrier | N | String | JNE JTR | |
carrierService | N | String | S90 | |
trackingNumber | Y | String | S90 | 运单号 |
batchCode | N | String | S90 | |
odoPackageContentVOList | N | List<OdoPackageContent> | S90 | 包裹详情 |
OdoPackageContent(包裹信息)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
sku | Y | String | S90 | |
quantity | Y | Long | 2 | |
skuStockStatus | N | String | S90 | |
mfgDate | N | String | S90 | 生产日期 |
expDate | N | String | S90 | 失效日期 |
batchNo | N | String | S90 | 批次号 |
originCountry | N | String | S90 | 产地 |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/salesOrder' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_SALES_ORDER_LIST"' \
--form 'bizParam="{\"onlineOrderNumber\":\"OUTBOUNDSMOKE7\",\"page\":1,\"pageSize\":100}"' \
--form 'timestamp="1731742317"' \
--form 'sign="ff4ae16851dc97222781c1975f6ef168"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"auditTime\":1755068014000,\"buyer\":{\"address1\":\"Plaza 89 Rasuna Said\",
\"address2\":\"\",\"buyerId\":\"Riza Budi 3\",\"city\":\"Kota Jakarta Selatan\",\"country\":\"ID\",\"district\":\"\",\"email\":\"apriyadhi@kanmogroup.com\",
\"isDeleted\":0,\"phone\":\"0857101739512\",\"postCode\":\"12940\",\"province\":\"DKI Jakarta\",\"receiverName\":\"Riza Budi 2\"},
\"buyerMessage\":\"buyer-remark\",\"buyerPaidShippingFee\":0,\"carrier\":\"ups\",\"codPayAmount\":100000.0000,\"createTime\":1754639574000,
\"currency\":\"IDR\",\"finalProductProtection\":0,\"forceSys\":true,\"freight\":0.0000,\"isAFN\":0,\"isDeleted\":0,\"isOriginalOrder\":true,
\"isSys\":false,\"logistics\":\"测试001\",\"logisticsSelected\":\"YT-THZXR\",\"onlineOrderNumber\":\"OUTBOUNDSMOKE7\",\"onlineStatus\":\"WAIT_AUDIT\",
\"orderCustomFieldValueVOList\":[{\"candidateValue\":[],\"columCode\":1,\"columName\":\"订单来源\",\"columType\":\"STRING\",\"customFieldId\":18,
\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":18,\"isQuery\":1,\"isShow\":0,\"required\":0},
{\"candidateValue\":[],\"columCode\":3,\"columName\":\"134234\",\"columType\":\"STRING\",\"customFieldId\":32,\"customFieldValueVOList\":[],
\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":32,\"isQuery\":0,\"isShow\":0,\"required\":0},
{\"candidateValue\":[\"1\",\"2\",\"3\",\"4\",\"5\"],\"columCode\":5,\"columName\":\"JJtest\",\"columType\":\"SELECT\",\"customFieldId\":48,
\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"1\",\"id\":48,\"isQuery\":1,\"isShow\":1,\"required\":1},
{\"candidateValue\":[],\"columCode\":9,\"columName\":\"ceshi3\",\"columType\":\"NUMBER\",\"customFieldId\":54,\"customFieldValueVOList\":[],
\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":54,\"isQuery\":0,\"isShow\":0,\"required\":0}],\"orderNumber\":\"S250808148148\",
\"payTime\":1751299200000,\"paymentMethod\":\"COD\",\"platform\":\"INDEPENDENT\",\"platformRebate\":0,\"platformRebateForWook\":0,\"platformReturnToSeller\":0,
\"returnGiftFlag\":false,\"returnSnList\":false,\"sellerDiscount\":0,\"sellerDiscountForWook\":0,\"sellerRemarks\":\"test\",\"shop\":\"Solaso-ERP\",
\"shopId\":30051,\"skuList\":[{\"discountPrice\":0,\"onlineItemId\":\"10001606\",\"onlineProductCode\":\"DP001\",
\"onlineProductPicUrl\":\"https://qianyierp-test.oss.aliyuncs.com/image_thumbnail/YjIwMDdhMTFkZTA1MDIwYjhjNDA1Y2U0OWJhYWEzZTE%3D.jpg\",
\"onlineProductTitle\":\"单品测试001\",\"onlineTransactionId\":\"OUTBOUNDSMOKE7\",\"orderSkuId\":92169660,\"originalPrice\":0,\"payAmount\":0.0000,
\"paymentPrice\":0,\"platformDiscount\":0,\"promotionDiscount\":0.0000,\"quantity\":1,\"shippingPrice\":0.0000,\"sku\":\"DP001\",\"subSkuList\":[],
\"tag\":{\"allReturned\":0,\"hasRefund\":0,\"isGift\":0,\"onlineShipped\":0,\"preSale\":0}}],\"status\":\"WAIT_SHIP\",\"tag\":{\"allRefund\":0,\"allReturned\":0,
\"consolidated\":0,\"hasRefund\":0,\"itemReturned\":0,\"locked\":0,\"onlineShipFeedbackAlready\":0,\"onlineShipFeedbackFailed\":0,\"onlineShipped\":0,
\"outOfStock\":0,\"partRefund\":0,\"partReturned\":0,\"platformFulfillment\":0,\"preSale\":0,\"reShip\":0,\"sampleOrder\":0,\"sendFailed\":0,
\"sendWms\":0,\"split\":0},\"totalAmount\":0.0000,\"totalDiscount\":0,\"updateTime\":1755068015000,\"warehouse\":\"测试新增仓库商品下发\",\"warehouseType\":\"CUSTOM\"}],
\"state\":\"success\",\"total\":1}",
"requestId": "9f3ac02c-4768-4841-8b1b-7b42182add99"
}
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 | 发货时间截止 |
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 | 请求结果 |
result | Y | List<String> | 订单号列表 |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/salesOrder' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_SALES_ORDER_NUMBER_LIST"' \
--form 'bizParam="{\"onlineOrderNumber\":\"OUTBOUNDSMOKE7\",\"page\":1,\"pageSize\":100}"' \
--form 'timestamp="1731742317"' \
--form 'sign="fcf22268877a9d05487591cb6cf3add7"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[\"S250808148148\"],\"state\":\"success\"}",
"requestId": "b5b84e30-c1ba-47a3-8f62-fdc94afade32"
}
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 | 订单状态 |
推送示例(默认form-data格式):
JSON格式:
{"appId":"TEST","bizParam":"{\"carrier\":\"SHIPDOC\",\"onlineOrderNumber\":\"2507311347270601016525823\",\"orderNumber\":\"S250731147586\",\"shippingTime\":1754014435000,\"status\":\"WAIT_SHIP\",\"trackingNumber\":\"223243444\"}","serviceType":"PUSH_SALES_ORDER_SHIPPING_INFO","timestamp":"1754272685482","sign":"7cbc7305af85fb2eed308866c4fbaf89"}
FORM-DATA格式:
{appId=1111-3, bizParam={"carrier":"SHIPDOC","onlineOrderNumber":"2507311347270601016525823","orderNumber":S250731147586,"shippingTime":1754014435000,"status":"WAIT_SHIP","trackingNumber":"223243444"}, serviceType=PUSH_SALES_ORDER_SHIPPING_INFO, timestamp=1754272685482, sign=7cbc7305af85fb2eed308866c4fbaf89}
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 | 2024-05-20 15:40:30+08:00 | 订单支付时间 YYYY-MM-DD HH:MM:SS+08:00 |
buyer | Y | Buyer | 见收件人详情 | |
skuList | Y | List<Sku> | 见商品详情 | |
warehouse | Y | String | “BEST泰国仓” | 订单发货仓库 |
logistics | Y | String | “AUTO” | 订单发货物流方式 |
shippingLabel | N | String | 面单文件,base64格式 | |
imgType | N | String | "PDF" | 面单文件类型,PDF/PNG |
documentFile | N | String | 附件文件,base64格式 | |
documentType | N | String | "PDF" | 附件文件类型,PDF/PNG |
documentName | N | String | "附件1" | 附件文件名 |
trackingNumber | N | String | "NO123" | 运单号 |
customerType | N | String | 客户类型,shipper客户请传SHIPPER,无合作勿填写 | |
isSpecifyBatch | N | String | false | 是否指定货物批次,仅对千易wms生效 |
Sku(商品)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
sku | Y | String | “abc” | SKU,最大255字符 |
payAmount | Y | Decimal | 1.1 | 实付价(包含运费),4位小数 |
quantity | Y | Number | 1 | 数量 |
batchNo | N | String(255) | 批次号,仅对千易wms生效 | |
mfgDate | N | String | 2025-10-01 | 生产日期,仅对千易wms生效 |
expDate | N | String | 2025-10-01 | 失效日期,仅对千易wms生效 |
originCountry | N | String | CN | 生产地国家,仅对千易wms生效 |
Buyer(收件人)
参数 | 是否必须 | 类型 | 示例 | 备注 |
---|---|---|---|---|
buyerId | N | String | “sanzhang” | 买家ID,最大255字符 |
receiverName | Y | String | “张三” | 收件人姓名,最大255字符 |
phone | N | String | 1571234567 | 手机/电话,最大50字符 |
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 | 请参考订单详情 |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/salesOrder' \
--form 'appId="TEST"' \
--form 'serviceType="CREATE_AND_AUDIT_SALES_ORDER"' \
--form 'bizParam="{
\"warehouse\": \"千仓1\",
\"logistics\": \"YT-THZXR\",
\"trackingNumber\": \"OUTBOUNDSMOKE7\",
\"shop\": \"Solaso-ERP\",
\"onlineOrderNumber\": \"OUTBOUNDSMOKE7\",
\"paymentMethod\": \"COD\",
\"codPayAmount\": 100000,
\"currency\": \"IDR\",
\"buyerMessage\": \"buyer-remark\",
\"sellerRemarks\": \"test\",
\"logisticsSelected\": \"YT-THZXR\",
\"payTime\": \"2025-07-01\",
\"buyer\": {
\"buyerID\": \"Riza Budi 2\",
\"receiverName\": \"Riza Budi 2\",
\"phone\": \"0857101739512\",
\"email\": \"apriyadhi@kanmogroup.com\",
\"country\": \"ID\",
\"province\": \"DKI Jakarta\",
\"city\": \"Kota Jakarta Selatan\",
\"postCode\": \"12940\",
\"address1\": \"Plaza 89 Rasuna Said\",
\"address2\": \"\"
},
\"skuList\": [
{
\"sku\": \"DP001\",
\"payAmount\": 0,
\"quantity\": 1
}
]
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="d5aa59c8a66840712d9418e2b0dc965d"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":{\"auditTime\":1754639619000,\"buyer\":{\"address1\":\"Plaza 89 Rasuna Said\",
\"address2\":\"\",\"buyerId\":\"Riza Budi 2\",\"city\":\"Kota Jakarta Selatan\",\"country\":\"ID\",\"email\":\"apriyadhi@kanmogroup.com\",
\"isDeleted\":0,\"phone\":\"0857101739512\",\"postCode\":\"12940\",\"province\":\"DKI Jakarta\",\"receiverName\":\"Riza Budi 2\"},\"buyerMessage\":\"buyer-remark\",
\"buyerPaidShippingFee\":0,\"carrier\":\"YT\",\"codPayAmount\":100000.0000,\"createTime\":1754639574000,\"currency\":\"IDR\",
\"finalProductProtection\":0,\"forceSys\":true,\"freight\":0.0000,\"isAFN\":0,\"isDeleted\":0,\"isSpecifyBatch\":true,\"isSys\":false,
\"logistics\":\"YT-THZXR\",\"logisticsSelected\":\"YT-THZXR\",\"onlineOrderNumber\":\"OUTBOUNDSMOKE7\",\"onlineStatus\":\"WAIT_AUDIT\",
\"orderCustomFieldValueVOList\":[{\"candidateValue\":[],\"columCode\":1,\"columName\":\"订单来源\",\"columType\":\"STRING\",\"customFieldId\":18,
\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":18,\"isQuery\":1,\"isShow\":0,\"required\":0},
{\"candidateValue\":[],\"columCode\":3,\"columName\":\"134234\",\"columType\":\"STRING\",\"customFieldId\":32,\"customFieldValueVOList\":[],
\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":32,\"isQuery\":0,\"isShow\":0,\"required\":0},
{\"candidateValue\":[\"1\",\"2\",\"3\",\"4\",\"5\"],\"columCode\":5,\"columName\":\"JJtest\",\"columType\":\"SELECT\",\"customFieldId\":48,
\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"1\",\"id\":48,\"isQuery\":1,\"isShow\":1,\"required\":1},
{\"candidateValue\":[],\"columCode\":9,\"columName\":\"ceshi3\",\"columType\":\"NUMBER\",\"customFieldId\":54,\"customFieldValueVOList\":[],
\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":54,\"isQuery\":0,\"isShow\":0,\"required\":0}],\"orderNumber\":\"S250808148148\",
\"payTime\":1751299200000,\"paymentMethod\":\"COD\",\"platform\":\"INDEPENDENT\",\"platformRebate\":0,\"platformRebateForWook\":0,\"platformReturnToSeller\":0,
\"returnGiftFlag\":false,\"returnSnList\":false,\"sellerDiscount\":0,\"sellerDiscountForWook\":0,\"sellerRemarks\":\"test\",\"shop\":\"Solaso-ERP\",\"shopId\":30051,
\"skuList\":[{\"discountPrice\":0,\"onlineItemId\":\"10001606\",\"onlineProductCode\":\"DP001\",
\"onlineProductPicUrl\":\"https://qianyierp-test.oss.aliyuncs.com/image_thumbnail/YjIwMDdhMTFkZTA1MDIwYjhjNDA1Y2U0OWJhYWEzZTE%3D.jpg\",
\"onlineProductTitle\":\"单品测试001\",\"onlineTransactionId\":\"OUTBOUNDSMOKE7\",\"orderSkuId\":92169660,\"originalPrice\":0,\"payAmount\":0.0000,
\"paymentPrice\":0,\"platformDiscount\":0,\"promotionDiscount\":0.0000,\"quantity\":1,\"shippingPrice\":0.0000,\"sku\":\"DP001\",\"subSkuList\":[],
\"tag\":{\"allReturned\":0,\"hasRefund\":0,\"isGift\":0,\"onlineShipped\":0,\"preSale\":0}}],\"status\":\"WAIT_SHIP\",\"tag\":{\"allRefund\":0,\"allReturned\":0,
\"consolidated\":0,\"hasRefund\":0,\"itemReturned\":0,\"locked\":0,\"onlineShipFeedbackAlready\":0,\"onlineShipFeedbackFailed\":0,\"onlineShipped\":0,\"outOfStock\":0,
\"partRefund\":0,\"partReturned\":0,\"platformFulfillment\":0,\"preSale\":0,\"reShip\":0,\"sampleOrder\":0,\"sendFailed\":0,\"sendWms\":0,\"split\":0},
\"totalAmount\":0.0000,\"totalDiscount\":0,\"trackingNumber\":\"OUTBOUNDSMOKE7\",\"updateTime\":1754639644000,\"warehouse\":\"千仓1\",\"warehouseType\":\"BEST_GO\"},
\"state\":\"success\"}",
"requestId": "e9445212-3dc7-4cc5-b74c-6b2e8f0339b4"
}
失败时
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"errorCode\":\"order.id.exist\",\"errorMsg\":\"订单号已存在\",\"notSuccess\":true,\"state\":\"failure\"}",
"requestId": "045bdf1d-7e8e-4061-815a-6b0775d174f0"
}
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 | 请求结果 |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/salesOrder' \
--form 'appId="TEST"' \
--form 'serviceType="AUDIT_SALES_ORDER"' \
--form 'bizParam="{
\"warehouse\": \"千仓1\",
\"logistics\": \"YT-THZXR\",
\"shop\": \"Solaso-ERP\",
\"onlineOrderNumber\": \"OUTBOUNDSMOKE8\"
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="c7d1285bb277c3c0046d372aa1221512"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"state\":\"success\"}",
"requestId": "510060c5-915e-44bc-82af-9e3c6c922419"
}
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 | 请求结果 |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/salesOrder' \
--form 'appId="TEST"' \
--form 'serviceType="SEND_SALES_ORDER"' \
--form 'bizParam="{\"onlineOrderNumber\":\"OUTBOUNDSMOKE8\",\"shop\":\"Solaso-ERP\"}"' \
--form 'timestamp="1731742317"' \
--form 'sign="207b57c8a5c2df9df7180e5412f133c4"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"state\":\"success\"}",
"requestId": "510060c5-915e-44bc-82af-9e3c6c922419"
}
失败时:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"errorMsg\":\"审核下发失败,千仓报错反馈:error partnerId\",\"notSuccess\":true,\"state\":\"failure\"}",
"requestId": "abfa3c20-9d49-4838-bb2e-4f8ebb29bf92"
}
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 | |
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-否 |
请求示例:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/salesOrder' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_ORDER_PICK_UP_STATUS"' \
--form 'bizParam="{\"orderNumbers\":[\"S250808148148\"]}"' \
--form 'timestamp="1731742317"' \
--form 'sign="c0121bacd51d681359ad83ab8d743122"'
返回示例:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"orderNumber\":\"S250808148148\",\"status\":\"WAIT_SHIP\"}],\"state\":\"success\"}",
"requestId": "3b926772-2ac7-4b19-ac66-06b0cbfe54e8"
}