Skip to main content
GET
TypeScript

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

promo_code:basic:read

Başlıklar

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Sorgu Parametreleri

account_id
string
gerekli

Account whose promo codes are listed (biz_ tag).

status
enum<string>

Promo-code status. expired groups inactive and archived codes.

Mevcut seçenekler:
active,
inactive,
archived,
expired
product_ids
string[]

Only promo codes scoped to these product IDs.

variant_ids
string[]

Only promo codes scoped to these variant IDs.

created_before
string<date-time>

Only promo codes created before this ISO 8601 timestamp.

created_after
string<date-time>

Only promo codes created after this ISO 8601 timestamp.

order
enum<string>
varsayılan:created_at

Sort field.

Mevcut seçenekler:
created_at
direction
enum<string>
varsayılan:desc

Sort direction.

Mevcut seçenekler:
asc,
desc
first
integer
varsayılan:20

Number of results to return from the start of the range.

Gerekli aralık: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Gerekli aralık: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

include_total_count
boolean

Set to true to return the number of matching results in page_info.total_count. Send first=0 as well to return the count without any results.

Yanıt

promo codes listed

data
object[]
gerekli
page_info
object
gerekli