v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Gift Cards

Search gift cards

Search specific gift card information or obtain a comprehensive list of all existing gift card details.

get/gift_cards

Query parameters

gift_card_idstring

Search for specific gift card ID(s). Comma separate for multiple.

gift_card_codestring

Search for specific gift cards.

gift_card_activeboolean

Return gift cards with a specific active status.

limitinteger

Limit the number of results. Default: 25, max: 200.

offsetinteger

Offset the results

sort_bystring

Field to sort result by

order'asc' | 'desc'

Order by asc or desc

Response

totalinteger

Example response

{
  "gift_cards": [
    {
      "date_expire": "2023-04-01 00:00:00",
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00"
    }
  ]
}