Products | Price List Items

Scroll price list items using available parameters in OmniumPriceListItemSearchRequest.

Notice that the 'scrollId' property has been populated as totalHits exceeds 1000, meaning that you should use the scroll endpoint to fetch remaining prices list items

{
  "totalHits": 41244,
  "result": [
    {
      "priceListId": "...",
      "skuId": "SKU12345678",
      ...
    },
    {
      "marketId: "NOR",
      ...
    }
  ],
  "scrollId": "ifd42421406egc603b2c4f0d8b3ef60b"
}
    

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/PriceListItems/ScrollSearch

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

Request body

priceListIdstring nullable

Price list ID

priceListIdsstring[] nullable

Price list IDs

pageinteger

Page (Fetches from [Page * Take] to [(Page + 1) * Take]).

takeinteger

Number of items to take.

searchTextstring nullable

Free text search

sortOrderstring nullable

Sort order for the results. Defaults to created date descending. Possible values: CreatedAscending,

scrollSizeinteger nullable

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

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.