Skip to main content
PUT
Update Coupon

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.

couponId
integer
required

Body

application/json
code
string
required
Example:

"culpa"

global
boolean
required
Example:

false

discount
number
required

Must be at least -999999. Must not be greater than 999999.

Example:

19

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

"percentage"

max_uses
number

Must be at least 1. Must not be greater than 999999.

Example:

25

max_uses_per_customer
number

Must be at least 1. Must not be greater than 999999.

Example:

22

min_invoice_price
number

Must be at least 0. Must not be greater than 999999.

Example:

18

start_date
string

Must be a valid date. Must be a date before 2038-01-19.

Example:

"2020-09-01"

expiration_date
string

Must be a valid date. Must be a date after today. Must be a date before 2038-01-19.

Example:

"2020-09-01"

allowed_emails
string[]

Must be a valid email address.

Example:
payment_method_ids
string[]
Example:

null

disable_if_volume_discount
boolean
Example:

false

disable_if_quantity_deal
boolean
Example:

false

disable_if_bundle_offer
boolean
Example:

false

disable_if_gateway_discount
boolean
Example:

true

disable_if_affiliate_discount
boolean
Example:

true

uses_count_mode
enum<string>
Available options:
pending,
paid
Example:

"paid"

applies_to_renewals
boolean
Example:

true

items
string[]

This field is required when global is false.

Example:

Response

200 - undefined