Products | Prices

Search prices using available parameters in OmniumPriceSearchRequest.

NB! Only to be used when price index is enabled for tenant. Send email to support@omnium.no if you need more information. <br /> Sample request for a delta query:

             POST /api/prices/search
             {
                "LastModified": "2019-11-21T17:32:28Z"
             }
        
         Sample request for prices for a specific customer in one or more markets:
        
             POST /api/prices/search
             {
                "CustomerId": "CU12345",
                "MarketIds": ["NOR", "SWE"]
             }
        
         Sample request for prices valid at a specific point in time (set ValidFrom and ValidUntil to the same timestamp):
        
             POST /api/prices/search
             {
                "ProductCodes": ["SKU12345678"],
                "ValidFrom": "2026-06-18T00:00:00Z",
                "ValidUntil": "2026-06-18T00:00:00Z"
             }
        
         Samples response if the number of prices 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 prices
        
             {
               "totalHits": 41244,
               "result": [
                 {
                   "marketId": "NOR",
                   "code": "SKU12345678",
                   "validFrom": "2020-01-01T00:00:00",
                   "validUntil": "2020-02-01T00:00:00",
                   "minQuantity": 0,
                   "unitPrice": 900,
                   "currencyCode": "NOK",
                   "customerId": "C-123",
                   "discountAmount": 100,
                   "discountPercent": 10,
                   "originalUnitPrice": 1000,
                   "recommendedRetailPrice": 2000
                 },
                 {
                   "marketId: "NOR",
                   ...
                 }
               ],
               "scrollId": "2f842421e06e4c60bb2c4f0d8b3ef60b"
             }
                 
         
         Please note that if the total amount is larger than 1000 (or scrollSize if specified) , the response will contain a Scroll ID which can be used with the Scroll endpoint to fetch all remaining items.
post/api/Prices/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/Prices/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

customerIdstring nullable

Filter prices on customer ID

customerGroupIdstring nullable

Filter prices on Customer Group ID

marketIdstring nullable

Filter prices on market ID

marketIdsstring[] nullable

Filter prices on one or more market IDs. A price matches if its market ID is any of the provided values. Takes precedence over the obsolete MarketId.

productCodesstring[] nullable

Filter prices on product codes (SKU / Product ID)

priceTypestring nullable

Filter prices on price type

scrollSizeinteger nullable

Optional: The number of items returned for each scroll request. Default value is 1000. Max is 20000 and minimum is 500.

unitstring nullable

Filter prices on unit

isCustomerSpecificPriceboolean nullable

Filter prices by customer specific prices. Set to 'true' to get only customer specific prices. Set to 'false' to get prices that are not customer specific. If not assigned, no customer filtering will be applied.

validFromstring date-time nullable

Only return prices that are valid from this point in time, i.e. prices whose ValidFrom is on or before this value (prices without a ValidFrom are always included). Combine with ValidUntil set to the same timestamp to get prices valid at a single moment. If not set, no start-of-validity filtering is applied.

validUntilstring date-time nullable

Only return prices that are still valid at this point in time, i.e. prices whose ValidUntil is on or after this value (prices without a ValidUntil never expire and are always included). Combine with ValidFrom set to the same timestamp to get prices valid at a single moment. If not set, no end-of-validity filtering is applied.

Response

Search successful, returning prices

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.