Gift Card List

GET 
/openapi/2022-01/gift_cards

Retrieves a list of gift cards with various filtering options.

Request

Query Parameters

status string

Status of the gift card

created_at_min string

Filter gift card created at or after date, for example: 2018-10-01T16:15:47-04:00

created_at_max string

Filter gift card created at or before date, for example: 2018-10-01T16:15:47-04:00

updated_at_min string

Filter gift card last updated at or after date, for example: 2018-10-01T16:15:47-04:00

updated_at_max string

Filter gift card last updated at or before date, for example: 2018-10-01T16:15:47-04:00

initial_value_min string

The initial value of the gift card is greater than this value.

initial_value_max string

The initial value of the gift card is smaller than this value

page string

Page number

limit string

Limit per page

ids string

Gift card ids， for example: 377026890382183978,377006280092433706

Responses

200

200

application/json

Schema

Schema

gift_cards object[]
Array [
idstring
Example: 377026890382183978
last_charactersstring
Example: 218p
balancestring
Example: 100.00
initial_valuestring
Example: 100.00
notestring
Example: note
expires_on
disabled_at
enabledboolean
Default value: true
Example: true
created_atstring
Example: 2024-05-06T10:12:05Z
updated_atstring
Example: 2024-05-06T10:12:05Z
statusstring
Example: enable
currencystring
Example: USD
line_item_id
order_id
user_idstring
Example: cba51e16-ac53-43d8-a7a3-161c5b1ecd8e
template_suffix
customer_idstring
Example: 2dd957e3-2051-4cdf-8584-9c0046b4d1ae
]
totalstring
Example:

Example

{
  "gift_cards": [
    {
      "id": "377026890382183978",
      "last_characters": "218p",
      "balance": "100.00",
      "initial_value": "100.00",
      "note": "note",
      "expires_on": {},
      "disabled_at": {},
      "enabled": true,
      "created_at": "2024-05-06T10:12:05Z",
      "updated_at": "2024-05-06T10:12:05Z",
      "status": "enable",
      "currency": "USD",
      "line_item_id": {},
      "order_id": {},
      "user_id": "cba51e16-ac53-43d8-a7a3-161c5b1ecd8e",
      "template_suffix": {},
      "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae"
    }
  ],
  "total": ""
}

Result

{
  "gift_cards": [
    {
      "id": "377026890382183978",
      "last_characters": "218p",
      "balance": "100.00",
      "initial_value": "100.00",
      "note": "note",
      "expires_on": null,
      "disabled_at": null,
      "enabled": true,
      "created_at": "2024-05-06T10:12:05Z",
      "updated_at": "2024-05-06T10:12:05Z",
      "status": "enable",
      "currency": "USD",
      "line_item_id": null,
      "order_id": null,
      "user_id": "cba51e16-ac53-43d8-a7a3-161c5b1ecd8e",
      "template_suffix": null,
      "customer_id": "2dd957e3-2051-4cdf-8584-9c0046b4d1ae"
    },
    {
      "id": "377006280092433706",
      "last_characters": "ghjg",
      "balance": "100.00",
      "initial_value": "100.00",
      "note": "note",
      "expires_on": "2025-11-01T00:00:00Z",
      "disabled_at": null,
      "enabled": true,
      "created_at": "2024-05-06T10:06:04Z",
      "updated_at": "2024-05-06T10:06:04Z",
      "status": "enable",
      "currency": "USD",
      "line_item_id": null,
      "order_id": null,
      "user_id": null,
      "template_suffix": null,
      "customer_id": "8b91ccbd-37d0-4897-aac6-5082e64ca374"
    }
  ],
  "total": ""
}