Skip to main content
GET
List gift card orders

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

Search gift card orders by id

filter[gift_card_id]
string

Filter by exact gift card id. Supports comma-separated values for multiple matches.

Example:

374097

filter[gift_card_offer_id]
string

Filter by exact gift card offer id. Supports comma-separated values for multiple matches.

Example:

953282

filter[region_id]
string

Filter by exact region id. Supports comma-separated values for multiple matches.

Example:

735836

filter[brand_id]
string

Filter by exact brand id. Supports comma-separated values for multiple matches.

Example:

231504

filter[buyer_id]
string

Filter by exact buyer id. Supports comma-separated values for multiple matches.

Example:

124956

filter[status]
enum<string>

Filter by order status

Available options:
pending,
in_delivery,
delivered,
refunded
Example:

"pending"

filter[created_at]
string

Filter by created at. Supports single date (YYYY-MM-DD) or date range (YYYY-MM-DD,YYYY-MM-DD).

Example:

"2019-08-14,2025-12-31"

filter[updated_at]
string

Filter by updated at. Supports single date (YYYY-MM-DD) or date range (YYYY-MM-DD,YYYY-MM-DD).

Example:

"2025-10-05"

filter[completed_at]
string

Filter by completed at. Supports single date (YYYY-MM-DD) or date range (YYYY-MM-DD,YYYY-MM-DD).

Example:

"2019-08-14,2025-12-31"

filter[refunded_at]
string

Filter by refunded at. Supports single date (YYYY-MM-DD) or date range (YYYY-MM-DD,YYYY-MM-DD).

Example:

"2019-08-14,2025-12-31"

sort
enum<string>
default:-created_at

Sort by field. Prefix with - for descending order.

Available options:
id,
-id,
unit_price,
-unit_price,
price,
-price,
quantity,
-quantity,
created_at,
-created_at,
updated_at,
-updated_at,
completed_at,
-completed_at
Example:

"-created_at"

per_page
integer
default:15

Items per page (max 50)

Required range: 1 <= x <= 50

Response

A paginated list of gift card orders

data
object[]
meta
object