Adjust Inventory (Single)
This REST API is used to adjust inventory of a SKU in Uniware.
Tip
- It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.
- To adjust inventory of multiple SKUs at once, refer Adjust Inventory (Multiple) API.
Adjustment Types
- ADD: add to existing inventory.
- REMOVE: subtract from existing inventory.
- REPLACE: supersede the existing inventory with the new inventory.
- TRANSFER: to tranfer inventory between shelves.
Inventory Types
- GOOD_INVENTORY (default): in good condition, can be selled.
- BAD_INVENTORY: broken or expired non-sellable.
- QC_REJECTED: rejected by warehouse quality team.
- VIRTUAL_INVENTORY: inventory not physically present in warehouse, items which are customizable and are prepared on order.
Basic Information
NAME | DETAILS |
---|---|
Endpoint: | /services/rest/v1/inventory/adjust |
Request Type: | POST |
Level: | Facility |
Scheme: | HTTPS |
Header (Content-Type): | application/json |
Header (Authorization): | bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa |
Header (Facility): | facility code as in Uniware (refer FAQs) |
Request Payload
{
"inventoryAdjustment": {
"itemSKU": "string",
"quantity": 0,
"shelfCode": "string",
"inventoryType": "GOOD_INVENTORY",
"transferToShelfCode": "string",
"sla": 0,
"adjustmentType": "ADD",
"remarks": "string"
}
}
Request Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|---|
1 | inventoryAdjustment | list | Inventory adjustment details | - | - |
1.1 | itemSKU | string | Item SKU code | Yes | Eg.: Bharat4 |
1.2 | quantity | number | Quantity to be adjusted | Yes | - |
1.3 | shelfCode | string | Shelf code of the item | Yes | - |
1.4 | inventoryType | enum | Inventory type | No | Allowable: GOOD_INVENTORY (default), BAD_INVENTORY, QC_REJECTED, VIRTUAL_INVENTORY |
1.5 | transferToShelfCode | string | Shelf code where the inventory will get added (transferred) | Yes (in case of TRANSFER only) | - |
1.6 | sla | string | - | No | - |
1.7 | adjustmentType | enum | Inventory adjustment type | Yes | Allowable: ADD, REMOVE, REPLACE, TRANSFER |
1.8 | remarks | string | Remarks (if any) | No | Max. chars: 255 |
Response Payload
{
"successful": true,
"message": "string",
"errors": [
{
"code": 0,
"fieldName": "string",
"description": "string",
"message": "string",
"errorParams": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
}
],
"warnings": [
{
"code": 0,
"message": "string",
"description": "string"
}
]
}
Response Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | NOTES |
---|---|---|---|---|
1 | successful | true | Request success status | - |
2 | message | string | Response message | - |
3 | errors | list | List of errors (if any) | - |
3.1 | code | number | Error code | - |
3.2 | fieldName | string | Field with error | - |
3.3 | description | string | Error description | - |
3.4 | message | string | Error message | - |
3.5 | errorParams | object | Parameters with error | - |
3.5.1 | additionalProp1 | object | Parameter 1 with error | - |
3.5.2 | additionalProp2 | object | Parameter 2 with error | - |
3.5.3 | additionalProp3 | object | Parameter 3 with error | - |
4 | warnings | list | List of warnings (if any) | - |
4.1 | code | number | Warning code | - |
4.2 | message | string | Warning message | - |
4.3 | description | string | Warning description | - |