AppsThemesAPIs and referencesChangelogSupportFeedBack
Apps
Log inSign up
Start typing to search…

Get Coupon List

get
https://{subdomain}.myshoplaza.com/openapi/2025-06/coupons

Retrieves a paginated list of coupons available in the system.

🔒

Requires price_rules access scope.

The Coupon List API retrieves a paginated list of coupons available in the system.

This API is especially useful for:

  1. Displaying available coupons in storefronts
  2. Managing coupon campaigns in admin panels
  3. Implementing coupon search functionality
  4. Analyzing coupon performance and usage

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Query Parameters

Parameter

Type

Required

Description

Example

cursor

string

No

Cursor for pagination

"abc123"

page_size

int32

No

Number of records per page
(default: 10)

20

progress

string

No

Filter by coupon progress
(not_started, ongoing, finished)

"ongoing"

type

string

No

Filter by coupon type (fixed_amount, percentage, voucher)

"percentage"

keywords

string

No

Search coupons by title

"summer sale"

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Successful Response

ParameterTypeExampleDescription
codestring"success"Status code of the response
messagestringDescriptive message of the response
data.couponsarray[object]-Array of coupon objects
data.cursorstring"next_page_token"Pagination cursor
data.has_morebooleantrueWhether more coupons exist

Coupon Object

ParameterTypeExampleDescription
idstring"coupon_123"Unique coupon identifier
store_idinteger12345Store ID
life_cycle_typestring"date_range"Coupon lifecycle type
survival_timestring"P30D"Duration coupon is valid
starts_atstring"2025-06-01T00:00:00Z"Start datetime
ends_atstring"2025-06-30T23:59:59Z"End datetime
discount_typestring"percentage"Discount type
value_typestring"fixed"Value type
valuestring"20.00"Discount value
usage_limitinteger100Maximum usage limit
once_per_customerinteger1Limit one per customer
titlestring"Summer Sale"Coupon title
stockinteger50Remaining stock
target_selectionstring"entitled_products"What coupon applies to
codestring"SUMMER20"Coupon code
prerequisiteinteger1Whether has prerequisites
is_admin_showinteger1Visible in admin
progressstring"ongoing"Coupon progress status
allocation_limit_amountstring"100.00"Allocation limit amount
prerequisite_quantity_rangearray[object]-Quantity requirements (see below)
prerequisite_subtotal_rangearray[object]-Subtotal requirements (see below)
entitled_product_idsarray[string]["prod_123"]Eligible product IDs
entitled_variant_idsarray[string]["variant_456"]Eligible variant IDs
entitled_sortarray[string]["popularity"]Sort values
times_usedinteger25Number of times used
sortobject-Sorting config (see below)
use_with_otherinteger0Combinable with other coupons
prerequisite_customer_idsarray[string]["cust_789"]Eligible customer IDs
prerequisite_customer_segment_idsarray[string]["segment_123"]Customer segment IDs
configobject-Display config (see below)
allocation_methodstring"manual"Allocation method
allocation_limitinteger1Allocation limit
customer_selectionstring"all"Customer selection
entitled_collection_idsarray[string]["coll_123"]Eligible collection IDs
tipsobject-Display tips (see below)
entitled_extra_listarray[object]-Extra entitlements (see below)
discount_channel_listarray[object]-Channel restrictions (see below)
only_valid_first_order_customerbooleantrueFirst-order only
target_price_typestring"product_price"Target price type
remarksstring"Summer promotion"Remarks
coupon_typestring"promotion"Coupon type
channel_messagestring"Online only"Channel message
coupon_messagestring"Save 20%"Coupon message
send_target_selectionstring"specific_customers"Send target
effective_timestring"immediate"Effective time
use_coupon_starts_atstring"2025-06-01T00:00:00Z"Usage start time
use_coupon_ends_atstring"2025-06-30T23:59:59Z"Usage end time
prerequisite_quantity_range
ParameterTypeExampleDescription
greater_than_or_equal_tostring"2"Minimum quantity
valuestring"10.00"Discount value
value_percentagestring"10"Percentage value
value_event_typestring"discount"Event type
value_conditionstring"greater_than"Value condition
target_typestring"product"Target type
prerequisite_subtotal_range
ParameterTypeExampleDescription
greater_than_or_equal_tostring"100.00"Minimum subtotal
valuestring"20.00"Discount value
value_percentagestring"20"Percentage value
value_event_typestring"discount"Event type
value_conditionstring"greater_than"Value condition
target_typestring"cart"Target type
sort
ParameterTypeExampleDescription
bystring"created_at"Sort field
directionstring"desc"Sort direction
config
ParameterTypeExampleDescription
banner_urlstring"https://example.com/banner.jpg"Banner URL
banner_sizestring"large"Banner size
count_down. show_count_downbooleantrueShow countdown
count_down. formatstring"DD:HH:MM"Countdown format
count_down. background_color_startstring"#FF0000"Gradient start color
count_down. background_color_endstring"#00FF00"Gradient end color
count_down. colorstring"#FFFFFF"Text color
count_down. count_down_background_colorstring"#000000"Countdown bg color
count_down. count_down_colorstring"#FFFFFF"Countdown text color
count_down. detail_page_show_codebooleantrueShow code on detail page
count_down. landing_page_show_codeinteger1Show code on landing page
tips
ParameterTypeExampleDescription
msgstring"Limited time"Message text
countdownstring"3 days left"Countdown text
countdown_daystring"5"Countdown days
use_codestring"Use code SUMMER20"Code usage text
copy_codestring"Copy code"Copy code text

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!

Support

Shoplazza

Updates

Partner Program

Support

Shoplazza

Updates

Partner Program

Follow Us

© Shoplazza
Partner Program Agreement API Terms Terms of Service Privacy Policy Use Policy