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'
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
Last updated