Orders | Gift Cards

Get gift card by gift card code

get/api/GiftCard/{code}

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/{code}
  • Auth: API key in header Authorization

Path parameters

codestring nullable required

Query parameters

marketIdstring nullable
giftCardPinstring nullable

Gift card PIN, if required, along with the code provided by the gift card provider.

Response

Gift card found and returned

idstring nullable

Gift card id

balancenumber

Current balance on gift card

type'GiftCard' | 'CreditNote'
currencystring nullable

Gift card currency

customerIdstring nullable

Unique customerId

customerNamestring nullable

Name of customer

customerEmailstring nullable

Customer email

giftCardCodestring nullable

Gift card code/number

descriptionstring nullable

Description

isClosedboolean nullable

Is gift card closed/not usable

validUntilstring date-time nullable

Gift card valid date

closedstring date-time nullable

Date for when the gift card was closed

modifiedstring date-time nullable

Last modified date

createdstring date-time nullable

Gift card created date

marketIdstring nullable

The market the gift card originates from.

Changes

No recorded changes to this operation across all 1 revision of this API.