Vouchers

Scroll large amounts of vouchers

The scroll Id obtained here should be passed to the scroll endpoint to continue the scroll operation (fetch the next page of results). Page/take not relevant default is 5000 vouchers in each batch. Scrolling is not intended for real time user requests, but rather for processing large amounts of data.

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

Request body

takeinteger

Paged search - max number of invoices to return

pageinteger

Paged search - page

customerIdsstring[] nullable

Search Vouchers by customerIds

statusesstring[] nullable

Search Vouchers by statuses [Available, Applied, Redeemed, Expired]

sortOrderstring nullable

Sort result. Available options [CreatedAscending, CreatedDescending, ModifiedAscending, ModifiedDescending, ExpiryDateAscending, ExpiryDateDescending]

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.