List all gift cards

How to fetch a collection of gift cards via API

To fetch a collection of gift cards, send a GET request to the /api/gift_cards endpoint.

Request

GET https://yourdomain.commercelayer.io/api/gift_cards

Example

The following request fetches a collection of gift cards:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/gift_cards/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:

{
  "data": [
    {
      "id": "XAyRWNUzyN",
      "type": "gift_cards",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN"
      },
      "attributes": {
        "status": "draft",
        "code": "32db311a-75d9-4c17-9e34-2be220137ad6",
        "currency_code": "EUR",
        "initial_balance_cents": 15000,
        "initial_balance_float": 150.0,
        "formatted_initial_balance": "€150,00",
        "balance_cents": 15000,
        "balance_float": 150.0,
        "formatted_balance": "€150,00",
        "balance_max_cents": 100000,
        "balance_max_float": 1000.0,
        "formatted_balance_max": "€1000,00",
        "balance_log": [
          {
            "datetime": "2019-12-23T12:00:00.000Z",
            "balance_change_cents": -10000
          },
          {
            "datetime": "2020-02-01T12:00:00.000Z",
            "balance_change_cents": 5000
          }
        ],
        "usage_log": {
          "eNoKkhmbNp": [
            {
              "action": "use",
              "amount_cents": -1000,
              "balance_cents": 4000,
              "order_number": "11111",
              "datetime": "2020-02-01T12:00:00.000Z"
            }
          ]
        },
        "single_use": false,
        "rechargeable": true,
        "distribute_discount": true,
        "image_url": "https://img.yourdomain.com/gift_cards/32db311a.png",
        "expires_at": "2018-01-01T12:00:00.000Z",
        "recipient_email": "[email protected]",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANY-EXTERNAL-REFEFERNCE",
        "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "market": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/relationships/market",
            "related": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/market"
          }
        },
        "gift_card_recipient": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/relationships/gift_card_recipient",
            "related": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/gift_card_recipient"
          }
        },
        "attachments": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/relationships/attachments",
            "related": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/attachments"
          }
        },
        "events": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/relationships/events",
            "related": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/events"
          }
        },
        "tags": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/relationships/tags",
            "related": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/tags"
          }
        },
        "versions": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/relationships/versions",
            "related": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/versions"
          }
        },
        "event_stores": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/relationships/event_stores",
            "related": "https://yourdomain.commercelayer.io/api/gift_cards/XAyRWNUzyN/event_stores"
          }
        }
      },
      "meta": {
        "mode": "test",
        "organization_id": "xRRkjDFafe",
        "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
      }
    },
    {
      "other": "... 9 gift_cards (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/gift_cards?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/gift_cards?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/gift_cards?page[number]=14&page[size]=10"
  }
}

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of gift cards can be sorted by the following fields:

Attributes

status
currency_code
balance_cents
balance_max_cents
expires_at
id
created_at
updated_at
reference
reference_origin

Relationships

market
gift_card_recipient

Filterable fields

The list of gift cards can be filtered by the following fields:

Attributes

status
code
currency_code
balance_cents
balance_max_cents
single_use
rechargeable
expires_at
id
created_at
updated_at
reference
reference_origin
metadata

Relationships

market
gift_card_recipient
attachments
events
tags

PreviousCreate a gift card NextRetrieve a gift card

Last updated 1 month ago