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 |
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. 库存列表查询接口(V2)
1.3.1. SERVICE_TYPE
QUERY_SIMPLE_LIST_INVENTORY_V2
1.3.2. 请求参数
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| skuList | N | List<String> | SKU数组,当 warehouses 数组大小 > 1 时,skuList 最多支持200个SKU | |
| warehouse | N | String | “Amazon” | 千易系统仓库名称,最大50个字符,warehouses 和 warehouse参数至少需要传递其中一个 |
| warehouses | N | List<String> | [“Amazon”] | 千易系统仓库名称列表, 每次最多传50个仓库名称,warehouses 和 warehouse参数至少需要传递其中一个 |
| 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.3.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 | 在途货值 |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/inventory' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_SIMPLE_LIST_INVENTORY_V2"' \
--form 'bizParam="{\"page\":1,\"pageSize\":3,\"warehouse\":\"best warehouse(测试用)\"}"' \
--form 'timestamp="1731742317"' \
--form 'sign="26fff7cae9e2f3420f1aae8a1677be19"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"allocated\":0,\"assemblyAllocated\":0,\"assemblyShippingQuantity\":0,\"available\":1,\"firstLegAllocated\":0,\"firstLegShippingQuantity\":0,\"manualShippingQuantity\":0,\"orderAllocated\":0,\"purchaseShippingQuantity\":0,\"returnShippingQuantity\":0,\"shippingQuantity\":0,\"sku\":\"hmsku090901-1\",\"skuName\":\"黑咪测展示商品-1\",\"total\":1,\"transferAllocated\":0,\"transferShippingQuantity\":0,\"unavailable\":0,\"warehouse\":\"best warehouse(测试用)\",\"warehouseCode\":\"CA OFC\"},{\"allocated\":0,\"assemblyAllocated\":0,\"assemblyShippingQuantity\":0,\"available\":0,\"firstLegAllocated\":0,\"firstLegShippingQuantity\":0,\"manualShippingQuantity\":111,\"orderAllocated\":0,\"purchaseShippingQuantity\":0,\"returnShippingQuantity\":0,\"shippingQuantity\":111,\"sku\":\"0878\",\"skuName\":\"yhx实物商品002 blue\",\"total\":0,\"transferAllocated\":0,\"transferShippingQuantity\":0,\"unavailable\":0,\"warehouse\":\"best warehouse(测试用)\",\"warehouseCode\":\"CA OFC\"},{\"allocated\":0,\"assemblyAllocated\":0,\"assemblyShippingQuantity\":0,\"available\":0,\"firstLegAllocated\":0,\"firstLegShippingQuantity\":0,\"manualShippingQuantity\":1,\"orderAllocated\":0,\"purchaseShippingQuantity\":0,\"returnShippingQuantity\":0,\"shippingQuantity\":1,\"sku\":\"testgg01\",\"skuName\":\"Uji nama bahasa Cina\",\"total\":0,\"transferAllocated\":0,\"transferShippingQuantity\":0,\"unavailable\":0,\"warehouse\":\"best warehouse(测试用)\",\"warehouseCode\":\"CA OFC\"}],\"state\":\"success\",\"total\":726}",
"requestId": "5a3cf6a8-f761-4c66-a537-0869b0c1ba21"
}
1.4. Query inventory logs
1.4.1. SERVICE_TYPE
QUERY_INVENTORY_LOG_LIST
1.4.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.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 |
| 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.5. Query assembly order list
1.5.1. SERVICE_TYPE
QUERY_INVENTORY_ASSEMBLY_LIST
1.5.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.5.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 |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/inventory' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_INVENTORY_ASSEMBLY_LIST"' \
--form 'bizParam="{\"assemblyNumber\":\"AP250627145996\"}"' \
--form 'timestamp="1731742317"' \
--form 'sign="9e0a3727c6629beef9bd9e7e3f77f3e1"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"assemblyList\":[{\"expectQuantity\":1,\"parts\":[{\"expectQuantity\":1,\"quantity\":0,\"sku\":\"S215480756\"},{\"expectQuantity\":1,\"quantity\":0,\"sku\":\"S006022868\"},{\"expectQuantity\":1,\"quantity\":0,\"sku\":\"i5-3470/8G+256G-19inchZ2\"}],\"processedQuantity\":0,\"sku\":\"SL059-03\",\"status\":\"UN_PROCESSED\"}],\"assemblyNumber\":\"AP250627145996\",\"createTime\":1751023870000,\"isDeleted\":0,\"status\":\"NEW\",\"warehouseName\":\"best warehouse(测试用)\"}],\"state\":\"success\",\"total\":1}",
"requestId": "014ad538-c054-4637-962f-a6ba123e57e8"
}
1.6. Create transfer order
1.6.1. SERVICE_TYPE
CREATE_TRANSFER_AVAILABLE_ORDER
1.6.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| warehouseName | Y | String | Outbound Warehouse name | |
| destWarehouseName | Y | String | dest Warehouse name | |
| customNumber | N | String | ref123 | Reference number, optional; max 100 characters when provided |
| logisticsName | Y | String | Logistics Name; value from logisticsName returned by QUERY_FIRST_LRG_LOGISTICS |
|
| trackNumber | N | String | 123456 | Tracking number, optional; max 50 characters when provided |
| 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.7. Query transfer order list
1.7.1. SERVICE_TYPE
QUERY_INVENTORY_TRANSFER_LIST
1.7.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.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 |
| 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 |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/inventory' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_INVENTORY_TRANSFER_LIST"' \
--form 'bizParam="{\"numberParam\":\"TF250908149420\"}"' \
--form 'timestamp="1731742317"' \
--form 'sign="e4ff5947df01094eef7733115281cd75"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"createTime\":1757318666000,\"destWarehouseName\":\"best warehouse(测试用)\",\"destWarehouseType\":\"BEST\",\"isDeleted\":0,\"logisticsName\":\"111\",\"preReceiveTime\":1757548800000,\"skuVOList\":[{\"cartonDimensionUnit\":\"m\",\"cartonHeight\":0.0100,\"cartonLength\":0.0100,\"cartonWidth\":0.1100,\"cdNetWeight\":1.0000,\"cdWeight\":1.0000,\"cdWeightUnit\":\"KG\",\"expectedQuantity\":5,\"id\":52611,\"packingRate\":5,\"receiveQuantity\":5,\"sku\":\"TDTEST2\"}],\"status\":\"FINISHED\",\"transferNumber\":\"TF250908149420\",\"type\":\"AVAILABLE\",\"updateTime\":1757318749000,\"warehouseName\":\"customer\"}],\"state\":\"success\",\"total\":1}",
"requestId": "472c91ab-e02f-4d97-aedd-7b13fa2aa6fb"
}
1.8. Query split order list
1.8.1. SERVICE_TYPE
QUERY_INVENTORY_RESTORE_LIST
1.8.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.8.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 |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/inventory' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_INVENTORY_RESTORE_LIST"' \
--form 'bizParam="{\"orderNumber\":\"RO250605145023\"}"' \
--form 'timestamp="1731742317"' \
--form 'sign="4f61c05231e9e671558a87449a932b4d"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"asnId\":44714,\"asnNumber\":\"A250605145025\",\"isDeleted\":0,\"orderNumber\":\"RO250605145023\",\"orderTime\":1749114490000,\"partQty\":2,\"receivedPartQty\":0,\"remarkList\":[],\"restoreOrderStartTime\":1749114686000,\"skuList\":[{\"completedQty\":0,\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"expectedQty\":1,\"id\":65,\"isDeleted\":0,\"orderId\":41,\"partList\":[{\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"id\":97,\"isDeleted\":0,\"orderId\":41,\"orderSkuId\":65,\"partRate\":1,\"purchasePrice\":1.0000,\"sku\":\"Hsiun-A\",\"skuId\":10001570,\"title\":\"2019 รองเท้าผ้าใบขนาดใหญ่ปากตื้นรองเท้าลำลองขี้เกียจแบน [964206010]\",\"totalCost\":0.0000,\"totalReceivedQty\":0},{\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"id\":98,\"isDeleted\":0,\"orderId\":41,\"orderSkuId\":65,\"partRate\":1,\"purchasePrice\":1.0000,\"sku\":\"Hsiun-B\",\"skuId\":10001571,\"title\":\"Molisa รองเท้า รองเท้าแฟชั่น รองเท้าทรงผ้าใบ หนังแท้100% Leather flat shoes sneakers shoes [1098646369]\",\"totalCost\":0.0000,\"totalReceivedQty\":0}],\"sku\":\"Hsiun-X\",\"skuId\":10001578,\"splitFeeInCost\":0.0000,\"title\":\"9C-泊泉雅蓝莓美肌精华液原液 补水保湿控油收缩毛孔提亮肤色\",\"totalExpectPartQty\":2,\"totalReceivePartCost\":0.00,\"totalReceivedPartQty\":0}],\"status\":\"DOING\",\"totalCost\":0,\"totalExpectPartQty\":2,\"totalFee\":0,\"totalReceivedPartQty\":0,\"warehouseId\":12496,\"warehouseName\":\"Hs海外仓\",\"workerBizType\":\"RESTORE_ORDER\"}],\"state\":\"success\",\"total\":1}",
"requestId": "4f384479-322b-4e79-8b6c-660a691ab2b3"
}
1.9. Query Storage Location Inventory
1.9.1. SERVICE_TYPE
QUERY_STORAGE_LOCATION_INVENTORY_LIST
1.9.2. Request
| Parameter | Required | Type | Example | Notes |
|---|---|---|---|---|
| skuList | Y | List<String> | Array of SKUs. skuList supports up to 200 SKUs. |
|
| warehouses | Y | List<String> | ["Amazon"] | List of warehouse names in the Qianyi system. Supports up to 50 warehouse names per request. |
| page | Y | Number | 1 | Page number, default is 1. |
| pageSize | Y | Number | 50 | Items per page. Max 200; default is 100. |
| showEmpty | N | boolean | true | Whether to query items with 0 inventory. Default is false. |
| storageLocationCode | N | String | "SYS LOC" | Storage location code. "SYS LOC" indicates the good products location. |
1.9.3. Response
| Parameter | Required | Type | Example | Notes |
|---|---|---|---|---|
| errorCode | Y | String | "DATA_INPUT_ERROR" | Error Codes |
| errorMsg | Y | String | "Invalid input parameters" | Business error message. |
| state | Y | String | success | Request Result State |
| total | Y | Number | 100 | Total number of items. |
| result | Y | List<StorageLocationSkuInventory> | List of storage location inventory information. |
StorageLocationSkuInventory (Item Inventory)
| Parameter | Required | Type | Example | Notes |
|---|---|---|---|---|
| sku | Y | String | "abc" | Item SKU. |
| skuName | Y | String | "Test Product" | Item name. |
| warehouse | Y | String | "FBA USA" | Warehouse name. |
| warehouseCode | Y | String | "18991" | Warehouse code. |
| total | Y | Number | 13 | Total quantity. |
| available | Y | Number | 5 | Available quantity. |
| storageLocationCode | Y | String | "SYS LOC" | Storage location code. |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/inventory' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_STORAGE_LOCATION_INVENTORY_LIST"' \
--form 'bizParam="{\"skuList\":[\"abc\",\"SKU002\"],\"warehouses\":[\"Amazon\",\"FBA美国\"],\"page\":1,\"pageSize\":50,\"showEmpty\":true,\"storageLocationCode\":\"SYS LOC\"}"' \
--form 'timestamp="1731742317"' \
--form 'sign="26fff7cae9e2f3420f1aae8a1677be19"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"errorCode\":\"\",\"errorMsg\":\"\",\"state\":\"success\",\"total\":100,\"result\":[{\"sku\":\"abc\",\"skuName\":\"测试商品\",\"warehouse\":\"FBA美国\",\"warehouseCode\":\"18991\",\"total\":13,\"available\":5,\"locationCode\":\"SYS LOC\"},{\"sku\":\"SKU002\",\"skuName\":\"测试商品B\",\"warehouse\":\"FBA加拿大\",\"warehouseCode\":\"18992\",\"total\":20,\"available\":20,\"locationCode\":\"SYS LOC\"}]}",
"requestId": "5a3cf6a8-f761-4c66-a537-0869b0c1ba21"
}
1.10. Query Batch Inventory List
1.10.1. SERVICE_TYPE
QUERY_BATCH_INVENTORY_LIST
1.10.2. Request
| Parameter | Required | Type | Example | Notes |
|---|---|---|---|---|
| skuList | N | List<String> | Array of SKUs. skuList supports up to 300 SKUs. |
|
| warehouseName | N | String | Qianyi System Warehouse, with a maximum of 50 characters | |
| storageLocationCode | N | String | "SYS LOC" | Warehouse location code: SYS LOC Good product warehouse location |
| numberParam | N | String | A260122158274_1 | Warehouse Entry Batch Warehouse Entry Number Business Order Number Reference Number |
| receiveTimeFrom | N | String | 2026-01-21 | Start date of data entry (yyyy-MM-dd) |
| receiveTimeTo | N | String | 2026-01-22 | End date of inventory entry (yyyy-MM-dd) |
| page | Y | Number | 1 | Page number, default is 1 |
| pageSize | Y | Number | 50 | Items per page. Max 200; default is 100. |
| showEmpty | N | boolean | 0 | Whether to display products with zero inventory: 1: Display products with zero inventory 0: Do not display products with zero inventory Default: Do not display products with zero inventory |
1.10.3. Response
| Parameter | Required | Type | Example | Notes |
|---|---|---|---|---|
| errorCode | Y | String | "DATA_INPUT_ERROR" | Error Codes |
| errorMsg | Y | String | "Invalid input parameters" | Business error message. |
| state | Y | String | success | Request Result State |
| total | Y | Number | 100 | Total number of items. |
| result | Y | List<SkuInventoryDetail> | List of Batch inventory list information. |
SkuInventoryDetail(Batch inventory)
| Parameter | Required | Type | Example | Notes |
|---|---|---|---|---|
| sku | Y | String | “abc” | Item SKU. |
| warehouseName | Y | String | “FBA美国” | Warehouse name. |
| storageLocationCode | Y | String | "SYS LOC" | Storage location code. |
| asnReceiveNumber | Y | String | "A250325136255_1" | Warehouse Entry Batch |
| customNumber | N | String | "123" | Reference Number |
| stockInTime | N | String | "2025-03-25 15:35:48 UTC+8" | Storage time with time zone |
| businessNumber | N | String | "T250325136254" | Business Order Number |
| total | Y | Number | 5 | Total quantity. |
| allocated | Y | String | 1 | Allocated quantity. |
| available | Y | Number | 2 | Available quantity. |
| inventoryAge | Y | Number | 5 | Inventory age |
| stockHoldingCost | Y | Number | 111.0000 | Inventory cost |
| currency | Y | String | "CNY" | Currency: Currently only CNY (Renminbi) |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/inventory' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_BATCH_INVENTORY_LIST"' \
--form 'bizParam="{\"numberParam\":\"T250325136254\",\"page\":1,\"pageSize\":50}"' \
--form 'timestamp="1731742317"' \
--form 'sign="26fff7cae9e2f3420f1aae8a1677be19"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"allocated\":0,\"asnReceiveNumber\":\"A250325136255_1\",\"available\":1,\"businessNumber\":\"T250325136254\",\"currency\":\"CNY\",\"customNumber\":\"我是参考号\",\"inventoryAge\":314,\"sku\":\"mcdull-s2\",\"stockHoldingCost\":111.0000,\"stockInTime\":\"2025-03-25 15:35:48 UTC+8\",\"storageLocationCode\":\"mcdull-s2-loc\",\"total\":1,\"warehouseName\":\"best warehouse(测试用)\"}],\"state\":\"success\",\"total\":1,\"traceId\":\"a2628b66da6c4c7ba21f4e012d8c9e0a\"}",
"requestId": "906ce143-a5c0-4b91-808d-dbe208240c9e"
}
1.11. Transfer Storage Location
1.11.1. SERVICE_TYPE
TRANSFER_STORAGE_LOCATION
1.11.2. Request
SkuInventoryDetailTransfer(Transfer Storage Location)
The input is a collection:List
| Parameter | Required | Type | Example | Notes |
|---|---|---|---|---|
| sku | Y | String | Item SKU. | |
| warehouseName | Y | String | Warehouse name. | |
| storageLocationCode | Y | String | "SYS LOC" | Storage location code. |
| asnReceiveNumber | Y | String | A260122158274_1 | Warehouse Entry Batch |
| destStorageLocationCode | Y | String | "SYS LOC" | Traget storage location code. |
| transferNumber | Y | Number | 1 | Transfer quantity |
| reason | Y | String | 没有原因 | Reasn |
1.11.3. Response
| Parameter | Required | Type | Example | Notes |
|---|---|---|---|---|
| errorCode | Y | String | "DATA_INPUT_ERROR" | Error Codes |
| errorMsg | Y | String | "Invalid input parameters" | Business error message. |
| state | Y | String | success | Request Result State |
| bizContent | N | String | JSON |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/inventory' \
--form 'appId="TEST"' \
--form 'serviceType="TRANSFER_STORAGE_LOCATION"' \
--form 'bizParam="[{\"sku\":\"test-0918\",\"warehouseName\":\"千仓02\",\"storageLocationCode\":\"SYS LOC\",\"asnReceiveNumber\":\"A251225137396_1\",\"destStorageLocationCode\":\"Unavailable LOC\",\"transferNumber\":\"1\",\"reason\":\"1\"}]"' \
--form 'timestamp="1731742317"' \
--form 'sign="26fff7cae9e2f3420f1aae8a1677be19"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"state\":\"success\",\"traceId\":\"43c1370fa0594d39b6321a3b962d4ffb\"}",
"requestId": "e1cd2eeb-b7a7-4dee-8c61-29977a7ac386"
}
1.12. Shopee SBS Inventory Query List
1.12.1. Relationship
QUERY_SHOPEE_SBS_WHS_ID_LIST is used to query the Shopee SBS warehouse IDs available in the current authorization scope. The returned warehouse IDs correspond to the whsIds request parameter of this API and to the whsId field in the inventory list response.
If callers need to query Shopee SBS inventory by warehouse, they should call QUERY_SHOPEE_SBS_WHS_ID_LIST first to obtain available warehouse IDs, then pass the target warehouse IDs in whsIds when calling QUERY_SHOPEE_SBS_INVENTORY_LIST. If whsIds is not provided, the inventory list is returned based on the other query conditions.
Shop filtering uses Gerp shop names (shopNames, multiple values, exact match against shop names in the system). If shopNames is omitted, no shop-name filter is applied. If all provided names fail to match any shop visible under the current authorization, the API returns an empty page (total is 0).
1.12.2. SERVICE_TYPE
QUERY_SHOPEE_SBS_INVENTORY_LIST
1.12.3. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| shopNames | N | List<String> | ["Shopee Shop A","Another Shop"] | Gerp shop name list, multi-value exact match; omit to skip name filter |
| whsIds | N | List<String> | ["WH001"] | Warehouse code list |
| stockLevels | N | List<Integer> | [1,4] | Stock level enum values |
| itemIds | N | List<String> | ["I1001","I1002"] | Item ID, exact match, multi-value |
| itemNames | N | List<String> | ["Test Product"] | Item name, exact match, multi-value |
| skuIds | N | List<String> | ["SKU001"] | SKU ID, exact match, multi-value |
| skuNames | N | List<String> | ["SKU Name A","SKU Name B"] | SKU name, exact match, multi-value |
| page | Y | Number | 1 | Page number, default is 1 |
| pageSize | Y | Number | 50 | Items per page. Max 200; default is 100 |
1.12.4. Response
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| errorCode | Y | String | "" | Error Codes |
| errorMsg | Y | String | "" | Business error message |
| state | Y | String | success | Response State |
| total | Y | Number | 100 | Total number |
| result | Y | List<ShopeeSbsInventory> | Inventory list |
ShopeeSbsInventory
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| itemImage | Y | String | Image URL | |
| warehouseItemId | Y | String | Warehouse Item ID | |
| itemName | Y | String | Warehouse Item name | |
| whsId | Y | String | Warehouse code | |
| shopName | Y | String | Shop name | |
| shopSkuList | Y | List<ShopSku> | Shop SKU array | |
| matchStatus | Y | String | NORMAL | Match status; see matchStatus enum |
| systemSku | N | SystemSku | Returned only when matchStatus=NORMAL; empty for unmatched or abnormal |
|
| matchReason | N | String | System SKU not matched | unmatched or abnormal cases |
| inTransitPendingPutawayQty | Y | Number | 0 | In-transit quantity |
| sellableQty | Y | Number | 0 | Sellable quantity |
| reservedQty | Y | Number | 0 | Reserved inventory |
| unsellableQty | Y | Number | 0 | Unsellable inventory |
| excessStock | Y | Number | 0 | Excess stock |
| coverageDays | Y | Number | 0 | Estimated sellable days |
| inWhsCoverageDays | Y | Number | 0 | Sellable days in warehouse |
| sellingSpeed | Y | Number | 0 | Average daily sales |
| last7Sold | Y | Number | 0 | Last 7 days sold |
| last15Sold | Y | Number | 0 | Last 15 days sold |
| last30Sold | Y | Number | 0 | Last 30 days sold |
| last60Sold | Y | Number | 0 | Last 60 days sold |
| last90Sold | Y | Number | 0 | Last 90 days sold |
| stockLevel | Y | Integer | 1 | Stock level |
| qtyOfStockAgeOne | Y | Number | 0 | 0-30D |
| qtyOfStockAgeTwo | Y | Number | 0 | 31-60D |
| qtyOfStockAgeThree | Y | Number | 0 | 61-90D |
| qtyOfStockAgeFour | Y | Number | 0 | 91-120D |
| qtyOfStockAgeFive | Y | Number | 0 | 121-180D |
| qtyOfStockAgeSix | Y | Number | 0 | >180D |
ShopSku
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| shopItemId | Y | String | Shop Item ID | |
| shopSkuId | Y | String | Shop SKU ID |
SystemSku
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| sysSkuSku | Y | String | System SKU code | |
| sysSkuTitle | Y | String | System SKU title |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/inventory' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_SHOPEE_SBS_INVENTORY_LIST"' \
--form 'bizParam="{\"page\":1,\"pageSize\":20,\"shopNames\":[\"Shopee Shop A\",\"Another Shop\"],\"whsIds\":[\"WH001\"],\"stockLevels\":[1,4],\"itemIds\":[\"I1001\"],\"itemNames\":[\"Test Product\"],\"skuIds\":[\"SKU001\"],\"skuNames\":[\"SKU Name A\"]}"' \
--form 'timestamp="1731742317"' \
--form 'sign="26fff7cae9e2f3420f1aae8a1677be19"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"itemImage\":\"https://example.com/a.jpg\",\"warehouseItemId\":\"I1001\",\"itemName\":\"Test Product\",\"whsId\":\"WH001\",\"shopName\":\"Shopee Shop A\",\"shopSkuList\":[{\"shopItemId\":\"SP1001\",\"shopSkuId\":\"SPSKU1001\"}],\"inTransitPendingPutawayQty\":0,\"sellableQty\":12,\"reservedQty\":1,\"unsellableQty\":0,\"excessStock\":0,\"coverageDays\":3.5,\"inWhsCoverageDays\":2.1,\"sellingSpeed\":4.2,\"last7Sold\":18,\"last15Sold\":36,\"last30Sold\":72,\"last60Sold\":120,\"last90Sold\":180,\"stockLevel\":1,\"qtyOfStockAgeOne\":10,\"qtyOfStockAgeTwo\":5,\"qtyOfStockAgeThree\":2,\"qtyOfStockAgeFour\":1,\"qtyOfStockAgeFive\":0,\"qtyOfStockAgeSix\":0}],\"state\":\"success\",\"total\":1}",
"requestId": "5a3cf6a8-f761-4c66-a537-0869b0c1ba21"
}
1.13. Shopee SBS Warehouse ID List Query
1.13.1. Relationship
The warehouse IDs returned by this API are used as the whsIds request parameter of QUERY_SHOPEE_SBS_INVENTORY_LIST. Callers can use this API to get the available warehouse scope first, then select one or more warehouse IDs to query the Shopee SBS inventory list.
1.13.2. SERVICE_TYPE
QUERY_SHOPEE_SBS_WHS_ID_LIST
1.13.3. Request
No request parameters.
1.13.4. Response
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| errorCode | Y | String | "" | Error Codes |
| errorMsg | Y | String | "" | Business error message |
| state | Y | String | success | Response State |
| result | Y | List<String> | ["WH001"] | Warehouse ID list |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/inventory' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_SHOPEE_SBS_WHS_ID_LIST"' \
--form 'bizParam="{}"' \
--form 'timestamp="1731742317"' \
--form 'sign="26fff7cae9e2f3420f1aae8a1677be19"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[\"WH001\",\"WH002\"],\"state\":\"success\"}",
"requestId": "5a3cf6a8-f761-4c66-a537-0869b0c1ba21"
}