Skip to main content

Retrieve a list of coupons

Retrieve a list of coupons.

Authorizations:Token, JWT
Query Parameters
pageintegerDefault: 1The collection page number

Responses

200Coupon collection
Response schema:
Coupon collection
Array
abandoned_cartinteger>= 0
abandoned_cart_couponboolean
vendorinteger
all_vendorsbooleanDefault: true
idinteger>= 0
codestring<= 16 characters
enabledboolean
valuenumber
typestring
commentstring
date_range_beginstring
date_range_endstring
total_range_beginnumber
total_range_endnumber
uses_limitinteger
uses_limit_per_userinteger
single_useboolean
specific_productsboolean
product_classesArray of integers
membershipsArray of integers
zonesArray of integers
productsArray of integers
categoriesArray of integers
401Unauthorized
Response schema:
Unauthorized
typestring
titlestring
detailstring or null
instancestring or null
500Internal error
Response schema:
Internal error
typestring
titlestring
detailstring or null
instancestring or null