🔒
Popups are larger, more prominent notification windows used for advertising promotions.
The Popup List API retrieves a list of popups available for a shop. This enables users to manage and view the popup list for targeted marketing campaigns.
This API is especially useful for:
- Viewing popups configured in the shop.
- Managing active and scheduled popup campaigns.
- Reviewing popup details such as conditions, settings, and themes.
📘
| Parameter | Type | Required | Description | Example |
|---|
cursor | string | No | Pagination cursor for fetching next batch of results. Omit for first page. | "g3QAAAAB" |
page_size | int32 | No | Number of popups to return per request. Defaults to 8, maximum allowed is 50. | 10 |
📘
| Parameter | Type | Example | Description |
|---|
code | string | "success" | Response status code |
message | string | | Descriptive message of the response |
data.popups | array of popup | - | List of popup activities |
data.popups[].abrogation_condition | object | - | Dismissal conditions |
data.popups[].activity_id | string | "act_123" | Activity ID |
data.popups[].activity_type | string | "coupon" | Popup type |
data.popups[].app_type | string | "mobile" | Target platform |
data.popups[].cart_amount | object | - | Cart amount rules |
data.popups[].cart_num | object | - | Cart item count rules |
data.popups[].config | object | - | Popup configuration |
data.popups[].conversion_rate | string | "15.2%" | Conversion percentage |
data.popups[].coupon_code | string | "SUMMER20" | Coupon code |
data.popups[].create_type | string | "manual" | Creation method |
data.popups[].discount_type | string | "percentage" | Discount format |
data.popups[].ends_at | string | "2025-12-31" | End datetime |
data.popups[].exposure | string | "all_users" | Audience scope |
data.popups[].frequency_num | string | "3" | Display frequency |
data.popups[].frequency_type | string | "per_session" | Frequency scope |
data.popups[].id | string | "pop_123" | Popup ID |
data.popups[].name | string | "Summer Sale" | Popup name |
data.popups[].opportunity | string | "checkout" | Trigger point |
data.popups[].order_amount | order_amount | - | Order amount rules |
data.popups[].order_num | order_num object | - | Order count rules |
data.popups[].p_created_at | string | "2025-06-01" | Creation date |
data.popups[].p_updated_at | string | "2025-06-15" | Last update |
data.popups[].pa_updated_at | string | "2025-06-10" | Activity update |
data.popups[].pages_type | string | "single" | Page layout |
data.popups[].progress | string | "50%" | Completion rate |
data.popups[].resource_id | string | "res_123" | Resource ID |
data.popups[].starts_at | string | "2025-06-01" | Start datetime |
data.popups[].status | string | "active" | Current status |
data.popups[].subscribe | string | "required" | Subscription requirement |
data.popups[].target_user | string | "new" | User targeting |
data.popups[].theme | string | "summer" | Visual theme |
data.popups[].type | string | "modal" | Display type |
data.popups[].user_login | string | "required" | Login requirement |
data.popups[].user_subscribe | string | "optional" | Subscription status |
data.popups[].wait_seconds | string | "5" | Delay before showing |
data.popups[].activity_detail | activity_detail object | - | Activity specifics |
data.cursor | string | "next123" | Pagination token |
data.has_more | boolean | true | More items available |
| Parameter | Type | Example | Description |
|---|
abrogation_condition.trigger_num | integer | 0 | The number of times the abrogation condition is triggered |
abrogation_condition.closed | integer | 0 | The number of times the abrogation condition has been closed |
abrogation_condition.participated | integer | 0 | The number of participants in the abrogation condition |
abrogation_condition.auto_close_num | integer | 0 | The number of times the abrogation condition is automatically closed |
| Parameter | Type | Example | Description |
|---|
cart_amount.limit | integer | 0 | The limit of cart amount |
cart_amount.min | integer | 0 | The minimum cart amount |
cart_amount.max | integer | 0 | The maximum cart amount |
| Parameter | Type | Example | Description |
|---|
cart_num.limit | integer | 0 | The limit of cart number |
cart_num.min | integer | 0 | The minimum cart number |
cart_num.max | integer | 0 | The maximum cart number |
| Parameter | Type | Example | Description |
|---|
order_amount.limit | integer | 0 | The limit of order amount |
order_amount.min | integer | 0 | The minimum order amount |
order_amount.max | integer | 0 | The maximum order amount |
| Parameter | Type | Example | Description |
|---|
activity_detail.id | string | "string" | The ID of the activity |
activity_detail.title | string | "string" | The title of the activity |
activity_detail. price_rule_id | string | "string" | The price rule ID of the activity |
activity_detail. discount_type | string | "string" | The discount type of the activity |
activity_detail. starts_at | string | "string" | The start time of the activity |
activity_detail.ends_at | string | "string" | The end time of the activity |
activity_detail.status | string | "string" | The status of the activity |
activity_detail. popups_setting | string | "string" | The popups setting of the activity |
activity_detail. global_show_text | string | "string" | The global show text of the activity |
activity_detail.popups_id | string | "string" | The popups ID of the activity |
activity_detail. discount_channel_list | array | [{"channel_type": "string", "channel_status": 0, "location_ids": ["string"]}] | The discount channel list of the activity |
activity_detail. prerequisite_subtotal_range | array | [{"greater_than_or_equal_to": "string", "value": "string", "value_percentage": "string", "value_event_type": "string", "value_condition": "string", "target_type": "string"}] | The prerequisite subtotal range of the activity |
activity_detail. prerequisite_quantity_range | array | [{"greater_than_or_equal_to": "string", "value": "string", "value_percentage": "string", "value_event_type": "string", "value_condition": "string", "target_type": "string"}] | The prerequisite quantity range of the activity |
activity_detail. allocation_method | string | "string" | The allocation method of the activity |
| Field | Type | Example | Description |
|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |
