get
https://{subdomain}.myshoplaza.com/openapi/2025-06/discount_flash_sales
Retrieves a list of flash sale discounts available for a shop.
Requiresprice_rulesaccess scope. More access scope
The Discount Flash sale List API retrieves a list of flash sale discounts available for a shop. This enables users to manage and view flash sale discount details effectively.
This API is especially useful for:
- Viewing available flash sale discounts in the store.
- Managing flash sale campaigns for customers.
- Fetching detailed flash sale discount information.
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
cursor | string | No | Cursor for pagination, use the cursor from the response to retrieve the next page | cursor_123456 |
page_size | int32 | No | A limit on the number of objects to be returned. Ranges from 1 to 250. Default is 10 | 20 |
need_detail_url | boolean | No | If true, returns detail URLs in the response | true |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | 200 | Error code (200 indicates success) |
message | string | Success | Error message |
data | object | {...} | Contains the price rules data |
data.flash_sales | array of objects | [ {...}, {...} ] | List of flash sale objects |
data.cursor | string | cursor_123456 | Cursor for pagination |
data.has_more | boolean | true | Indicates if there are more results available |
Flash Sale Object Structure
| Parameter | Type | Example | Description |
|---|---|---|---|
id | string | fs_123456 | Unique identifier of the flash sale |
title | string | Summer Flash Sale | Name of the flash sale |
discount_type | string | percentage | Type of discount (percentage, fixed_amount) |
once_per_customer | int32 | 1 | Whether the sale is limited to once per customer (1=yes, 0=no) |
starts_at | string | 2023-06-01T00:00:00Z | Start date and time of the flash sale (ISO 8601 format) |
ends_at | string | 2023-06-30T23:59:59Z | End date and time of the flash sale (ISO 8601 format) |
status | int32 | 1 | Current status of the flash sale (1=active, 0=inactive, 2=upcoming) |
sort | string | priority | Sorting priority of the flash sale |
allocation_method | string | each | How discounts are allocated (each, across) |
allow_oversold | string | false | Whether overselling is allowed (true/false) |
progress | string | 50% | Current participation progress |
product_num | int32 | 42 | Number of products included in the flash sale |
detail_url | string | https://example.com/flash-sale/123 | Detailed URL for the flash sale (only returned if need_detail_url=true) |
apply_type | string | all_products | Type of product application (all_products, selected_products) |
create_source | string | merchant | Source of creation (merchant, system, api) |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |