Inventory Inquiry

This API allows the user to request the inventory information of an item or items that belong to a particular manufacturer. Note that this is a POST call instead of a GET as may be expected – in this inquiry, additional information is required in a request body to specify the inventory being retrieved.

Note that there are two endpoints that may be used. Each endpoint is associated with a different API key related to a package – either an “Inventory V5” or “Inventory Specific” package. The Inventory Specific package is the preferred endpoint to use, but some implementations may use Inventory V5 depending on their configuration.

In either case, the request body and parameter schemas outlined in this guide are the exact same as in the previous version of OMS, as the Unified Commerce platform supports backwards compatibility for this API. The only change to this request is the format of the base endpoints, as shown in the below table. Remember to provide the x-vol-tenant key for authentication in the headers.

Example

The example case will inquire about an inventory with the following properties:

• Inventory of item “testsku120”
• At any location of manufacturer 00000 within 100 miles of Postal Code 11111

Required Parameters

These parameters are necessary for the Inventory API to return a successful response:

The type enum values are defined as:

Each entry in the items array is an object that requires a quantity and any one of the other parameters in the table below:

Optional Parameters

Other possible parameters can be provided to specify other details about the product. These variables are:

The requestLocation details is an object that includes the following parameters to identify a single location that the inventory search should be made within range of. The longitude, latitude, or postal code are required.

The Full Request

This is the entire request that will inquire about an inventory item from a particular manufacturer, within a particular postal code range.

{
 "manufacturerID": "00000",
 "fulfillerID": "010101",
 "includeNegativeInventory":true,
 "type": "ANY",
 "requestLocation":{
    "postalCode": "11111",
    "radius": 100,
    "unit": "MILES",
    "countryCode": "US"
 }, 
 "items": [{
  "partNumber": "testsku120",
  "quantity": 1
 }]
}

The Full Response

This is the entire response of the inquiry. It returns with order data grouped by location. In this case there is only one location with inventory of this product, so there is only one block of data. If applicable, this response will also return the inventoryLocatorName (a parameter provided via the Refresh and Adjust APIs) to indicate where the inventory item can be found at the location.

If the particular configuration of OMS makes use of inventory attributes, those would be returned in this response as an array of strings. These attributes are cached in an inventory map with no expiration, so they can be retrieved as necessary for cases such as inventory replenishment.

[
 {
 "locationName": "1",
 "locationID": 111111,
 "manufacturerID": 00000,
 "onHand": 101,
 "available": 94,
 "partNumber": "testsku120"
 "sku": "testsku120",
 "ltd": 0,
 "floor": 0,
 "safetyStock": 0,
 "distance": 0,
 "shippingLocation": true,
 "restockEnabled": false,
 "pickupEnabled": true,
 "countryCode": "US",
 "finderbotEnabled": false,
 "hasStorefront": false,
 }
]