Skip to main content
GET
Get Coupons

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Path Parameters

shopId
integer
required

The shop ID.

Body

application/json
page
integer

Page number.

Example:

1

perPage
integer

Items per page, 1-100. Must be at least 1. Must not be greater than 100.

Example:

null

orderColumn
enum<string>
Available options:
id,
code,
discount,
uses,
start_date,
expiration_date,
last_used_at,
total_saved,
revenue_attributed
Example:

null

orderDirection
enum<string>
Available options:
asc,
desc
Example:

null

code
string

Filter by coupon code.

Example:

null

ids
integer[]

Filter by coupon IDs.

Example:

null

statuses
string[]
Example:

null

type
enum<string>
Available options:
percentage,
fixed
Example:

null

global
boolean

Only global (all-products) coupons.

Example:

null

Response

200 - application/json
current_page
integer
Example:

1

data
object[]
Example:
first_page_url
string
Example:

"http://api.sellauth.test/v1/shops/1/coupons?page=1"

from
integer
Example:

1

last_page
integer
Example:

1

last_page_url
string
Example:

"http://api.sellauth.test/v1/shops/1/coupons?page=1"

Example:
next_page_url
string
Example:

null

path
string
Example:

"http://api.sellauth.test/v1/shops/1/coupons"

per_page
integer
Example:

20

prev_page_url
string
Example:

null

to
integer
Example:

1

total
integer
Example:

1