1. Adjustment order API
API URL
post {HTTP(S)host}/api/{version}/adjustment
1.1. Query Adjustment orders
1.1.1. SERVICE_TYPE
QUERY_ADJUSTMENT_LIST
1.1.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| warehouseName | N | String | Malay | The name of warehouse |
| source | Y | String | AUTO | Adjustment order type, see Enumeration |
| autoSource | N | String | EXTERNAL_ADJUST | Source=auto, the required fields, subcategories, see enumeration Adjustment order sub type |
| createTimeFrom | N | String | 2022-09-05 | The creation time starts |
| createTimeTo | N | String | 2022-09-05 | The creation time ends |
| updateTimeFrom | N | String | 2022-09-05 | The update time starts |
| updateTimeTo | N | String | 2022-09-05 | The update time ends |
| number | N | String | 2011asd | Adjustment order code |
| skuKeyWord | N | String | 2011asd | Multi-field search, product code, product name |
| page | Y | Number | 1 | Page number, default 1 |
| pageSize | Y | Number | 100 | 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 number of records |
| result | Y | List<Adjustment> | See Adjustment |
Adjustment (Adjustment Order)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| adjustmentNumber | Y | String | A20220905 | Adjustment order code |
| source | Y | String | AUTO | Adjustment order type, see Enumeration |
| autoSource | N | String | EXTERNAL_ADJUST | Source=auto, must pass fields, subcategories, see enumeration Adjustment order sub type |
| warehouseName | Y | String | Malay warehouse | warehouse name |
| remark | N | String | Quick | Description |
| createTime | Y | String | 2022-09-05 15:27:18 | Creation time |
| adjustmentSkuVOList | Y | List<AdjustmentSku> | Adjustment order details ,see AdjustmentSku |
AdjustmentSku(Adjustment order details)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| sku | Y | String | S90 | sku |
| title | Y | String | Product title | Product title |
| color | N | String | Color | Specifications - Color |
| itemPackage | N | String | Pack | Specifications - Packaging |
| size | N | String | size | Specifications - Dimensions |
| storageLocationCode | N | String | SYS LOC | Bin location |
| availableQuantity | Y | Long | 100 | Available inventory |
| allocatedQuantity | Y | Long | 100 | Occupy inventory |
| totalQuantity | Y | Long | 100 | Total inventory |
| totalAfter | Y | Long | 100 | Adjusted Total Inventory |
| difference | Y | Long | 100 | Adjust the difference |
| availableAfter | Y | Long | 100 | Adjusted available inventory |
1.2. Create Adjustment Order
1.2.1. SERVICE_TYPE
CREATE_ADJUSTMENT_ORDER
1.2.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| warehouseName | Y | String | Malay warehouse | Warehouse name |
| externalNumber | N | String | C20220905 | External tracking number |
| remark | N | String | Quick | Description |
| adjustmentType | N | String | AVL_FINAL | Adjust Type，The default is the total amount of available adjustments |
| adjustSkuList | Y | List< adjustSku> | see adjustSku |
adjustSku (Adjustment Order Details)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| sku | Y | String | S90 | sku |
| title | N | String | Brushless vacuum cleaner | The title of the product |
| storageLocationCode | N | String | SYS LOC | Bin location |
| adjustmentQtyStr | Y | Long | 100 | Adjust number |
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 |