Skip to main content
POST
Create Quantity Deal

Authorizations

Authorization
string
header
required

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

Path Parameters

shopId
integer
required

The ID of the shop.

Body

application/json
name
string
required

Must not be greater than 255 characters.

Example:

"tjqotbhpzwonwlzospqcs"

product_id
integer
required

Must match an existing stored value.

Example:

6

buy_quantity
integer
required

Must be at least 1.

Example:

60

discounted_quantity
integer
required

Must be at least 1.

Example:

55

percentage
number
required

Must be at least 0.01. Must not be greater than 100.

Example:

19

enabled
boolean
required
Example:

false

variant_id
integer | null

Must match an existing stored value.

Example:

6

max_uses_per_cart
integer | null

Must be at least 1.

Example:

44

priority
integer | null

Must be at least 0.

Example:

27

starts_at
string | null

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

Example:

"2012-05-28"

ends_at
string | null

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

Example:

"2012-05-28"

Response

200