List gift cards

Retrieves a list of gift cards with pagination.

get/gift-vouchers

Request

  • Base URL
    https://api.ecommerceapi.uk/v1
  • URL
    https://api.ecommerceapi.uk/v1/gift-vouchers
  • Auth
    HTTP basic

Query parameters

countinteger

Number of records to retrieve (default: 50, max: 100).

offsetinteger

Number of records to skip.

fieldsstring

Comma-separated list of fields to include in the response.

Response

A list of gift cards.

idinteger

Unique identifier for the gift card.

codestring

The unique code of the gift card.

amountnumber float

The value of the gift card.

amountUsednumber float

The amount of the gift card that has been used.

Changes

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