- Store API
- Admin API
- Auth
- Batch Jobs
- Currencies
- Customers
- Customer Groups
- Discounts
- Create a ConditionPOST
- Create a DiscountPOST
- List DiscountsGET
- Get a ConditionGET
- Update a ConditionPOST
- Delete a ConditionDELETE
- Create a Dynamic CodePOST
- Remove Batch ResourcesDELETE
- Add Batch ResourcesPOST
- Get Discount by CodeGET
- Delete a Dynamic CodeDELETE
- Add Region to DiscountPOST
- Remove RegionDELETE
- Delete a DiscountDELETE
- Update a DiscountPOST
- Get a DiscountGET
- Draft Orders
- Gift Cards
- Inventory Items
- Invites
- Notes
- Notifications
- Orders
- Create a Reservation
- Cancel Claim's Fulfillment
- Ship a Claim's Fulfillment
- Cancel Swap's Fulfilmment
- Get Order Reservations
- Add a Shipping Method
- Create a Refund
- Get an Order
- Update an Order
- Create a Fulfillment
- Cancel a Swap
- List Orders
- Create a Swap
- Complete an Order
- Create a Swap Fulfillment
- Cancel a Claim
- Process a Swap Payment
- Ship a Fulfillment
- Capture an Order's Payments
- Archive Order
- Update a Claim
- Request a Return
- Create a Claim Fulfillment
- Ship a Swap's Fulfillment
- Cancel a Fulfilmment
- Create a Claim
- Cancel an Order
- Order Edits
- Payments
- Payment Collections
- Product Collections
- Product Tags
- Product Types
- Product Variants
- Price Lists
- Products
- Product Categories
- Publishable Api Keys
- Reservations
- Regions
- Return Reasons
- Returns
- Sales Channels
- Shipping Options
- Shipping Profiles
- Stock Locations
- Store
- Swaps
- Uploads
- Tax Rates
- Users
- 【Demo】Products
List Discounts
GET
/admin/discounts
Admin API/DiscountsDiscounts
rule
or is_dynamic
. The discounts can also be paginated.Request
Query Params
q
string
optional
type
string
optional
allocation
string
optional
is_dynamic
string
optional
is_disabled
string
optional
limit
number
optional
offset
number
optional
expand
string
optional
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/admin/discounts'
Responses
🟢200OK
application/json
Body
count
integer
required
offset
integer
required
limit
integer
required
discounts
array[object (Discount) {18}]
required
id
string
required
Example:
disc_01F0YESMW10MGHWJKZSDDMN0VN
code
string
required
Example:
10DISC
is_dynamic
boolean
required
Example:
false
rule_id
string | null
required
Example:
dru_01F0YESMVK96HVX7N419E3CJ7C
is_disabled
boolean
required
Example:
false
parent_discount_id
string | null
required
Example:
disc_01G8ZH853YPY9B94857DY91YGW
parent_discount
object | null
optional
starts_at
string <date-time>
required
ends_at
string <date-time> | null
required
valid_duration
string | null
required
Example:
P3Y6M4DT12H30M5S
usage_limit
integer | null
required
Example:
100
usage_count
integer
required
Default:
0
Example:
50
created_at
string <date-time>
required
updated_at
string <date-time>
required
deleted_at
string