Orders | Gift Cards

Scroll gift cards by search

Scrolling is not intended for real time user requests, but rather for processing large amounts of data. Only use scroll endpoints if you intend to fetch all items returned by the search request. Paging (take, page) is disabled for scroll searches.

post/api/GiftCard/Scroll

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

Request body

takeinteger

Number of items to take

pageinteger

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

createdFromstring date-time nullable

GiftCard created from date

createdTostring date-time nullable

GiftCard created before date

giftCardCodesstring[] nullable

Search by multiple gift card codes.

marketIdsstring[] nullable

Filter by gift cards created in specific markets.

marketIdstring nullable

Filter by gift card created in specific market.

isExpiredboolean nullable

Filter by gift cards expired or not.

Response

Search successful, returning gift cards

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.