Get the stock details of the product on the specific locations. To get the stock details, you will need to call the /checkInventory endpoint with the POST method.

Request

End Point

https://<host>/api/checkInventory

Example: https://demo-oms.hotwax.io/api/checkInventory

Header

Content-Type: application/json

Body

In case of checking a product's inventory at multiple facility.

{
  "filters": {
    "sku": "<sku>",
    "facilityId": ["<facilityId1>", "<facilityId2>", "<facilityId3>"],
    "facilityId_op": "in"
  }
}

In case of checking multiple product's inventory at single facility.

{
  "filters": {
    "sku": ["<sku1>", "<sku2>", "<sku3>"],
    "sku_op": "in",
    "facilityId": "<facilityId>"
  }
}

Sample

{
  "filters": {
    "sku": "MSH02-32-Black",
    "facilityId": "STORE_7"
  }
}

Response

Status Code

HTTP/1.1 200 OK

Headers

Content-Type: application/json

Body

{
  "count": "1",
  "docs": [
    {
      "facilityId": "STORE_7",
      "atp": 1.000000
    }
  ]
}

BOPIS Check Inventory API

Overview

The BOPIS (Buy Online, Pick-up In Store) Check Inventory API allows you to retrieve stock details for products at specific locations. By calling the /checkBopisInventory endpoint with the POST method, you can check the availability of BOPIS inventory.

Request

Endpoint

URL: https://<host>/rest/s1/ofbiz-oms-usl/checkBopisInventory

This API uses our next generation OMS instance. All traditional instances have access to this next generation OMS by replacing "oms" with "maarg" in the host name.

Production

Current Name: demo-oms

Maarg Name: demo-maarg

UAT

Current Name: demo-uat

Maarg Name: demo-maarg-uat

Example: https://demo-maarg.hotwax.io/rest/s1/ofbiz-oms-usl/checkBopisInventory

Method

GET (Recommended if your library supports sending a body in a GET request) POST

Headers

Content-Type: application/json

Sample Request Body

Single product and facility

{
  "productStoreId": "STORE",
  "productIds": "11855",
  "internalNames": "XS-BLACK",
  "facilityIds": "114",
  "inventoryGroupId": "SHOPIFY_FAC_GRP"
}

Multiple products and facilities

{
  "productStoreId": "STORE",
  "productIds": ["11855","11856","118557"],
  "internalNames": ["XS-BLACK","S-BLACK","M-BLACK"],
  "facilityIds": ["114","115","116"],
  "inventoryGroupId": "SHOPIFY_FAC_GRP"
}

Body Parameters

If both productIds and internalNames are passed, the value of productIds will be honored.

Select Products

Products can be queried in the inventory API by both their HotWax ID or their internalName. The internal name refers to the UPC or SKU, whichever one is selected as a primary identifier during product configuration. While both fields are optional, one is requried to obtain a result.

productStoreId

Product Store represents a brand in HotWax Commerce. To obtain possible values, log into HotWax Commerce and view the product store list page for possible values.

inventoryGroupId Inventory groups are used to segregate inventory for different channels of sales. Obtain the inventory group ID by logging into HotWax Commerce Facilities App and browsing inventory groups.

Response

Status Code

HTTP/1.1 200 OK

Headers

Content-Type: application/json

Body

ATP zeroed out due to the inventory checks

{
  "atp": 0.0,
  "computedAtp": 0.0,
  "decisionReason": "AllowPickupFacility"
  "decisionReasonDesc": "Pickup is not allowed for product 11855 at facility 115."
}

Possible decisionReason explanation

Each Decision Reason also comes with a detailed log of why the given check failed.

1. ProductStore - Facility ${facilityId} is not associated with Product Store ${productStoreId}.

2. PickUp Facility - Facility ${facilityId} is not a member of a PICKUP Facility Group.

3. Inventory Group - Facility ${facilityId} is not a member of ${inventoryGroupId} channel.

4. Product Inventory Group allowPickup - Pickup is not allowed for product ${productId} ${inventoryGroupId} inventory group.

5. Product Facility allowPickup - Pickup is not allowed for product ${productId} at facility ${facilityId}.

ATP

{
  "atp": 50.0,
  "safetyStock": 5.0,
  "computedAtp": 45.0,
}

Syncs inventory from an external reference source to HotWax. After receiving the inventory file in CSV format, HotWax Commerce calculates the difference in inventory and matches its inventory levels exactly with CSV. CSV files can be imported in HotWax by two methods: using the EXIM menu in HotWax or saving the file at a designated SFTP location for HotWax to automatically download and process.

Sample path for SFTP method: /home/<host_name>-sftp/staging/incoming

CSV example

Here's an example of the CSV file format:

Parameters

The Reset Inventory API accepts the following parameters:

Note: sku upca and shopifyProductId are commonly used product Identifiers.

Reset inventory sample.csv

Overview

The Shipping Ckeck Inventory API allows to retrive the inventory details for the products at specific locations. By calling the /checkShippingInventory endpoint of our next generation OMS with the POST/GET method, you can check the availability of the inventory available for shipping.

Request

Endpoint

URL: https://<host>/rest/s1/ofbiz-oms-usl/checkShippingInventory

This API uses our next generation OMS instance. All traditional instances have access to this next generation OMS by replacing "oms" with "maarg" in the host name.

Production

Current Name: demo-oms

Maarg Name: demo-maarg

Example: https://demo-maarg.hotwax.io/rest/s1/ofbiz-oms-usl/checkShippingInventory

UAT

Current Name: demo-uat

Maarg Name: demo-maarg-uat

Methods

• GET: When passing params in the URL

• POST: When passing JSON body in the request

Headers

Content-Type: application/json

Sample Request Body

Single product and facility

