API Reference

About Inventory

Products in Omnium are enriched with inventory items. The inventory item carries information about:

Physical inventory
Reserved inventory
Available inventory
Inventory location

An inventory item identifier/key is created from the variant and warehouse code. The warehouse code is the ID of the store/warehouse where the inventory is located.

Note: Adding an inventory item with a warehouseCode and a variant will override any inventory item with the same warehouseCode and inventory.

Creating Inventory Items

Add inventory in the GUI
Import/export inventory items in the GUI
Import through API

Inventory Item Model

For details, refer to the Omnium Inventory Model.

Inventory Sample

Inventory items for the store OmniumBikeShop could look like this:

{
  "sku": "Topeak-43543512",
  "warehouseCode": "WebShop",
  "inventory": 19,
  "reservedInventory": 3,
  "location": null
}

In the Omnium GUI, the inventory item can be displayed as shown below:

Store in the GUI

Create Inventory Items

Add inventory items to Omnium by posting a list of OmniumInventoryItem to the add many endpoint. If the item exists, it will be overridden by the object posted to the endpoint.

For more details, visit the Create inventory items documentation.

Get Inventory Item

Get Single Inventory Item

Inventory items are fetched via a GET request to the inventory endpoint.

An optional parameter for warehouse IDs is available. If warehouseIds is empty, all inventory items for the SKU will be returned.

For more details, visit the Get inventory item documentation.

Search Inventory Items

Sample request for a delta query:

POST /api/inventory/search
{
  "LastModified": "2019-11-21T17:32:28Z"
}

Sample request for inventory for a specific market:

POST /api/inventory/search
{
  "MarketId": "NOR"
}

Sample response if the number of inventory items exceeds 1000 (totalHits):

{
  "totalHits": 41244,
  "result": [
    {
      "sku": "102103",
      "warehouseCode": "40",
      "inventory": 33,
      "reservedInventory": 7,
      "location": "32D-A2"
    },
    {
      "sku": "102104",
      ...
    }
  ],
  "scrollId": "2f842421e06e4c60bb2c4f0d8b3ef60b"
}

Note: If the total number of items exceeds 1000, the response will contain a Scroll ID, which can be used with the Scroll endpoint to fetch all remaining items.

For more details, visit the Search inventory items documentation.

Update Inventory Item

To update an inventory item, send a PUT request with the inventory object to the inventory update endpoint.

For more details, visit the Update inventory item documentation.

Update Multiple Inventory Items

To update multiple inventory items, send a PUT request to the inventory update many endpoint.

Delete Inventory Item

To delete an inventory item, send a DELETE request to the inventory endpoint:

For more details, visit the Delete inventory item documentation.

Note:The inventory item will be permanently deleted and cannot be recovered.

The inventory field is not live but is updated via a scheduled task.
If a product has inventory in the queried market, the inventory field will be included in the response.
If a product has no inventory, the inventory field will be absent (not an empty array).

Update mechanism

Inventory data is updated through a scheduled task called Product Inventory.
This task can be added from Config → Advanced → Scheduled Task.
If an inventory change is made, the updated data will not be immediately reflected in the Product Search API response until the scheduled task runs.
This can lead to cases where a product temporarily appears without an inventory field even though inventory exists.

Example request

Request

{
  "page": 1,
  "take": 200,
  "storeId": "bike-shop-web-no",
  "productLanguage": "no",
  "sortOrder": "CreatedAscending",
  "isFacetsDisabled": true,
  "isActive": true,
  "excludedFields": {
    "isEverythingExcluded": true
  },
  "includedFields": {
    "specificFields": ["inventory"]
  },
  "productIds": ["V-553456", "DMR Vault Pedal"]
}

Response examples

Case 1: Inventory Exists

{
  "productId": "V-553456",
  "inventory": [{
    "storeId": "bike-shop-web-no",
    "quantity": 10
  }]
}

Case 2: No inventory (Field absent)

{
  "productId": "V-553457"
}

Important notes

The inventory field will not be present if the product has no inventory.
If inventory was recently updated, the scheduled task may not have processed the changes yet.