🔒
Requires write_shop_navigation access scope. More access scope

The Get Sales Pop Config Retrieve the configuration details of the Sales notification feature for a specific store..

This API is especially useful for:

Viewing the current sales pop notification settings for a store.
Checking the template configuration and display rules.
Understanding the timing and frequency settings for sales popups.
Reviewing the pages where sales popups are configured to appear.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Parameter	Type	Example	Description
`code`	string	`"200"`	The status code of the response
`message`	string	`"success"`	The message describing the response status
`data.sales_pop.id`	string	`"pop_12345"`	The unique identifier of the sales pop configuration
`data.sales_pop.store_id`	string	`"store_67890"`	The ID of the store this configuration belongs to
`data.sales_pop. template_config. anonymity_switch`	boolean	`true`	Whether anonymity is enabled for the sales pop
`data.sales_pop. template_config.title`	string	`"Special Offer!"`	The title text of the sales pop
`data.sales_pop. template_config. template`	string	`"template_1"`	The template used for the sales pop
`data.sales_pop. template_config. replace_switch`	boolean	`true`	Whether text replacement is enabled
`data.sales_pop. template_config. default_time`	string	`"5s"`	The default display time for the sales pop
`data.sales_pop. template_config. time_text`	string	`"Just now"`	The text displayed for the time indicator
`data.sales_pop. template_config. anonymity_name`	array of string	`["Anonymous", "Guest"]`	List of anonymity names to display
`data.sales_pop. template_config. anonymity_address`	array of string	`["Unknown", "Hidden"]`	List of anonymity addresses to display
`data.sales_pop. template_config. background_color`	string	`"#FFFFFF"`	The background color of the sales pop
`data.sales_pop. template_config. title_color`	string	`"#000000"`	The color of the title text
`data.sales_pop. template_config. product_color`	string	`"#333333"`	The color of product text
`data.sales_pop. template_config. time_color`	string	`"#666666"`	The color of time text
`data.sales_pop. template_config. icon_color`	string	`"#FF0000"`	The color of the icon
`data.sales_pop. template_config. m_background_color`	string	`"#EEEEEE"`	The mobile background color
`data.sales_pop. first_delay`	string	`"1s"`	The delay before first display
`data.sales_pop. duration`	string	`"30s"`	The total duration the sales pop will be active
`data.sales_pop. interval`	string	`"5s"`	The interval between popups
`data.sales_pop. times_switch`	string	`"unlimited"`	The switch for popup times (limited/unlimited)
`data.sales_pop. max_times`	string	`"5"`	The maximum number of times the popup will show
`data.sales_pop. loop_switch`	string	`"on"`	Whether to loop the popup display
`data.sales_pop. locate`	string	`"bottom_right"`	The location where the popup appears
`data.sales_pop.pages`	string	`"all"`	The pages where the popup appears (all/specific)
`data.sales_pop.specify_pages`	array of object	`[{"match_string": "product", "match_condition": "contains"}]`	Specific pages where the popup appears
`data.sales_pop.order_status`	string	`"all"`	The order statuses that trigger the popup
`data.sales_pop.time`	string	`"10:00"`	The time when the popup appears
`data.sales_pop.time_unit`	string	`"hour"`	The time unit for popup scheduling
`data.sales_pop.status`	string	`"active"`	The current status of the configuration
`data.sales_pop.created_at`	string	`"2025-06-01T12:00:00Z"`	The creation timestamp
`data.sales_pop.updated_at`	string	`"2025-06-02T14:30:00Z"`	The last update timestamp
`data.sales_pop.pages_list`	array of object	`[{"id": 1, "name": "Home", "script": "script_1"}]`	List of pages where the popup is configured

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message