List popups

GET 
/openapi/2025-06/popups

Retrieves a list of popups available for a shop.

Request

Query Parameters

cursor string

Cursor for pagination

page_size int32

Page size for the number of popup to retrieve. Default to 8

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

popups object[]

List of popups

Array [

abrogation_condition object

Abrogation condition

trigger_numint32

Trigger number

closedint32

Whether closed

participatedint32

Whether participated

auto_close_numint32

Auto close number

activity_idstring

Activity ID

activity_typestring

Activity type

app_typestring

App type

cart_amount object

Cart amount

limitint32

Limit

minfloat

Minimum value

maxfloat

Maximum value

cart_num object

Number of cart items

limitint32

Limit

minint32

Minimum value

maxint32

Maximum value

config object

Configuration

global object

Global

sections object

List of sections

modalstring[]

Modal

contentstring[]

Content

activitystring[]

Activity

activity_urlstring[]

Activity URL

globalstring[]

Global

overlay object

Overlay

typestring

Type

style object

Style

background_colorstring

Background color

setting object

Setting

typestring

Type

value object

The value

device_typestring

Device type

positionstring

Position or sort order

fixedstring

Fixed

prerequisite_typestring

Type of prerequisite

modal_size object

Modal size

typestring

Type

style object

Style

widthstring

Width dimension

link object

Link

typestring

Type

valuestring

The value

basic_setting object

Basic settings

sections object

List of sections

modalstring[]

Modal

contentstring[]

Content

activitystring[]

Activity

activity_urlstring[]

Activity URL

globalstring[]

Global

select_activity object

Select activity

typestring

Type

activity_namestring

Activity name

prerequisite_array object[]

Array of prerequisite conditions

Array [

greater_than_or_equal_tostring

Greater than or equal to value

valuestring

The value

value_percentagestring

Percentage value

value_event_typestring

Value event type

value_conditionstring

Value condition

target_typestring

Target type

target_datastring[]

Target data

]

activity_url object

Activity URL

typestring

Type

valuestring

The value

advanced_setting object

Advanced settings

sections object

List of sections

modalstring[]

Modal

contentstring[]

Content

activitystring[]

Activity

activity_urlstring[]

Activity URL

globalstring[]

Global

modal object

Modal

typestring

Type

style object

Style

imagestring

Image

backgroundstring

Background

background1string

Background (primary)

background2string

Background (secondary)

background_image_templatestring

Background image template

widthint32

Width dimension

title object

Title

typestring

Type

valuestring

The value

style object

Style

background_colorstring

Background color

coupon_content object

Coupon content

typestring

Type

title_namestring

Title name

single object

Whether single

amount_percentage object

Amount percentage

valuestring

The value

style object

Style

background_colorstring

Background color

item_fixed_amount object

Item fixed discount amount

valuestring

The value

style object

Style

background_colorstring

Background color

fixed_amount object

Fixed amount

valuestring

The value

style object

Style

background_colorstring

Background color

percentage object

Percentage

across object

Across

valuestring

The value

each object

Each

valuestring

The value

style object

Style

background_colorstring

Background color

coupon object

Coupon

typestring

Type

style object

Style

colorstring

Color

background_colorstring

Background color

title_namestring

Title name

declaration object

Declaration

typestring

Type

title_namestring

Title name

valuestring

The value

style object

Style

background_colorstring

Background color

main_button object

Main button

typestring

Type

valuestring

The value

style object

Style

background_colorstring

Background color

border_colorstring

Border color

close_button object

Close button

typestring

Type

modifierstring

Modifier

tool_show_close_btnboolean

Whether to show tool close button

show_close_btnboolean

Whether to show close button

style object

Style

colorstring

Color

first_page object

First page

sections object

List of sections

modalstring[]

Modal

contentstring[]

Content

activitystring[]

Activity

activity_urlstring[]

Activity URL

globalstring[]

Global

modal object

Modal

typestring

Type

style object

Style

imagestring

Image

backgroundstring

Background

background1string

Background (primary)

background2string

Background (secondary)

background_image_templatestring

Background image template

widthint32

Width dimension

title object

Title

typestring

Type

valuestring

The value

style object

Style

background_colorstring

Background color

description object

Description

typestring

Type

valuestring

The value

input object

Input

typestring

Type

style object

Style

background_colorstring

Background color

border_colorstring

Border color

colorstring

Color

button1 object

Button 1

typestring

Type

modifierstring

Modifier

url object

URL

typestring

Type

valuestring

The value

valuestring

The value

style object

Style

background_colorstring

Background color

border_colorstring

Border color

url_strstring

URL string

button2 object

Button 2

typestring

Type

modifierstring

Modifier

url object

URL

typestring

Type

valuestring

The value

valuestring

The value

style object

Style

background_colorstring

Background color

border_colorstring

Border color

url_strstring

URL string

rebate object

Rebate

typestring

Type

rebate_idstring

Rebate ID

rebate_namestring

Rebate name

rebate_not_match_textstring

Rebate not-match text

rebate_match_textstring

Rebate match text

shipping object

Shipping information

typestring

Type

shipping_idstring

Shipping ID

shipping_namestring

Shipping method name

shipping_not_match_textstring

Shipping not-match text

shipping_match_textstring

Shipping match text

second_page object

Second page

sections object

List of sections

modalstring[]

Modal

contentstring[]

Content

activitystring[]

Activity

activity_urlstring[]

Activity URL

globalstring[]

Global

modal object

Modal

typestring

Type

style object

Style

imagestring

Image

backgroundstring

Background

background1string

Background (primary)

background2string

Background (secondary)

background_image_templatestring

Background image template

widthint32

Width dimension

title object

Title

typestring

Type

valuestring

The value

style object

Style

background_colorstring

Background color

description object

Description

typestring

Type

valuestring

The value

coupon object

Coupon

typestring

Type

style object

Style

colorstring

Color

background_colorstring

Background color

title_namestring

Title name

button1 object

Button 1

typestring

Type

modifierstring

Modifier

url object

URL

typestring

Type

valuestring

The value

valuestring

The value

style object

Style

background_colorstring

Background color

border_colorstring

Border color

url_strstring

URL string

conversion_ratestring

Conversion rate

coupon_codestring

Coupon code

create_typestring

Creation type

discount_typestring

Discount type

ends_atstring

End timestamp

exposurestring

Exposure count

frequency_numstring

Frequency number

frequency_typestring

Frequency type

idstring

Popup ID

namestring

Name

opportunitystring

Opportunity

order_amount object

Order amount

limitint32

Limit

minfloat

Minimum value

maxfloat

Maximum value

order_num object

Number of orders

limitint32

Limit

minint32

Minimum value

maxint32

Maximum value

p_created_atstring

Product creation timestamp

p_updated_atstring

Product update timestamp

pa_updated_atstring

Product-attribute update timestamp

pages_typestring

Type of page

progressstring

Progress

resource_idstring

Resource ID

starts_atstring

Start timestamp

statusstring

Status

subscribestring

Subscribe

target_userstring

Target user

themestring

Theme

typestring

Type

user_loginstring

User login

user_subscribestring

User subscribe

wait_secondsstring

Wait seconds

activity_detail object

Activity detail

idstring

Activity detail ID

titlestring

Title

price_rule_idstring

Price rule ID

discount_typestring

Discount type

starts_atstring

Start timestamp

ends_atstring

End timestamp

statusstring

Status

popups_settingstring

Popup settings

global_show_textstring

Global show text

popups_idstring

Popup ID

discount_channel_list object[]

List of discount channels

Array [

channel_typestring

Type of channel

channel_statusint32

Status of channel

location_idsstring[]

List of location IDs

]

prerequisite_subtotal_range object[]

Subtotal prerequisite range

Array [

greater_than_or_equal_tostring

Greater than or equal to value

valuestring

The value

value_percentagestring

Percentage value

value_event_typestring

Value event type

value_conditionstring

Value condition

target_typestring

Target type

target_datastring[]

Target data

]

prerequisite_quantity_range object[]

Quantity prerequisite range

Array [

greater_than_or_equal_tostring

Greater than or equal to value

valuestring

The value

value_percentagestring

Percentage value

value_event_typestring

Value event type

value_conditionstring

Value condition

target_typestring

Target type

target_datastring[]

Target data

]

allocation_methodstring

Allocation method

]

