Skip to main content
GET
List Coupons

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Query Parameters

altId
string
required

Location Id

Example:

"BQdAwxa0ky1iK2sstLGJ"

altType
enum<string>
required

Alt Type

Available options:
location
Example:

"location"

limit
number
default:100

Maximum number of coupons to return

Example:

10

offset
number
default:0

Number of coupons to skip for pagination

Example:

0

status
enum<string>

Filter coupons by status

Available options:
scheduled,
active,
expired
Example:

"active"

Search term to filter coupons by name or code

Example:

"DEAL50"

Response

Successful response

data
object[]
required

Array of coupon objects

totalCount
number
required

Total number of coupons matching the query criteria

Example:

20

traceId
string
required

Unique identifier for tracing this API request

Example:

"c667b18d-8f5e-44cf-a914"

Last modified on March 8, 2026