Products | Inventory

Search inventory transactions using available parameters in OmniumInventoryTransactionSearchRequest.

Sample request for a transaction search by SKU:

POST /api/inventory/searchtransactions
{
   "skuId": "ABC123",
   "take": 50,
   "page": 1
}
        

Sample request for transactions within a date range:

POST /api/inventory/searchtransactions
{
   "from": "2024-01-01T00:00:00Z",
   "to": "2024-01-31T23:59:59Z",
   "take": 100,
   "page": 1
}
        

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

{
  "totalHits": 15000,
  "result": [
    {
        "variant": "ABC123",
        "warehouseCode": "WH001",
        "inventoryChange": 5,
        "transactionDate": "2024-01-15T10:30:00Z",
        "transactionType": "PurchaseOrder"
    },
    {
      "variant": "ABC124",
      ...
    }
  ],
  "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 ScrollTransactions endpoint to fetch all remaining transactions.

post/api/Inventory/SearchTransactions

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/SearchTransactions
  • Auth: API key in header Authorization

Request body

takeinteger

Number of items to take (page size)

pageinteger

Page number (starts from 1)

productIdstring nullable

Filter by product ID

skuIdstring nullable

Filter by SKU ID

purchaseOrderIdstring nullable

Filter by purchase order ID

userIdstring nullable

Filter by user ID

orderIdstring nullable

Filter by order ID

warehouseCodesstring[] nullable

Filter by warehouse codes

searchTextstring nullable

Search text for general search

fromstring date-time nullable

Start date for transaction date range

tostring date-time nullable

End date for transaction date range

Response

Search successful, returning inventory transactions

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.