Adjust Inventory (Multiple)

This REST API is used to adjust inventory of multiple SKUs in Uniware. The user can update inventory of multiple SKUs in a single facility or in multiple facilities in a single request.

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.

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.

Flow

Adjust_Inventory_Bulk_Flow

Tip

Complete integration flow is available on Basic Overview page.

Basic Information

NAME DETAILS
Endpoint: /services/rest/v1/inventory/adjust/bulk
Request Type: POST
Level: Tenant
Scheme: HTTPS
Header (Content-Type): application/json
Header (Authorization): bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa

Request Payload

{
   "inventoryAdjustments": [
      {
         "itemSKU": "string",
         "quantity": 0,
         "shelfCode": "string",
         "inventoryType": "GOOD_INVENTORY",
         "transferToShelfCode": "string",
         "sla": 0,
         "adjustmentType": "ADD",
         "remarks": "string",
         "facilityCode": "string"
      }
   ]
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 inventoryAdjustment list Inventory adjustment details - -
1.1 itemSKU string 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
1.9 facilityCode string Facility ID associated with inventory Yes Eg.: Delhi6

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"
      }
   ],
   "inventoryAdjustmentResponses": [
      {
         "facilityInventoryAdjustment": {
            "itemSKU": "string",
            "quantity": 0,
            "shelfCode": "string",
            "inventoryType": "GOOD_INVENTORY",
            "transferToShelfCode": "string",
            "sla": 0,
            "adjustmentType": "ADD",
            "remarks": "string",
            "facilityCode": "string"
         },
         "successful": true,
         "errors": [
            {
               "code": 0,
               "fieldName": "string",
               "description": "string",
               "message": "string",
               "errorParams": {
                  "additionalProp1": {},
                  "additionalProp2": {},
                  "additionalProp3": {}
               }
            }
         ]
      }
   ]
}

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 -
5 inventoryAdjustmentResponses list Array of updated inventory items -
5.1 facilityInventoryAdjustment object List of updated inventory items -
5.1.1 itemSKU string Item SKU Eg.: Bharat4
5.1.2 quantity number Qty of the item -
5.1.3 shelfCode string Shelf code for item -
5.1.4 inventoryType enum Inventory type Allowable: GOOD_INVENTORY (default), BAD_INVENTORY, QC_REJECTED, VIRTUAL_INVENTORY
5.1.5 transferToShelfCode string Shelf code where the inventory will get added (transferred) -
5.1.6 sla string - -
5.1.7 adjustmentType enum Inventory adjustment type Allowable: ADD, REMOVE, REPLACE, TRANSFER
5.1.8 remarks string - -
5.1.9 facilityCode string Facility ID associated with inventory Eg.: Delhi6
5.2 successful true Request success status -
5.3 errors list List of errors (if any) -
5.3.1 code number - -
5.3.2 fieldName string Field name with error -
5.3.3 description string Error description -
5.3.4 message string Error message -
5.3.5 errorParams object Parameters with error -
5.3.5.1 additionalProp1 object Parameter 1 with error -
5.3.5.2 additionalProp2 object Parameter 2 with error -
5.3.5.3 additionalProp3 object Parameter 3 with error -

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2022 Unicommerce eSolutions Pvt. Ltd.