v1
latestOpenAPI 3.0.12026-07-2412502.6 MBDiscounts
Search discounts
Returns details for all available discounts.
get/discounts
Query parameters
discount_idstring
Search for specific discount ID(s). Comma separate for multiple.
discount_namestring
Search by discount name.
discount_codestring
Search by discount code.
discount_type_id1 | 2
- 1 - One Time Code
- 2 - Recurring Code
discount_category_idinteger
Search by discount category.
discount_activeboolean
Return discounts with a specific active status.
offer_idinteger
Return discounts that are associated with a specific offer ID.
with'discount_cycles' | 'discount_offers'
Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=discount_cycles,discount_offers)
limitinteger
Limit the number of results. Default: 25, max: 200.
offsetinteger
Offset the results
sort_bystring
Field to sort result by
order'asc' | 'desc'
Order by asc or desc
Response
OK
Example response
{
"discounts": [
{
"discount_expiration_date": "2023-04-01 00:00:00",
"discount_offers": [
{
"date_created": "2023-04-01 00:00:00",
"date_modified": "2023-04-01 00:00:00",
"offer_cycles": [
{
"date_created": "2023-04-01 00:00:00",
"date_modified": "2023-04-01 00:00:00",
"offer_cycle_items": [
{
"date_created": "2023-04-01 00:00:00",
"date_modified": "2023-04-01 00:00:00"
}
],
"charge_timeframe": {
"date_created": "2023-04-01 00:00:00",
"date_modified": "2023-04-01 00:00:00"
}
}
],
"offer_timeframes": [
{
"date_created": "2023-04-01 00:00:00",
"date_modified": "2023-04-01 00:00:00"
}
],
"offer_swap_options": [
{
"date_created": "2023-04-01 00:00:00",
"date_modified": "2023-04-01 00:00:00"
}
]
}
]
}
]
}