Using POST Method

{
  "productStoreId": "STORE",
  "productIds": "11855",
  "internalNames": "XS-BLACK",
  "facilityIds": "114",
  "inventoryGroupId": "SHOPIFY_FAC_GRP"
}

Using GET Method

https://<host>/rest/s1/ofbiz-oms-usl/checkShippingInventory?productStoreId=STORE&productIds=11855&internalNames=XS-BLACK&facilityIds=114&inventoryGroupId=SHOPIFY_FAC_GRP

Multiple products and facilities

Using POST Method

{
  "productStoreId": "STORE",
  "productIds": ["11855", "11856", "118557"],
  "internalNames": ["XS-BLACK", "S-BLACK", "M-BLACK"],
  "facilityIds": ["114", "115", "116"],
  "inventoryGroupId": "SHOPIFY_FAC_GRP"
}

Using GET Method

https://<host>/rest/s1/ofbiz-oms-usl/checkShippingInventory?productStoreId=STORE&productIds=11855,11856,118557&internalNames=XS-BLACK,S-BLACK,M-BLACK&facilityIds=114,115,116&inventoryGroupId=SHOPIFY_FAC_GRP

Body Parameters

Notes

• Either productIds and internalNames value is required, If both values are passed, then the value of productIds will be honored.

• This API does not necessarily require the inventoryGroupId and facilityIds, If both values are not provided API will return an inventory of products at all the locations.

Select Products

Products can be queried in the inventory API by both their HotWax ID or their internalName. The internal name refers to the UPC or SKU, whichever one is selected as a primary identifier during product configuration. While both fields are optional, one is required to obtain a result.

productStoreId

Product Store represents a brand in HotWax Commerce. To obtain possible values, log into HotWax Commerce and view the product store list page for possible values.

inventoryGroupId

Inventory groups are used to segregate inventory for different channels of sales. Obtain the inventory group ID by logging into HotWax Commerce Facilities App and browsing inventory groups.

Response

Status Code

HTTP/1.1 200 OK

Headers

Content-Type: application/json

Body

Success ATP Response

{
    "resultList": [
        {
            "productId": "10560",
            "totalAtp": 13,
            "totalComputedAtp": 13,
            "totalSafetyStock": 0.0,
            "facilities": [
                {
                    "facilityId": "100",
                    "safetyStock": 0.0,
                    "computedAtp": 6,
                    "atp": 6
                },
                {
                    "facilityId": "57",
                    "safetyStock": 0.0,
                    "computedAtp": 7,
                    "atp": 7
                }
            ]
        }
    ]
}

ATP zeroed out due to the inventory checks for products at locations

{
    "resultList": [
        {
            "productId": "10560",
            "totalAtp": 0.0,
            "totalComputedAtp": 0.0,
            "totalSafetyStock": 0.0,
            "facilities": [
                {
                    "decisionReasonDesc": "The inventory for product 10560 at facility RETAIL_WAREHOUSE is not available",
                    "facilityId": "RETAIL_WAREHOUSE",
                    "safetyStock": 0.0,
                    "computedAtp": 0.0,
                    "atp": 0.0,
                    "decisionReason": "ProductFacility"
                }
            ]
        }
    ]
}

ATP zeroed out due to brokering being disabled for the channel globally

{
    "resultList": [
        {
            "productId": "10560",
            "inventoryGroupId": "FAC_GRP",
            "decisionReason": "AllowBrokeringInventoryGroup",
            "decisionReasonDesc": "Brokering of the product 10560 for the inventory group FAC_GRP is not allowed globally."
        }
    ]
}

Possible decisionReason explanation

Each Decision Reason also comes with a detailed log of why the given check failed.

1. ProductStore - The facility ${facilityId} is not associated with Product Store ${productStoreId}.

2. Product Facility - The inventory for product ${productId} at facility ${facilityId} is not available.

3. Inventory Group - The facility ${facilityId} where the product ${productId} is located does not cater its inventory to that channel.

4. Inventory Group allowBrokering - Brokering of the product ${productId} for the inventory group ${inventoryGroupId} is not allowed globally.

5. Product Facility allowBrokering - The facility ${facilityId} where the product ${productId} inventory is located is disabled to cater to shipping orders.

Store Associates need to access the online Available to Promise (ATP) inventory of products on their POS systems for sendsales orders. The getProductOnlineAtp API facilitates retrieving the online ATP of a product from all locations except the one it's being ordered from. The API does not count the Online ATP of a facility in the following scenarios:

1. Inventory for the store placing the order.

2. Inventory from stores with sell online turned off.

3. Inventory for an SKU where the inventory is turned off in specific locations.

To fetch the online ATP details, make a POST request to the /getProductOnlineAtp endpoint.

Request

End Point

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

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

Header

Content-Type: application/json

Body

{
  "idType": "<SKU>",
  "idValue": "<SKU>",
  "productStoreId": "<STORE_ID>",
  "conditionMap": {
    "externalFacilityId_value": "<External Facility ID>",
    "externalFacilityId_op": "<operator>"
  }
}

Sample

{
  "idType": "SKU",
  "idValue": "MSH02-32-Black",
  "productStoreId": "DEMO_STORE",
  "conditionMap": {
    "externalFacilityId_value": "101",
    "externalFacilityId_op": "notEqual"
  }
}

Parameters

Response

Status Code

HTTP/1.1 200 OK

Headers

Content-Type: application/json

Body

{
    "onlineAtp": "<Value>"
}

Sample

{
    "onlineAtp": 100
}

Parameters

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:

Request

End Point

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

Example:

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

Body

Sample:

Table of valid variance reasons and their IDs:

Response

Status Code

HTTP/1.1 200 OK

Headers

Content-Type: application/json

Body

Sample: