🔒 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 cursorstring No Pagination cursor for fetching next batch of results. Omit for first page. "g3QAAAAB"page_sizeint32 No Number of popups to return per request. Defaults to 8, maximum allowed is 50. 10
📘 Parameter Type Example Description codestring "success"Response status code messagestring Descriptive message of the response data.popupsarray of popup - List of popup activities data.popups[].abrogation_conditionobject - Dismissal conditions data.popups[].activity_idstring "act_123"Activity ID data.popups[].activity_typestring "coupon"Popup type data.popups[].app_typestring "mobile"Target platform data.popups[].cart_amountobject - Cart amount rules data.popups[].cart_numobject - Cart item count rules data.popups[].configobject - Popup configuration data.popups[].conversion_ratestring "15.2%"Conversion percentage data.popups[].coupon_codestring "SUMMER20"Coupon code data.popups[].create_typestring "manual"Creation method data.popups[].discount_typestring "percentage"Discount format data.popups[].ends_atstring "2025-12-31"End datetime data.popups[].exposurestring "all_users"Audience scope data.popups[].frequency_numstring "3"Display frequency data.popups[].frequency_typestring "per_session"Frequency scope data.popups[].idstring "pop_123"Popup ID data.popups[].namestring "Summer Sale"Popup name data.popups[].opportunitystring "checkout"Trigger point data.popups[].order_amountorder_amount - Order amount rules data.popups[].order_numorder_num object - Order count rules data.popups[].p_created_atstring "2025-06-01"Creation date data.popups[].p_updated_atstring "2025-06-15"Last update data.popups[].pa_updated_atstring "2025-06-10"Activity update data.popups[].pages_typestring "single"Page layout data.popups[].progressstring "50%"Completion rate data.popups[].resource_idstring "res_123"Resource ID data.popups[].starts_atstring "2025-06-01"Start datetime data.popups[].statusstring "active"Current status data.popups[].subscribestring "required"Subscription requirement data.popups[].target_userstring "new"User targeting data.popups[].themestring "summer"Visual theme data.popups[].typestring "modal"Display type data.popups[].user_loginstring "required"Login requirement data.popups[].user_subscribestring "optional"Subscription status data.popups[].wait_secondsstring "5"Delay before showing data.popups[].activity_detailactivity_detail object - Activity specifics data.cursorstring "next123"Pagination token data.has_moreboolean trueMore items available
Parameter Type Example Description abrogation_condition.trigger_numinteger 0The number of times the abrogation condition is triggered abrogation_condition.closedinteger 0The number of times the abrogation condition has been closed abrogation_condition.participatedinteger 0The number of participants in the abrogation condition abrogation_condition.auto_close_numinteger 0The number of times the abrogation condition is automatically closed
Parameter Type Example Description cart_amount.limitinteger 0The limit of cart amount cart_amount.mininteger 0The minimum cart amount cart_amount.maxinteger 0The maximum cart amount
Parameter Type Example Description cart_num.limitinteger 0The limit of cart number cart_num.mininteger 0The minimum cart number cart_num.maxinteger 0The maximum cart number
Parameter Type Example Description order_amount.limitinteger 0The limit of order amount order_amount.mininteger 0The minimum order amount order_amount.maxinteger 0The maximum order amount
Parameter Type Example Description activity_detail.idstring "string"The ID of the activity activity_detail.titlestring "string"The title of the activity activity_detail. price_rule_idstring "string"The price rule ID of the activity activity_detail. discount_typestring "string"The discount type of the activity activity_detail. starts_atstring "string"The start time of the activity activity_detail.ends_atstring "string"The end time of the activity activity_detail.statusstring "string"The status of the activity activity_detail. popups_settingstring "string"The popups setting of the activity activity_detail. global_show_textstring "string"The global show text of the activity activity_detail.popups_idstring "string"The popups ID of the activity activity_detail. discount_channel_listarray [{"channel_type": "string", "channel_status": 0, "location_ids": ["string"]}]The discount channel list of the activity activity_detail. prerequisite_subtotal_rangearray [{"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_rangearray [{"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_methodstring "string"The allocation method of the activity
Field Type Example Description codestring InvalidParameterError http message messagestring `` Error message
