Skip to main content
GET
List gift card orders

Authorizations

x-api-key
string
header
required

Your API key, starting with ct_key_.

x-api-secret
string
header
required

Your API secret, starting with ct_secret_.

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
status
enum<string>
Available options:
purchased,
submitted,
partially_paid,
issue,
paid,
cancelled
retailer
string

Exact retailer name, case-insensitive.

orderNumber
string

Exact order number.

orderDateFrom
string<date>

Earliest order date, inclusive.

orderDateTo
string<date>

Latest order date, inclusive.

Response

A page of orders.

data
object[]
required
pagination
object
required