Skip to main content

Retrieve a coupon

Retrieve a coupon

Authorizations:Token, JWT
Query Parameters
id
required
integer>= 1

Responses

200Coupon resource
Response schema:
Coupon resource
codestring[4 .. 16] characters
enabledbooleanDefault: trueExample: true
valuenumber
typestringDefault: "%"Example: "%"
commentstring
date_range_beginstring or null
date_range_endstring or null
total_range_beginnumber
total_range_endnumber
uses_limitinteger>= 0
uses_limit_per_userinteger>= 0
single_useboolean
specific_productsboolean
product_classesArray of integers
membershipsArray of integers
zonesArray of integers
productsArray of integers
categoriesArray of integers
abandoned_cartinteger or null>= 0
abandoned_cart_couponboolean
idinteger or null>= 1
401Unauthorized
Response schema:
Unauthorized
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
404Resource not found
Response schema:
Resource not found
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
500Internal error
Response schema:
Internal error
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null