cursorstring

The cursor for the next page of results

has_moreboolean

Whether there are more results

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "popups": [
      {
        "abrogation_condition": {
          "trigger_num": 0,
          "closed": 0,
          "participated": 0,
          "auto_close_num": 0
        },
        "activity_id": "string",
        "activity_type": "string",
        "app_type": "string",
        "cart_amount": {
          "limit": 0,
          "min": 0,
          "max": 0
        },
        "cart_num": {
          "limit": 0,
          "min": 0,
          "max": 0
        },
        "config": {
          "global": {
            "sections": {
              "modal": [
                "string"
              ],
              "content": [
                "string"
              ],
              "activity": [
                "string"
              ],
              "activity_url": [
                "string"
              ],
              "global": [
                "string"
              ]
            },
            "overlay": {
              "type": "string",
              "style": {
                "background_color": "string"
              }
            },
            "setting": {
              "type": "string",
              "value": {
                "device_type": "string",
                "position": "string",
                "fixed": "string",
                "prerequisite_type": "string"
              }
            },
            "modal_size": {
              "type": "string",
              "style": {
                "width": "string"
              }
            },
            "link": {
              "type": "string",
              "value": "string"
            }
          },
          "basic_setting": {
            "sections": {
              "modal": [
                "string"
              ],
              "content": [
                "string"
              ],
              "activity": [
                "string"
              ],
              "activity_url": [
                "string"
              ],
              "global": [
                "string"
              ]
            },
            "select_activity": {
              "type": "string",
              "activity_name": "string",
              "prerequisite_array": [
                {
                  "greater_than_or_equal_to": "string",
                  "value": "string",
                  "value_percentage": "string",
                  "value_event_type": "string",
                  "value_condition": "string",
                  "target_type": "string",
                  "target_data": [
                    "string"
                  ]
                }
              ]
            },
            "activity_url": {
              "type": "string",
              "value": "string"
            }
          },
          "advanced_setting": {
            "sections": {
              "modal": [
                "string"
              ],
              "content": [
                "string"
              ],
              "activity": [
                "string"
              ],
              "activity_url": [
                "string"
              ],
              "global": [
                "string"
              ]
            },
            "modal": {
              "type": "string",
              "style": {
                "image": "string",
                "background": "string",
                "background1": "string",
                "background2": "string",
                "background_image_template": "string",
                "width": 0
              }
            },
            "title": {
              "type": "string",
              "value": "string",
              "style": {
                "background_color": "string"
              }
            },
            "coupon_content": {
              "type": "string",
              "title_name": "string",
              "single": {
                "amount_percentage": {
                  "value": "string",
                  "style": {
                    "background_color": "string"
                  }
                },
                "item_fixed_amount": {
                  "value": "string",
                  "style": {
                    "background_color": "string"
                  }
                },
                "fixed_amount": {
                  "value": "string",
                  "style": {
                    "background_color": "string"
                  }
                },
                "percentage": {
                  "across": {
                    "value": "string"
                  },
                  "each": {
                    "value": "string"
                  },
                  "style": {
                    "background_color": "string"
                  }
                }
              }
            },
            "coupon": {
              "type": "string",
              "style": {
                "color": "string",
                "background_color": "string"
              },
              "title_name": "string"
            },
            "declaration": {
              "type": "string",
              "title_name": "string",
              "value": "string",
              "style": {
                "background_color": "string"
              }
            },
            "main_button": {
              "type": "string",
              "value": "string",
              "style": {
                "background_color": "string",
                "border_color": "string"
              }
            },
            "close_button": {
              "type": "string",
              "modifier": "string",
              "tool_show_close_btn": true,
              "show_close_btn": true,
              "style": {
                "color": "string"
              }
            }
          },
          "first_page": {
            "sections": {
              "modal": [
                "string"
              ],
              "content": [
                "string"
              ],
              "activity": [
                "string"
              ],
              "activity_url": [
                "string"
              ],
              "global": [
                "string"
              ]
            },
            "modal": {
              "type": "string",
              "style": {
                "image": "string",
                "background": "string",
                "background1": "string",
                "background2": "string",
                "background_image_template": "string",
                "width": 0
              }
            },
            "title": {
              "type": "string",
              "value": "string",
              "style": {
                "background_color": "string"
              }
            },
            "description": {
              "type": "string",
              "value": "string"
            },
            "input": {
              "type": "string",
              "style": {
                "background_color": "string",
                "border_color": "string",
                "color": "string"
              }
            },
            "button1": {
              "type": "string",
              "modifier": "string",
              "url": {
                "type": "string",
                "value": "string"
              },
              "value": "string",
              "style": {
                "background_color": "string",
                "border_color": "string"
              },
              "url_str": "string"
            },
            "button2": {
              "type": "string",
              "modifier": "string",
              "url": {
                "type": "string",
                "value": "string"
              },
              "value": "string",
              "style": {
                "background_color": "string",
                "border_color": "string"
              },
              "url_str": "string"
            },
            "rebate": {
              "type": "string",
              "rebate_id": "string",
              "rebate_name": "string",
              "rebate_not_match_text": "string",
              "rebate_match_text": "string"
            },
            "shipping": {
              "type": "string",
              "shipping_id": "string",
              "shipping_name": "string",
              "shipping_not_match_text": "string",
              "shipping_match_text": "string"
            }
          },
          "second_page": {
            "sections": {
              "modal": [
                "string"
              ],
              "content": [
                "string"
              ],
              "activity": [
                "string"
              ],
              "activity_url": [
                "string"
              ],
              "global": [
                "string"
              ]
            },
            "modal": {
              "type": "string",
              "style": {
                "image": "string",
                "background": "string",
                "background1": "string",
                "background2": "string",
                "background_image_template": "string",
                "width": 0
              }
            },
            "title": {
              "type": "string",
              "value": "string",
              "style": {
                "background_color": "string"
              }
            },
            "description": {
              "type": "string",
              "value": "string"
            },
            "coupon": {
              "type": "string",
              "style": {
                "color": "string",
                "background_color": "string"
              },
              "title_name": "string"
            },
            "button1": {
              "type": "string",
              "modifier": "string",
              "url": {
                "type": "string",
                "value": "string"
              },
              "value": "string",
              "style": {
                "background_color": "string",
                "border_color": "string"
              },
              "url_str": "string"
            }
          }
        },
        "conversion_rate": "string",
        "coupon_code": "string",
        "create_type": "string",
        "discount_type": "string",
        "ends_at": "string",
        "exposure": "string",
        "frequency_num": "string",
        "frequency_type": "string",
        "id": "string",
        "name": "string",
        "opportunity": "string",
        "order_amount": {
          "limit": 0,
          "min": 0,
          "max": 0
        },
        "order_num": {
          "limit": 0,
          "min": 0,
          "max": 0
        },
        "p_created_at": "string",
        "p_updated_at": "string",
        "pa_updated_at": "string",
        "pages_type": "string",
        "progress": "string",
        "resource_id": "string",
        "starts_at": "string",
        "status": "string",
        "subscribe": "string",
        "target_user": "string",
        "theme": "string",
        "type": "string",
        "user_login": "string",
        "user_subscribe": "string",
        "wait_seconds": "string",
        "activity_detail": {
          "id": "string",
          "title": "string",
          "price_rule_id": "string",
          "discount_type": "string",
          "starts_at": "string",
          "ends_at": "string",
          "status": "string",
          "popups_setting": "string",
          "global_show_text": "string",
          "popups_id": "string",
          "discount_channel_list": [
            {
              "channel_type": "string",
              "channel_status": 0,
              "location_ids": [
                "string"
              ]
            }
          ],
          "prerequisite_subtotal_range": [
            {
              "greater_than_or_equal_to": "string",
              "value": "string",
              "value_percentage": "string",
              "value_event_type": "string",
              "value_condition": "string",
              "target_type": "string",
              "target_data": [
                "string"
              ]
            }
          ],
          "prerequisite_quantity_range": [
            {
              "greater_than_or_equal_to": "string",
              "value": "string",
              "value_percentage": "string",
              "value_event_type": "string",
              "value_condition": "string",
              "target_type": "string",
              "target_data": [
                "string"
              ]
            }
          ],
          "allocation_method": "string"
        }
      }
    ],
    "cursor": "string",
    "has_more": true
  }
}