1. Inventory
API URL
post {HTTP(S)host}/api/{version}/inventory
1.1. Inventory Query List (Deprecated,use v2 please)
1.1.1. SERVICE_TYPE
QUERY_SIMPLE_LIST_INVENTORY
1.1.2. Request
| Params |
Require |
DataType |
Sample |
Description |
| skuList |
N |
List<String> |
|
SKU list |
| warehouse |
Y |
String |
“Amazon” |
QERP warehouse, up to 50 characters |
| page |
Y |
Number |
1 |
Page number, default 1 |
| pageSize |
Y |
Number |
50 |
Number of records per page. no more than 200; Default is 100 |
1.1.3. Reponse
| Params |
Require |
DataType |
Sample |
Description |
| errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
Error Code |
| errorMsg |
Y |
String |
“The input of Params is incorrect” |
Business Error Messages |
| state |
Y |
String |
success |
Response State |
| total |
Y |
Number |
100 |
Total num |
| result |
Y |
List<SkuInventory> |
|
For inventory list information, see Inventory Details |
SkuInventory(商品库存)
| Params |
Require |
DataType |
Sample |
Description |
| sku |
Y |
String |
“abc” |
sku |
| warehouse |
Y |
String |
“FBA美国” |
warehouse |
| total |
Y |
Number |
13 |
totalAmount |
| available |
Y |
Number |
5 |
Available amount |
| allocated |
Y |
Number |
5 |
Occupancy |
| shippingQuantity |
Y |
Number |
3 |
Inventory in transit |
| purchaseShippingQuantity |
Y |
Number |
3 |
Purchase is in transit |
| firstLegShippingQuantity |
Y |
Number |
3 |
The first journey is on the way |
| transferShippingQuantity |
Y |
Number |
3 |
Transfers are on the way |
| assemblyShippingQuantity |
Y |
Number |
3 |
Processing in transit |
| returnShippingQuantity |
Y |
Number |
3 |
Returns are in transit |
| manualShippingQuantity |
Y |
Number |
3 |
Manual on the way |
| orderAllocated |
N |
Number |
3 |
Order Occupancy |
| firstLegAllocated |
N |
Number |
3 |
Head-trip occupancy |
| transferAllocated |
N |
Number |
3 |
Allocation of occupancy |
| assemblyAllocated |
N |
Number |
3 |
The usage of processing order/split order |
request example
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"'
response example
{
"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. Inventory Query List (V2)
1.2.1. SERVICE_TYPE
QUERY_SIMPLE_LIST_INVENTORY_V2
1.2.2. Request
| Params |
Require |
DataType |
Sample |
Description |
| skuList |
N |
List<String> |
|
SKU list |
| warehouse |
Y |
String |
“Amazon” |
QERP Warehouse, up to 50 characters |
| page |
Y |
Number |
1 |
Page number, default 1 |
| pageSize |
Y |
Number |
50 |
Number of records per page. no more than 200; Default is 100 |
| showCombine |
N |
boolean |
true |
Whether to query combination products, default is false |
| showEmpty |
N |
boolean |
true |
Whether to query 0 inventory products, default is false |
| originCurrency |
N |
boolean |
true |
Whether return data in original currency,default is false, return CNY |
| fillCostAndGoods |
N |
boolean |
true |
Whether to return cost/goods value, default is false |
1.2.3. Reponse
| Params |
Require |
DataType |
Sample |
Description |
| errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
Error Code |
| errorMsg |
Y |
String |
“The input of Params is incorrect” |
Business Error Messages |
| state |
Y |
String |
success |
Response State |
| total |
Y |
Number |
100 |
Total num |
| result |
Y |
List<SkuInventory> |
|
For inventory list information, see Inventory Details |
SkuInventory
| Params |
Require |
DataType |
Sample |
Description |
| sku |
Y |
String |
“abc” |
sku |
| skuName |
Y |
String |
“测试商品” |
The title of the product |
| warehouse |
Y |
String |
“FBA美国” |
Warehouse name |
| warehouseCode |
Y |
String |
“18991” |
warehouse code |
| total |
Y |
Number |
13 |
totalAmount |
| available |
Y |
Number |
5 |
availableAmount |
| allocated |
Y |
Number |
5 |
Occupancy |
| unavailable |
Y |
Number |
5 |
unavailableAmount |
| shippingQuantity |
Y |
Number |
3 |
Inventory in transit |
| purchaseShippingQuantity |
Y |
Number |
3 |
Purchase is in transit |
| firstLegShippingQuantity |
Y |
Number |
3 |
The first journey is on the way |
| transferShippingQuantity |
Y |
Number |
3 |
Transfers are on the way |
| assemblyShippingQuantity |
Y |
Number |
3 |
Processing in transit |
| returnShippingQuantity |
Y |
Number |
3 |
Returns are in transit |
| manualShippingQuantity |
Y |
Number |
3 |
Manual on the way |
| orderAllocated |
N |
Number |
3 |
Order Occupancy |
| firstLegAllocated |
N |
Number |
3 |
Head-trip occupancy |
| transferAllocated |
N |
Number |
3 |
Allocation of occupancy |
| assemblyAllocated |
N |
Number |
3 |
The usage of processing order/split order |
| totalCost |
N |
Number |
3 |
Inventory cost, total cost |
| availableCost |
N |
Number |
3 |
Available cost |
| unavailableCost |
N |
Number |
3 |
Defective product cost, unusable cost |
| allocatedCost |
N |
Number |
3 |
Occupancy cost |
| shippingCost |
N |
Number |
3 |
In ship costs |
| totalGoods |
N |
Number |
3 |
Inventory value, total inventory value |
| unavailableGoods |
N |
Number |
3 |
Value of defective products, value of unusable goods |
| availableGoods |
N |
Number |
3 |
Available value of goods |
| allocatedGoods |
N |
Number |
3 |
Occupation value of goods |
| shippingGoods |
N |
Number |
3 |
Value of goods in ship |
1.3. Query inventory logs
1.3.1. SERVICE_TYPE
QUERY_INVENTORY_LOG_LIST
1.3.2. Request
| Params |
Require |
DataType |
Sample |
Description |
| operateTimeFrom |
Y |
String |
2022-09-01 |
The start time of the operation |
| operateTimeTo |
Y |
String |
2022-09-01 |
The end time of the operation |
| warehouseName |
N |
String |
Warehouse name |
Warehouse name |
| storageLocation |
N |
String |
SYS LOC |
Bin locationcode |
| operateType |
N |
String |
FIRST_LEG |
The first-level classification, which is mutually exclusive with typeListParams, is listed in Enumeration |
| billNumber |
N |
String |
A1111 |
number Search |
| sku |
N |
String |
S90 |
SKU Search |
| inventoryType |
N |
String |
IN_TRANSIT |
Inventory type：IN_TRANSIT->在途，AVAILABLE->在库 |
| typeList |
N |
List<String> |
[“I_PLAN”,” S_PLAN”] |
Secondary classification, there are both primary and secondary classifications, and the primary classification covers the secondary classification andoperateTypeMutually exclusive, see enumeration |
| recordTypeList |
N |
List<String> |
[“DECREASE ”,” MODIFY”] |
For inventory synchronization log operation type filtering, see Enumeration Type |
| page |
Y |
Number |
1 |
Page number, default 1 |
| pageSize |
Y |
Number |
50 |
Number of records per page. no more than 200; Default is 100 |
1.3.3. Reponse
| Params |
Require |
DataType |
Sample |
Description |
| errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
Error Code |
| errorMsg |
Y |
String |
“The input of Params is incorrect” |
Business Error Messages |
| state |
Y |
String |
success |
Response State |
| total |
Y |
Number |
100 |
Total num |
| result |
Y |
List<InventoryLog> |
|
Inventory journal list information |
SkuInventory
| Params |
Require |
DataType |
Sample |
Description |
| sku |
Y |
String |
“abc” |
sku |
| warehouseName |
Y |
String |
“FBA美国” |
warehouse |
| storageLocation |
Y |
String |
SYS LOC |
Bin locationcode |
| operateType |
Y |
String |
DECREASE |
For inventory logging modification types, see Enumeration |
| billNumber |
Y |
String |
A1111 |
business number |
| inTransitBefore |
Y |
Long |
0 |
Number of in-transit before update |
| inTransitAfter |
Y |
Long |
0 |
Number of in-transit after updating |
| inTransitDiff |
Y |
Long |
0 |
Update the in-transit quantity variance |
| inventoryBefore |
Y |
Long |
0 |
The inventory quantity before the update |
| inventoryAfter |
Y |
Long |
0 |
The updated inventory quantity |
| inventoryDiff |
Y |
Long |
0 |
Update the difference in inventory |
| batchNumber |
N |
String |
A111 |
receive batches number |
| operator |
Y |
String |
Operator |
Operator |
| operateTime |
Y |
String |
2022-09-01 00:00:00 |
Operating time |
| bizType |
Y |
String |
I_PLAN |
Secondary classifications, see enumeration |
| cost |
N |
BigDecimal |
100 |
Inventory costs |
| uniqueId |
Y |
Long |
1111 |
Unique ID of the service |
1.4. Query assembly order list
1.4.1. SERVICE_TYPE
QUERY_INVENTORY_ASSEMBLY_LIST
1.4.2. Request
| Params |
Require |
DataType |
Sample |
Description |
| assemblyNumber |
Y |
String |
|
assemblyNumber or createTime must use one |
| createTimeFrom |
Y |
String |
“2023-10-25” |
Create a start time |
| createTimeTo |
Y |
String |
“2023-10-25” |
The end time of creation |
| warehouseName |
N |
String |
|
Warehouse name |
| page |
Y |
Number |
1 |
Page number, default 1 |
| pageSize |
Y |
Number |
50 |
Number of records per page. no more than 200; Default is 20 |
1.4.3. Reponse
| Params |
Require |
DataType |
Sample |
Description |
| errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
Error Code |
| errorMsg |
Y |
String |
“The input of Params is incorrect” |
Business Error Messages |
| state |
Y |
String |
success |
Response State |
| bizContent |
Y |
ASSEMBLY |
|
see ASSEMBLYInfo |
ASSEMBLYInfo
| Params |
Require |
DataType |
Sample |
Description |
| assemblyNumber |
Y |
String |
|
assembly order number |
| warehouseName |
Y |
String |
|
Warehouse name |
| status |
Y |
String |
|
assembly order status:assemblyStatus |
| asnNumber |
N |
String |
|
Inbound order number |
| finishTime |
N |
String |
2022-09-05 15:27:18 |
Completion time |
| customNumber |
N |
String |
|
Reference number |
| createTime |
Y |
String |
|
Creation time |
| assemblyList |
Y |
List |
|
Product Information:Assembly |
| processStartTime |
N |
String |
|
Processing start time |
| processEndTime |
N |
String |
|
Processing end time |
| workers |
N |
List |
|
Processors:Worker |
Assembly
| Params |
Require |
DataType |
Sample |
Description |
| sku |
Y |
String |
|
SKU code |
| status |
Y |
String |
|
assemblySkuStatus |
| expectQuantity |
Y |
Number |
|
Estimated number of processing |
| processedQuantity |
Y |
Number |
|
The number of processing completed |
| parts |
Y |
List |
|
Sub-part SKU:Part |
Part
| Params |
Require |
DataType |
Sample |
Description |
| sku |
Y |
String |
|
sku code |
| expectQuantity |
Y |
Number |
|
The estimated quantity of the child to be consumed |
| quantity |
Y |
Number |
|
The actual quantity of the child consumed |
Worker
| Params |
Require |
DataType |
Sample |
Description |
| name |
Y |
String |
|
Logistics ID |
assemblyStatus
| status |
Description |
| NEW |
new |
| PROCESSING |
Processing |
| DONE |
Done |
| WAIT_PROCESS |
To be processed |
| SEND_WMS_FAILED |
send Failed |
| CLOSED |
Closed |
assemblySkuStatus
| Status |
Description |
| UN_PROCESSED |
Unprocessed |
| PROCESSING |
Processing |
| RECEIVING |
Receiving goods |
| DONE |
Done |
| CLOSED |
Closed |
1.5. Create transfer order
1.5.1. SERVICE_TYPE
CREATE_TRANSFER_AVAILABLE_ORDER
1.5.2. Request
| Params |
Require |
DataType |
Sample |
Description |
| warehouseName |
Y |
String |
|
Outbound Warehouse name |
| destWarehouseName |
Y |
String |
|
dest Warehouse name |
| customNumber |
Y |
String |
|
Reference number |
| logisticsName |
Y |
Number |
|
Logistics Name |
| trackNumber |
Y |
Number |
|
Tracking number |
| preReceiveTime |
N |
String |
|
Estimated time of arrival |
| remark |
N |
String |
|
Description |
| skuList |
Y |
List |
|
Sku info |
Sku
| Params |
Require |
DataType |
Sample |
Description |
| fbaNo |
Y |
String |
|
FBA货件号目的仓为FBA时 Require |
| refId |
N |
String |
|
RefID |
| sku |
Y |
String |
|
商品 code |
| transferQty |
Y |
Number |
|
调拨数量 |
| originalAsnNumber |
Y |
Number |
|
Inbound order number |
| packingRate |
N |
Number |
|
Number of single boxes （pcs） |
| netWeight |
N |
Number |
|
net weight （KG） |
| weight |
N |
List |
|
gross weight （KG） |
| length |
N |
Number |
|
length （m） |
| width |
N |
Number |
|
width （m） |
| height |
N |
Number |
|
height （m） |
| apiCustom |
N |
String |
|
1.6. Query transfer order list
1.6.1. SERVICE_TYPE
QUERY_INVENTORY_TRANSFER_LIST
1.6.2. Request
| Params |
Require |
DataType |
Sample |
Description |
| createTimeFrom |
Creation time 和 number 二者 Require 一个； |
String |
2024-01-01 00:00:00 |
Creation time start |
| createTimeTo |
Creation time 和 number 二者 Require 一个； |
String |
2024-01-02 00:00:00 |
Creation time end |
| numberParam |
Creation time 和 number 二者 Require 一个； |
String |
TF231123001 |
Reference number /transfer order number / Inbound order number /Tracking number |
| status |
N |
String |
NEW |
Transfer order status |
| page |
Y |
Number |
1 |
Page number, default 1 |
| pageSize |
Y |
Number |
100 |
The number of records per page shall not exceed 200. Default is 100 |
1.6.3. Reponse
| Params |
Require |
DataType |
Sample |
Description |
| errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
Error Code |
| errorMsg |
Y |
String |
“The input of Params is incorrect” |
Business Error Messages |
| state |
Y |
String |
success |
Response State |
| total |
Y |
Number |
100 |
Total num |
| result |
Y |
List |
|
See TransferVO |
TransferVO
| Params |
Require |
DataType |
Sample |
Description |
| transferNumber |
Y |
String |
TF231123001 |
transfer order number |
| type |
Y |
String |
PLAN |
The type of transfer order: PLAN,AVAILABLE. |
| destWarehouseType |
Y |
String |
AMAZON |
The type of the destination warehouse. Transfer to FBA warehouse:AMAZON,NOT AMAZON |
| status |
Y |
String |
NEW |
Transfer order status |
| createTime |
Y |
Date |
1702275432000 |
Transfer order Creation time |
| updateTime |
Y |
Date |
1702275432000 |
Transfer order Update time |
| customNumber |
N |
String |
ref123 |
Reference number |
| warehouseName |
Y |
String |
千仓1 |
source warehouse |
| destWarehouseName |
Y |
String |
|
dest warehouse |
| logisticsName |
N |
String |
|
Logistics Name |
| trackNumber |
N |
String |
|
Tracking number |
| preReceiveTime |
N |
Date |
1702275432000 |
Estimated time of arrival |
| remark |
N |
String |
|
Order remarks |
| skuVOList |
Y |
List |
|
Product information。 See SkuVO |
| feeList |
N |
List |
|
Fee information。 See FeeVO |
SkuVO
| Params |
Require |
DataType |
Sample |
Description |
| id |
Y |
Long |
1 |
ID |
| fbaNo |
N |
String |
FBA2022051288 |
Shipment ID |
| refId |
N |
String |
21333222 |
REFID |
| sku |
Y |
String |
S90 |
sku |
| expectedQuantity |
N |
Number |
1 |
Estimated arrival quantity |
| receiveQuantity |
N |
Number |
1 |
Actual Arrival Quantity |
| packingRate |
N |
Number |
1 |
Number of single boxes |
| cdNetWeight |
N |
Number |
1 |
Single box net weight |
| cdWeightUnit |
N |
String |
KG |
Single box net weight unit:KG |
| cdWeight |
N |
Number |
0.5 |
Single box gross weight |
| cdWeightUnit |
N |
String |
KG |
Single box gross weight unit:KG |
| cartonLength |
N |
Number |
1 |
Single box length |
| cartonWidth |
N |
Number |
1 |
Single box width |
| cartonHeight |
N |
Number |
1 |
Single box height |
| cartonDimensionUnit |
N |
String |
m |
Units of length：m |
FeeVO
| Params |
Require |
DataType |
Sample |
Description |
| name |
Y |
String |
Adjust fees |
Name of the expense |
| amount |
Y |
BigDecimal |
100 |
Amount due |
| appliedAmount |
N |
BigDecimal |
100 |
The amount requested |
| paidAmount |
N |
BigDecimal |
100 |
The amount paid |
| invalidAmount |
N |
BigDecimal |
0 |
Closed/voided amounts |
| status |
Y |
String |
NEW |
Transfer order charge status |
1.7. Query split order list
1.7.1. SERVICE_TYPE
QUERY_INVENTORY_RESTORE_LIST
1.7.2. Request
| Params |
Require |
DataType |
Sample |
Description |
| orderNumber |
Y |
String |
|
orderNumber or orderTime is require |
| orderTimeFrom |
Y |
String |
“2023-10-25” |
Create a start time |
| orderTimeTo |
Y |
String |
“2023-10-25” |
The end time of creation |
| warehouseName |
N |
String |
|
Warehouse name |
| page |
Y |
Number |
1 |
Page number, default 1 |
| pageSize |
Y |
Number |
50 |
Number of records per page. no more than 200; Default is 20 |
1.7.3. Reponse
| Params |
Require |
DataType |
Sample |
Description |
| errorCode |
Y |
String |
“DATA_INPUT_ERROR” |
Error Code |
| errorMsg |
Y |
String |
“The input of Params is incorrect” |
Business Error Messages |
| state |
Y |
String |
success |
Response State |
| bizContent |
Y |
RestoreOrder |
|
see RestoreOrder |
RestoreOrder
| Params |
Require |
DataType |
Sample |
Description |
| orderNumber |
Y |
String |
|
Split order number |
| warehouseName |
Y |
String |
|
Warehouse name |
| status |
Y |
String |
|
Split status:RestoreOrderStatus |
| asnNumber |
N |
String |
|
Inbound order number |
| customNumber |
N |
String |
|
Reference number |
| orderTime |
Y |
Number |
1660034211000 |
Creation time |
| skuList |
Y |
List |
|
Product information:RestoreOrderSku |
| remarkList |
N |
List |
|
Description |
| restoreOrderStartTime |
N |
Number |
|
Split start time |
| restoreOrderEndTime |
N |
Number |
|
Split end time |
| finishTime |
N |
Number |
|
Inbound Completion time |
| workerList |
N |
List |
|
Splitter Worker |
RestoreOrderStatus
| status |
Description |
| NEW |
new |
| WAIT_PROCESS |
To be split |
| DOING |
Splitting |
| FINISH |
Done |
| SEND_WMS_FAILED |
send to wms faild |
| WAIT_PROCESS |
Closed |
| DELETED |
Deleted |
RestoreOrderSku
| Params |
Require |
DataType |
Sample |
Description |
| sku |
Y |
String |
|
SKU |
| title |
Y |
String |
|
sku title |
| picUrl |
Y |
String |
|
image |
| expectedQty |
Y |
Number |
|
Estimated number of splits |
| completedQty |
Y |
Number |
|
Split quantity |
| totalFee |
Y |
Number |
|
Total split fee |
| totalCost |
Y |
Number |
|
The sum of the costs of the split assembly |
| partList |
Y |
List |
|
Split the fitting RestoreOrderSkuPart |
RestoreOrderSkuPart
| Params |
Require |
DataType |
Sample |
Description |
| id |
Y |
Long |
1 |
ID |
| sku |
Y |
String |
S90 |
sku |
| title |
Y |
String |
|
trade name |
| picUrl |
N |
String |
|
image |
| partRate |
N |
Number |
1 |
partRate |
| totalReceivedQty |
N |
Number |
1 |
The number of parts that have been received and put into storage |
| purchasePrice |
N |
Number |
100 |
Purchase price |
| totalCost |
N |
Number |
100 |
Total Charge = Received Inbound Quantity * (Purchase Price + Split Fee Spread Per Part) |
Worker
| Params |
Require |
DataType |
Sample |
Description |
| name |
Y |
String |
name |
The name of the splitter |
| userId |
Y |
Long |
11 |
id |
| username |
Y |
String |
|
Account |