Products | Price Lists

Search price lists

post/api/PriceLists/SearchPriceLists

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

Request body

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, CreatedDescending, ModifiedAscending, ModifiedDescending, NameAscending, NameDescending, MarketAscending, MarketDescending, CurrencyAscending, CurrencyDescending.

storeIdsstring[] nullable

Store ID filter

currencyCodesstring[] nullable

Currency filter

marketIdsstring[] nullable

Market filter

marketGroupIdsstring[] nullable

Market group filter

includeEmptyMarketIdboolean

If true, price lists with empty market IDs are returned

includeEmptyStoreIdsboolean

If true, price lists with empty store IDs are returned

supplierIdsstring[] nullable

Supplier filter

isActiveboolean nullable

If true, only active price lists are returned.

Response

Success

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.