Products | Inventory

Search inventory items using available parameters in OmniumInventorySearchRequest.

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"
}        

Samples response if the number of inventory items exceeds 1000 (totalHits). <br /> Notice that the 'scrollId' property has been populated as totalHits exceeds 1000, meaning that you should use the scroll endpoint to fetch remaining inventory items

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

Please note that if the total amount is larger than 2000, the response will contain a Scroll ID which can be used with the Scroll endpoint to fetch all remaining items.

post/api/Inventory/Search

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Inventory/Search
  • Auth: API key in header Authorization

Request body

lastModifiedstring date-time nullable

Set LastModified to a specific DateTime to get items only modified after that time

marketIdstring nullable

Filter inventory on market ID

marketGroupIdstring nullable

Filter inventory on market group ID

productCodesstring[] nullable

Filter inventory on product codes (SKU / Product ID)

warehouseCodesstring[] nullable

Filter inventory on warehouse codes. Will be ignored if IsWebWarehouse is true

isWebWarehouseboolean

If true, search will return inventory for all warehouses with IsWebWarehouse set to true. WarehouseCodes list is ignored

isInStockboolean nullable

If true, only inventory items with positive values are returned

isBatchesExcludedboolean nullable

Indicates whether inventory batches should be excluded in the response. This is applicable only if the FIFO principle is activated.

Response

Search successful, returning inventory items

totalHitsinteger

Total number of hits

scrollIdstring nullable

The Scroll ID is used when fetching large amounts of data. Whenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents

isValidboolean

Deprecated

Changes

No recorded changes to this operation across all 1 revision of this API.