1. 库存
API URL
post {HTTP(S)地址}/api/{version}/inventory
1.1. 库存列表查询接口(已废弃,请使用v2版本的接口)
1.1.1. SERVICE_TYPE
QUERY_SIMPLE_LIST_INVENTORY
1.1.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
skuList |
N |
List<String> |
|
SKU数组 |
warehouse |
Y |
String |
“Amazon” |
千易系统仓库,最大50个字符 |
page |
Y |
Number |
1 |
页码,默认1 |
pageSize |
Y |
Number |
50 |
每页条数.不超过200条; 默认100 |
1.1.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
total |
Y |
Number |
100 |
总条数 |
result |
Y |
List<SkuInventory> |
|
库存列表信息,详情参考库存详情 |
SkuInventory(商品库存)
参数 |
是否必须 |
类型 |
示例 |
备注 |
sku |
Y |
String |
“abc” |
商品SKU |
warehouse |
Y |
String |
“FBA美国” |
仓库 |
total |
Y |
Number |
13 |
总量 |
available |
Y |
Number |
5 |
可用量 |
allocated |
Y |
Number |
5 |
占用量 |
shippingQuantity |
Y |
Number |
3 |
在途库存 |
purchaseShippingQuantity |
Y |
Number |
3 |
采购在途 |
firstLegShippingQuantity |
Y |
Number |
3 |
头程在途 |
transferShippingQuantity |
Y |
Number |
3 |
调拨在途 |
assemblyShippingQuantity |
Y |
Number |
3 |
加工在途 |
returnShippingQuantity |
Y |
Number |
3 |
退货在途 |
manualShippingQuantity |
Y |
Number |
3 |
手工在途 |
orderAllocated |
N |
Number |
3 |
订单占用量 |
firstLegAllocated |
N |
Number |
3 |
头程占用量 |
transferAllocated |
N |
Number |
3 |
调拨占用量 |
assemblyAllocated |
N |
Number |
3 |
加工单/拆分单占用量 |
请求示例
curl --location --request POST 'http://gerp-test1.800best.com/api/v1/asn' \
--form 'appId="CSBD_TEST"' \
--form 'serviceType="QUERY_ASN_LIST"' \
--form 'bizParam="{\"page\":1,\"pageSize\":2}"' \
--form 'timestamp="1741593077529"' \
--form 'sign="58d25c125dad27ca1257ef8135c59f69"'
返回示例
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"asnCustomFieldValueVOList\":[{\"candidateValue\":[],\"columCode\":
4,\"columName\":\"自定义日期栏位\",\"columType\":\"DATE\",\"customFieldId\":45,\"customFieldValueVOList\":[],\"customerId\":
3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":45,\"isQuery\":0,\"isShow\":0,\"required\":0}],\"asnNumber\":
\"A250305161890\",\"asnSkuVOList\":[{\"expectQuantity\":3,\"firstLegPrice\":0.00,\"isDeleted\":0,\"purchasePrice\":0.0000,\"receiveQuantity\":0,\"sku\":\"BS-02-02-250304-005\",\"title\":\"测试05\",\"transferPrice\":0.0000}]
,\"businessNumber\":\"B250305161889\",\"createTime\":\"2025-03-05 11:56:15\",\"isDeleted\":0,\"purchasePriceCurrency\":
\"CNY\",\"status\":\"SHIPPING\",\"tag\":{\"comparedTagValue\":63,\"fullTagValue\":1,\"overcharge\":0,\"receiveException\":
0,\"relation\":0,\"sendFailed\":0,\"sendWms\":1,\"waitBoxing\":0},\"type\":\"SALE_RETURN\",\"updateTime\":\"2025-03-05 11:56:
16\",\"warehouseName\":\"best warehouse(测试用)\"},{\"asnCustomFieldValueVOList\":[{\"candidateValue\":[],\"columCode\":
4,\"columName\":\"自定义日期栏位\",\"columType\":\"DATE\",\"customFieldId\":45,\"customFieldValueVOList\":[],\"customerId\":
3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":45,\"isQuery\":0,\"isShow\":0,\"required\":0}],\"asnNumber\":
\"A250305161887\",\"asnSkuVOList\":[{\"expectQuantity\":3,\"isDeleted\":0,\"purchasePrice\":10.0000,\"receiveQuantity\":3,\"sku\":\"DP002\",\"title\":\"DP002\"}]
,\"createTime\":\"2025-03-05 11:36:56\",\"finishTime\":\"2025-03-05 11:37:21\",\"firstLegPriceCurrency\":\"CNY\",\"isDeleted\":
0,\"purchasePriceCurrency\":\"CNY\",\"status\":\"FINISHED\",\"stockInTime\":\"2025-03-05 11:37:21\",\"tag\":{\"comparedTagValue\":
63,\"fullTagValue\":0,\"overcharge\":0,\"receiveException\":0,\"relation\":0,\"sendFailed\":0,\"sendWms\":0,\"waitBoxing\":
0},\"transferPriceCurrency\":\"CNY\",\"type\":\"MANUAL\",\"updateTime\":\"2025-03-05 11:37:21\",\"warehouseName\":
\"测试新增仓库商品下发\"}],\"state\":\"success\",\"total\":6288}",
"requestId": "f542824c-a964-4af8-b383-f38baffefec8"
}
1.2. 库存列表查询接口(V2)
1.2.1. SERVICE_TYPE
QUERY_SIMPLE_LIST_INVENTORY_V2
1.2.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
skuList |
N |
List<String> |
|
SKU数组 |
warehouse |
Y |
String |
“Amazon” |
千易系统仓库,最大50个字符 |
page |
Y |
Number |
1 |
页码,默认1 |
pageSize |
Y |
Number |
50 |
每页条数.不超过200条; 默认100 |
showCombine |
N |
boolean |
true |
是否查询组合品,默认为false |
showEmpty |
N |
boolean |
true |
是否查询0库存商品,默认为false |
originCurrency |
N |
boolean |
true |
是否返回原始币种,默认为false,此时币种转为CNY返回 |
fillCostAndGoods |
N |
boolean |
true |
是否返回成本/货值,默认为false |
1.2.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
total |
Y |
Number |
100 |
总条数 |
result |
Y |
List<SkuInventory> |
|
库存列表信息,详情参考库存详情 |
SkuInventory(商品库存)
参数 |
是否必须 |
类型 |
示例 |
备注 |
sku |
Y |
String |
“abc” |
商品SKU |
skuName |
Y |
String |
“测试商品” |
商品名称 |
warehouse |
Y |
String |
“FBA美国” |
仓库名称 |
warehouseCode |
Y |
String |
“18991” |
仓库编码 |
total |
Y |
Number |
13 |
总量 |
available |
Y |
Number |
5 |
可用量 |
allocated |
Y |
Number |
5 |
占用量 |
unavailable |
Y |
Number |
5 |
不可用量 |
shippingQuantity |
Y |
Number |
3 |
在途库存 |
purchaseShippingQuantity |
Y |
Number |
3 |
采购在途 |
firstLegShippingQuantity |
Y |
Number |
3 |
头程在途 |
transferShippingQuantity |
Y |
Number |
3 |
调拨在途 |
assemblyShippingQuantity |
Y |
Number |
3 |
加工在途 |
returnShippingQuantity |
Y |
Number |
3 |
退货在途 |
manualShippingQuantity |
Y |
Number |
3 |
手工在途 |
orderAllocated |
N |
Number |
3 |
订单占用量 |
firstLegAllocated |
N |
Number |
3 |
头程占用量 |
transferAllocated |
N |
Number |
3 |
调拨占用量 |
assemblyAllocated |
N |
Number |
3 |
加工单/拆分单占用量 |
totalCost |
N |
Number |
3 |
在库成本,总成本 |
availableCost |
N |
Number |
3 |
可用成本 |
unavailableCost |
N |
Number |
3 |
不良品成本,不可用成本 |
allocatedCost |
N |
Number |
3 |
占用成本 |
shippingCost |
N |
Number |
3 |
在途成本 |
totalGoods |
N |
Number |
3 |
在库货值,总货值 |
unavailableGoods |
N |
Number |
3 |
不良品货值,不可用货值 |
availableGoods |
N |
Number |
3 |
可用货值 |
allocatedGoods |
N |
Number |
3 |
占用货值 |
shippingGoods |
N |
Number |
3 |
在途货值 |
1.3. 库存日志查询接口
1.3.1. SERVICE_TYPE
QUERY_INVENTORY_LOG_LIST
1.3.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
operateTimeFrom |
Y |
String |
2025-01-18 00:00:00 |
操作开始时间 |
operateTimeTo |
Y |
String |
2025-02-18 00:00:00 |
操作结束时间 |
createTimeFrom |
Y |
String |
2025-01-18 00:00:00 |
创建开始时间 |
createTimeTo |
Y |
String |
2025-02-18 00:00:00 |
创建结束时间 |
warehouseName |
N |
String |
仓库名称 |
仓库名称 |
storageLocation |
N |
String |
SYS LOC |
库位code |
operateType |
N |
String |
FIRST_LEG |
一级分类,和typeList参数互斥,见枚举 |
billNumber |
N |
String |
A1111 |
单号搜索 |
sku |
N |
String |
S90 |
Sku搜索 |
inventoryType |
N |
String |
IN_TRANSIT |
库存类型:IN_TRANSIT->在途,AVAILABLE->在库 |
typeList |
N |
List<String> |
[“I_PLAN”,” S_PLAN”] |
二级分类,同时存在一级和二级分类,一级分类覆盖二级分类和operateType互斥,见枚举 |
recordTypeList |
N |
List<String> |
[“DECREASE ”,” MODIFY”] |
库存同步日志操作类型筛选,见枚举类型 |
page |
Y |
Number |
1 |
页码,默认1 |
pageSize |
Y |
Number |
50 |
每页条数.不超过200条; 默认100 |
1.3.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
total |
Y |
Number |
100 |
总条数 |
result |
Y |
List<InventoryLog> |
|
库存日志列表信息 |
SkuInventory(商品库存)
参数 |
是否必须 |
类型 |
示例 |
备注 |
sku |
Y |
String |
“abc” |
商品SKU |
warehouseName |
Y |
String |
“FBA美国” |
仓库 |
storageLocation |
Y |
String |
SYS LOC |
库位code |
operateType |
Y |
String |
DECREASE |
库存日志记录修改类型,见枚举 |
billNumber |
Y |
String |
A1111 |
业务单号 |
inTransitBefore |
Y |
Long |
0 |
更新前在途数量 |
inTransitAfter |
Y |
Long |
0 |
更新后在途数量 |
inTransitDiff |
Y |
Long |
0 |
更新在途数量差值 |
inventoryBefore |
Y |
Long |
0 |
更新前库存数量 |
inventoryAfter |
Y |
Long |
0 |
更新后库存数量 |
inventoryDiff |
Y |
Long |
0 |
更新在库存差值 |
batchNumber |
N |
String |
A111 |
入库批次号 |
operator |
Y |
String |
操作人 |
操作人 |
operateTime |
Y |
String |
2022-09-01 00:00:00 |
操作时间 |
bizType |
Y |
String |
I_PLAN |
二级分类,见枚举 |
cost |
N |
BigDecimal |
100 |
库存成本 |
uniqueId |
Y |
Long |
1111 |
业务唯一id |
1.4. 加工单查询接口
1.4.1. SERVICE_TYPE
QUERY_INVENTORY_ASSEMBLY_LIST
1.4.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
assemblyNumber |
Y |
String |
|
加工单号 与 创建时间二选一 |
createTimeFrom |
Y |
String |
“2023-10-25” |
创建开始时间 |
createTimeTo |
Y |
String |
“2023-10-25” |
创建结束时间 |
warehouseName |
N |
String |
|
仓库名称 |
page |
Y |
Number |
1 |
页码,默认1 |
pageSize |
Y |
Number |
50 |
每页条数.不超过200条; 默认20 |
1.4.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
bizContent |
Y |
ASSEMBLY |
|
请参考ASSEMBLYInfo |
ASSEMBLYInfo
参数 |
是否必须 |
类型 |
示例 |
备注 |
assemblyNumber |
Y |
String |
|
加工单号 |
warehouseName |
Y |
String |
|
仓库名称 |
status |
Y |
String |
|
加工单状态:assemblyStatus |
asnNumber |
N |
String |
|
入库单号 |
finishTime |
N |
String |
2022-09-05 15:27:18 |
完成时间 |
customNumber |
N |
String |
|
参考号 |
createTime |
Y |
String |
|
创建时间 |
assemblyList |
Y |
List |
|
商品信息:Assembly |
processStartTime |
N |
String |
|
加工开始时间 |
processEndTime |
N |
String |
|
加工结束时间 |
workers |
N |
List |
|
加工员:Worker |
Assembly
参数 |
是否必须 |
类型 |
示例 |
备注 |
sku |
Y |
String |
|
商品编码 |
status |
Y |
String |
|
商品状态assemblySkuStatus |
expectQuantity |
Y |
Number |
|
预计加工数量 |
processedQuantity |
Y |
Number |
|
加工完成数量 |
parts |
Y |
List |
|
子件sku:Part |
Part
参数 |
是否必须 |
类型 |
示例 |
备注 |
sku |
Y |
String |
|
商品编码 |
expectQuantity |
Y |
Number |
|
子件预计消耗数量 |
quantity |
Y |
Number |
|
子件实际消耗数量 |
Worker
参数 |
是否必须 |
类型 |
示例 |
备注 |
name |
Y |
String |
|
物流ID |
assemblyStatus
状态 |
备注 |
NEW |
新建 |
PROCESSING |
加工中 |
DONE |
已完成 |
WAIT_PROCESS |
待加工 |
SEND_WMS_FAILED |
下发失败 |
CLOSED |
已关闭 |
assemblySkuStatus
状态 |
备注 |
UN_PROCESSED |
未加工 |
PROCESSING |
加工中 |
RECEIVING |
收货中 |
DONE |
已完成 |
CLOSED |
已关闭 |
1.5. 调拨单(可用调拨)创建接口
1.5.1. SERVICE_TYPE
CREATE_TRANSFER_AVAILABLE_ORDER
1.5.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
warehouseName |
Y |
String |
|
出货仓库名称 |
destWarehouseName |
Y |
String |
|
目的仓库名称 |
customNumber |
Y |
String |
|
参考号 |
logisticsName |
Y |
Number |
|
物流方式名称 |
trackNumber |
Y |
Number |
|
跟踪号 |
preReceiveTime |
N |
String |
|
预计到货时间 |
remark |
N |
String |
|
备注 |
skuList |
Y |
List |
|
Sku信息 |
Sku
参数 |
是否必须 |
类型 |
示例 |
备注 |
fbaNo |
Y |
String |
|
FBA货件号目的仓为FBA时必填 |
refId |
N |
String |
|
RefID |
sku |
Y |
String |
|
商品编码 |
transferQty |
Y |
Number |
|
调拨数量 |
originalAsnNumber |
Y |
Number |
|
入库单号 |
packingRate |
N |
Number |
|
单箱数量(pcs) |
netWeight |
N |
Number |
|
净重(KG) |
weight |
N |
List |
|
毛重(KG) |
length |
N |
Number |
|
长度(m) |
width |
N |
Number |
|
宽度(m) |
height |
N |
Number |
|
高度(m) |
apiCustom |
N |
String |
|
1.6. 调拨单查询接口
1.6.1. SERVICE_TYPE
QUERY_INVENTORY_TRANSFER_LIST
1.6.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
createTimeFrom |
创建时间和单号二者必填一个; |
String |
2024-01-01 00:00:00 |
创建时间(开始) |
createTimeTo |
创建时间和单号二者必填一个; |
String |
2024-01-02 00:00:00 |
创建时间(结束) |
numberParam |
创建时间和单号二者必填一个; |
String |
TF231123001 |
参考号/调拨单号/入库单号/跟踪号 |
status |
N |
String |
NEW |
调拨单状态 |
page |
Y |
Number |
1 |
页码,默认1 |
pageSize |
Y |
Number |
100 |
每页条数,不超过200。默认100 |
1.6.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
total |
Y |
Number |
100 |
总条数 |
result |
Y |
List |
|
详见TransferVO |
TransferVO
参数 |
是否必须 |
类型 |
示例 |
备注 |
transferNumber |
Y |
String |
TF231123001 |
调拨单号 |
type |
Y |
String |
PLAN |
调拨单类型。PLAN:计划库存调拨;AVAILABLE:可用库存调拨 |
destWarehouseType |
Y |
String |
AMAZON |
目的仓类型。调拨至FBA仓库:AMAZON;调拨至海外仓库:非AMAZON |
status |
Y |
String |
NEW |
调拨单状态 |
createTime |
Y |
Date |
1702275432000 |
调拨单创建时间 |
updateTime |
Y |
Date |
1702275432000 |
调拨单更新时间 |
customNumber |
N |
String |
ref123 |
参考号 |
warehouseName |
Y |
String |
千仓1 |
出货仓库 |
destWarehouseName |
Y |
String |
|
目的仓库 |
logisticsName |
N |
String |
|
物流方式 |
trackNumber |
N |
String |
|
跟踪号 |
preReceiveTime |
N |
Date |
1702275432000 |
预计到货时间 |
remark |
N |
String |
|
单据备注 |
skuVOList |
Y |
List |
|
商品信息。详见SkuVO |
feeList |
N |
List |
|
费用信息。详见FeeVO |
SkuVO
参数 |
是否必须 |
类型 |
示例 |
备注 |
id |
Y |
Long |
1 |
ID |
fbaNo |
N |
String |
FBA2022051288 |
货件编号 |
refId |
N |
String |
21333222 |
REFID |
sku |
Y |
String |
S90 |
商品SKU |
expectedQuantity |
N |
Number |
1 |
预计到货数量 |
receiveQuantity |
N |
Number |
1 |
实际到货数量 |
packingRate |
N |
Number |
1 |
单箱数量 |
cdNetWeight |
N |
Number |
1 |
单箱净重 |
cdWeightUnit |
N |
String |
KG |
单箱净重单位。KG |
cdWeight |
N |
Number |
0.5 |
单箱毛重 |
cdWeightUnit |
N |
String |
KG |
单箱毛重单位。KG |
cartonLength |
N |
Number |
1 |
单箱长度 |
cartonWidth |
N |
Number |
1 |
单箱宽度 |
cartonHeight |
N |
Number |
1 |
单箱高度 |
cartonDimensionUnit |
N |
String |
m |
长度单位。m 米 |
FeeVO
参数 |
是否必须 |
类型 |
示例 |
备注 |
name |
Y |
String |
调整费用 |
费用名称 |
amount |
Y |
BigDecimal |
100 |
应付金额 |
appliedAmount |
N |
BigDecimal |
100 |
已申请金额 |
paidAmount |
N |
BigDecimal |
100 |
已付金额 |
invalidAmount |
N |
BigDecimal |
0 |
已关闭/作废金额 |
status |
Y |
String |
NEW |
费用状态 |
1.7. 拆分单查询接口
1.7.1. SERVICE_TYPE
QUERY_INVENTORY_RESTORE_LIST
1.7.2. 请求参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
orderNumber |
Y |
String |
|
拆分单号 与 创建时间二选一 |
orderTimeFrom |
Y |
String |
“2023-10-25” |
创建开始时间 |
orderTimeTo |
Y |
String |
“2023-10-25” |
创建结束时间 |
warehouseName |
N |
String |
|
仓库名称 |
page |
Y |
Number |
1 |
页码,默认1 |
pageSize |
Y |
Number |
50 |
每页条数.不超过200条; 默认20 |
1.7.3. 返回参数
参数 |
是否必须 |
类型 |
示例 |
备注 |
errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
错误码 |
errorMsg |
Y |
String |
“输入参数不对” |
业务错误信息 |
state |
Y |
String |
success |
请求结果 |
bizContent |
Y |
RestoreOrder |
|
请参考RestoreOrder |
RestoreOrder
参数 |
是否必须 |
类型 |
示例 |
备注 |
orderNumber |
Y |
String |
|
拆分单号 |
warehouseName |
Y |
String |
|
仓库名称 |
status |
Y |
String |
|
拆分单状态:RestoreOrderStatus |
asnNumber |
N |
String |
|
入库单号 |
customNumber |
N |
String |
|
参考号 |
orderTime |
Y |
Number |
1660034211000 |
创建时间 |
skuList |
Y |
List |
|
商品信息:RestoreOrderSku |
remarkList |
N |
List |
|
备注 |
restoreOrderStartTime |
N |
Number |
|
拆分开始时间 |
restoreOrderEndTime |
N |
Number |
|
拆分结束时间 |
finishTime |
N |
Number |
|
入库完成时间 |
workerList |
N |
List |
|
拆分员Worker |
RestoreOrderStatus
状态 |
备注 |
NEW |
新建 |
WAIT_PROCESS |
待拆分 |
DOING |
拆分中 |
FINISH |
已完成 |
SEND_WMS_FAILED |
下发失败 |
WAIT_PROCESS |
已关闭 |
DELETED |
已删除 |
RestoreOrderSku
参数 |
是否必须 |
类型 |
示例 |
备注 |
sku |
Y |
String |
|
SKU |
title |
Y |
String |
|
商品名 |
picUrl |
Y |
String |
|
图片 |
expectedQty |
Y |
Number |
|
预计拆分数量 |
completedQty |
Y |
Number |
|
已拆分数量 |
totalFee |
Y |
Number |
|
总拆分费用 |
totalCost |
Y |
Number |
|
已拆分组装品的成本之和 |
partList |
Y |
List |
|
拆分配件RestoreOrderSkuPart |
RestoreOrderSkuPart
参数 |
是否必须 |
类型 |
示例 |
备注 |
id |
Y |
Long |
1 |
ID |
sku |
Y |
String |
S90 |
商品SKU |
title |
Y |
String |
|
商品名 |
picUrl |
N |
String |
|
图片 |
partRate |
N |
Number |
1 |
partRate |
totalReceivedQty |
N |
Number |
1 |
已收货入库的配件数量 |
purchasePrice |
N |
Number |
100 |
采购价 |
totalCost |
N |
Number |
100 |
总费用 = 已收货入库数量 * (采购价 + 每个配件均摊的拆分费用) |
Worker
参数 |
是否必须 |
类型 |
示例 |
备注 |
name |
Y |
String |
name |
拆分员名称 |
userId |
Y |
Long |
11 |
id |
username |
Y |
String |
|
账号 |