Update Inventory

Learn how to update product inventory in HotWax by logging variances of inputted amounts.

Updates the inventory of products in HotWax by logging a variance of the inputted amount. To update inventory you will need to call the endpoint with the POST method.

Example:

Inventory in HotWax: 10
Variance: -2
Updated inventory in HotWax: 8

Request

End Point

https://<host>/api/service/updateInventoryByIdentification

Example: https://demo-oms.hotwax.io/api/service/updateInventoryByIdentification

Header

Content-Type: application/json

Authentication

To access this endpoint, you need to include the authorization token in the request header.

Authorization: Bearer <access_token>

To learn more about Bearer token authentication, read this document

Body

{
  "facilityId": ,
  "availableDelta": ,
  "idType": ,
  "idValue": ,
  "locationSeqId": ,
  "varianceReasonId":
}

Sample:

{
  "facilityId": "WH",
  "availableDelta": 4,
  "idType": "UPCA",
  "idValue": "30065245099",
  "locationSeqId": "TLTLTLLL01",
  "varianceReasonId": "POS_SALE"
}
  

Parameters	Description	Required (Y/N)
idType	The type of product identifier. Currently supported ID types are SKU, UPCA,Shopify_Prod_ID	Y
idValue	The value of product identifier	Y
availableDelta	The variance in inventory quantity(delta)	Y
facilityId	The external facility ID where inventory item needs to be updated	Y
locationSeqId	The location ID in the facility where inventory item needs to be updated	Y
varianceReasonId	The ID of the reason that caused variance in inventory	Y

Table of valid variance reasons and their IDs:

Variance Reason ID	Description
MISMATCH	Inventory does not match the available SKU
NOT_IN_STOCK	SKU is not available
NO_VARIANCE_LOG	Use to pass null variance where variance field is required but not used
REJ_RSN_DAMAGED	Ordered SKU is rejected due to inventory damage
POS_SALE	Inventory consumed by sales made on an external point of sale system in the store
VAR_DAMAGED	Reduce damaged inventory from available quantity
VAR_LOST	SKU inventory is lost
VAR_FOUND	Lost SKU inventory is found
WORN_DISPLAY	SKU inventory is worn and unsuable from being on display
VAR_MANUAL	SKU inventory adjustment is done manually

Response

Status Code

HTTP/1.1 200 OK

Headers

Content-Type: application/json

Body

{
   {
    "facilityId": ,
    "availableDelta": ,
    "idType": ,
    "idValue": ,
    "locationSeqId": ,
    "varianceReasonId": ,
  },
  "webSiteId": ""
}

Sample:

{
  {
    "facilityId": "WH",
    "availableDelta": 4,
    "idType": "UPCA",
    "idValue": "30065245099",
    "locationSeqId": "TLTLTLLL01",
    "varianceReasonId": "POS_SALE"
  },
  "webSiteId": "API"
}