List promotions
Returns your coupons, cross-sells and up-sells, oldest first unless you choose another sort_by. Secret and trusted tokens may call it.
AuthorizationBearer <token>A secret, trusted or limited token. See Authentication.
offset?integerFor offset-based lists, how many items to skip before the page starts. Use next_page_offset or previous_page_offset from the page you have. A value that is not a whole number is a 400.
0 <= value0limit?integerHow many items to return on one page, from 1 to 100. The default is 100. A value outside 1 to 100, or one that is not a whole number, is a 400.
1 <= value <= 100100sort_by?stringThe field to sort by. The default is date_created.
"date_created""date_modified""promotion_id""name"desc?booleanSort in descending order (newest, largest or last first) when true. The default is false. A value other than true or false is a 400.
falseshow?stringComma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.
hide?stringComma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.
formatted?booleanWhen true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.
falseq?stringSearch text. Returns the promotion with this exact id and the first promotion whose name contains the text.
active?booleanOnly promotions with this active value.
type?stringOnly promotions of this type.
"coupon""cross_sell""up_sell"A page of promotions.
application/json- response
A page of promotions. An offset-based list.
total_items*integerThe number of items that match, across all pages.
total_pages*integerThe number of pages.
current_page*integerThe number of this page.
next_page_url*|The URL of the next page, or null on the last page.
urinext_page_offset*|The offset of the next page, or null on the last page.
previous_page_url*|The URL of the previous page, or null on the first page.
uriprevious_page_offset*|The offset of the previous page, or null on the first page.
current_page_url*stringThe URL of this page.
uridata*array<>The items on this page.
curl -X GET 'https://api.comecero.com/api/v1/promotions'{ "total_items": 1, "total_pages": 1, "current_page": 1, "next_page_url": null, "next_page_offset": null, "previous_page_url": null, "previous_page_offset": null, "current_page_url": "https://api.comecero.com/api/v1/promotions?offset=0", "data": [ { "object": "promotion", "url": "https://api.comecero.com/api/v1/promotions/0070576784690PtKDqfI", "promotion_id": "0070576784690PtKDqfI", "name": "Ten percent off", "test": true, "account_id": "AB1234", "date_created": "2026-11-02T20:13:16Z", "date_modified": "2026-11-02T20:13:16Z", "type": "coupon", "active": true, "apply_to_recurring": false, "apply_to_recurring_count": null, "use_count": 4, "expires": null, "comments": null, "config": { "type": "order", "code": "SAVE10", "generator_prefix": null, "generator_secret_key": null, "discount_percent": 0.1, "discount_amount": null, "product_ids": null, "exclude_product_ids": false, "max_uses_per_customer": 1, "max_uses_global": null } } ]}