Retrieve a list of coupons

Retrieve a list of coupons

Authorizations:Token, JWT

Query Parameters

page	integerDefault: 1The collection page number
itemsPerPage	integer[0 .. 100]Default: 30The number of items per page
pagination	booleanEnable or disable pagination

Responses

200Coupon collection

Response schema: application/jsonapplication/ld+json

Coupon collection

Array

code	string[4 .. 16] characters
enabled	booleanDefault: true
value	number
type	stringDefault: "%"
comment	string
date_range_begin	string
date_range_end	string
total_range_begin	number
total_range_end	number
uses_limit	integer>= 0
uses_limit_per_user	integer>= 0
single_use	boolean
specific_products	boolean
product_classes	Array of integers
memberships	Array of integers
zones	Array of integers
products	Array of integers
categories	Array of integers
abandoned_cart	integer>= 0
abandoned_cart_coupon	boolean
id	integer>= 1

401Unauthorized

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Unauthorized

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null

500Internal error

Response schema: application/jsonapplication/ld+jsonapplication/vnd.api+jsontext/html

Internal error

type	stringExample: "https://tools.ietf.org/html/rfc2616#section-10"
title	stringExample: "An error occurred"
detail	string or nullExample: "Cannot find entity"
instance	string or null