get https://{subdomain}.myshoplaza.com/openapi/2022-01/popups
Requires
price_rulesaccess scope. More access scope
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.
Request Parameters
Public Request Parameters
Query Parameters
| Name | Type | Description | Required/Optional | Example |
|---|---|---|---|---|
page | int32 | Page number | Optional | 1 |
limit | int32 | Limit count per page | Optional | 8 |
Response Explanation
Public Response Parameters
Success Response
| Name | Type | Description | Example |
|---|---|---|---|
page | int32 | The current page number | 1 |
limit | int32 | The number of items per page | 8 |
total | int32 | Total number of popups available | 1 |
data | array | Array of popup details | - |
data[].id | string | Unique ID of the popup | 4b8395bb-09a0-4bb1-84c9-749375d9562b |
data[].name | string | Name of the popup | tzt |
data[].theme | string | Theme associated with the popup | template_rebate_1 |
data[].progress | string | Progress status of the popup | ongoing |
data[].type | string | Type of the popup | popups |
data[].activity_id | string | Activity ID associated with the popup | 47d2a827-e914-49e0-a14c-3161edb1ae9e |
data[].status | string | Status of the popup | 1 |
data[].activity_detail.id | string | Activity detail ID | 47d2a827-e914-49e0-a14c-3161edb1ae9e |
data[].activity_detail.title | string | Title of the activity associated with the popup | tzt |
data[].activity_detail.price_rule_id | string | Price rule ID | 1d5c3eba-ac32-49a5-8961-b5b705e61db1 |
data[].activity_detail.discount_type | string | Type of discount applied | fixed_amount |
data[].activity_detail.starts_at | timestamp | Start time of the activity | 1682652084 |
data[].activity_detail.ends_at | timestamp | End time of the activity | -1 |
data[].activity_detail.status | string | Status of the activity | 1 |
data[].activity_detail.allocation_method | string | Allocation method of the discount | across |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "invalid line_item id"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized |