Skip to main content
GET
Get 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.

dealId
integer
required

The ID of the quantity deal.

Response

200 - application/json
id
integer
Example:

1

shop_id
integer
Example:

1

name
string
Example:

"Bulk Discount"

product_id
integer
Example:

1

variant_id
integer
Example:

1

buy_quantity
integer
Example:

5

discounted_quantity
integer
Example:

5

percentage
string
Example:

"10.00"

max_uses_per_cart
string
Example:

null

priority
integer
Example:

0

starts_at
string
Example:

null

ends_at
string
Example:

null

enabled
boolean
Example:

true

created_at
string
Example:

"2026-09-20T15:56:24.000000Z"

updated_at
string
Example:

"2026-09-20T15:56:24.000000Z"

product
object
variant
object