Skip to main content
Version: 202201

Popup List

GET 

/openapi/2022-01/popups

Retrieves a list of popups available for a shop.

Request

Query Parameters

    page int32

    Page number

    Default value: 1
    limit int32

    Limit count per page

    Default value: 8

Responses

200

Schema
    pageinteger
    Default value: 0
    Example: 1
    limitinteger
    Default value: 0
    Example: 8
    totalstring
    Example: 1
    data object[]
  • Array [
  • abrogation_condition object
    trigger_numinteger
    Default value: 0
    Example: 0
    closedinteger
    Default value: 0
    Example: 0
    participatedinteger
    Default value: 0
    Example: 0
    activity_idstring
    Example: 47d2a827-e914-49e0-a14c-3161edb1ae9e
    activity_typestring
    Example: rebate
    app_typestring
    Example:
    cart_amount object
    limitinteger
    Default value: 0
    Example: 0
    min
    max
    cart_num object
    limitinteger
    Default value: 0
    Example: 0
    min
    max
    config object
    global object
    sections object
    globalstring[]
    overlay object
    typestring
    Example: overlay
    style object
    background-colorstring
    Example: rgba(0,0,0,0.6)
    modalSize object
    typestring
    Example: size
    style object
    widthstring
    Example: 480px
    setting object
    typestring
    Example: setting
    value object
    device-typestring
    Example: all
    prerequisiteTypestring
    Example: single
    basic_setting object
    sections object
    activitystring[]
    activityUrlstring[]
    selectActivity object
    typestring
    Example: select
    activity_namestring
    Example: tzt-满减活动-吸引客户购买更多
    prerequisite_array object[]
  • Array [
  • greater_than_or_equal_tostring
    Example: 123
    valuestring
    Example: 1
    value_event_typestring
    Example:
    value_conditionstring
    Example: less_than_or_equal_to
    target_typestring
    Example:
    target_dataarray
    target_data_variantarray
    target_data_collectionarray
  • ]
  • activityUrl object
    typestring
    Example: jumpUrl
    valuestring
    Example: /promotions/rebate/47d2a827-e914-49e0-a14c-3161edb1ae9e
    advanced_setting object
    sections object
    modalstring[]
    contentstring[]
    modal object
    typestring
    Example: gradient
    style object
    imagestring
    Example: none
    backgroundstring
    Example: linear-gradient(180deg, #ff704f, #ff274b, #ff274b) no-repeat scroll center center/cover
    background1string
    Example: #ff704f
    background2string
    Example: #ff274b
    backgroundImageTemplatestring
    Example: linear-gradient(180deg, $bg1, $bg2, $bg2)
    title object
    typestring
    Example: text
    valuestring
    Example: <span style="font-size: 26px; font-weight: 700; font-family: Lato, Lato-Black; color: #fefffe;" data-mce-style="font-size: 26px; font-weight: 700; font-family: Lato, Lato-Black; color: #fefffe;">SPECIAL OFFER</span>
    style object
    background-colorstring
    Example: #FF704F
    couponContent object
    typestring
    Example: text
    titleNamestring
    Example: popups.activity_text
    single object
    amount_percentage object
    valuestring
    Example: <div style="color:#ff2f4b;font-family: Lato, Lato-Regular;white-space: nowrap;" data-mce-style="color:#ff2f4b;font-family: Lato, Lato-Regular;white-space: nowrap;"> <div style="display: flex;justify-content: center;" data-mce-style="display: flex;justify-content: center;"> <span style="font-size: 88px; color: #ff2f4b;line-height: 1em;" data-mce-style="display: block;font-size: 88px; color: inherit;line-height: 1em;">{{rebate}}</span> <div style="margin-left: 12px;display: flex;flex-direction: column;justify-content: center;" data-mce-style="margin-left: 5px;display: flex;flex-direction: column;justify-content: center;"> <span style="font-size: 48px;display: block;line-height: 1em;" data-mce-style="display: block;font-size: 48px; color: #ff2f4b;line-height: 1em;">%</span> <span style="color:#b06410;font-size: 24px;line-height: 1em;" data-mce-style="color:#b06410;font-size: 24px;line-height: 1em;">OFF</span> </div> </div> <div style="margin-top: 10px;color: #AE6002;font-size: 24px;line-height: 1em;" data-mce-style="margin-top: 10px;color: #AE6002;font-size: 24px;line-height: 1em;">ON ORDER OF</div> <div style="margin-top: 10px;font-size: 32px; font-weight: bold; color: #ff2f4b;line-height: 1em; white-space: nowrap;" data-mce-style="margin-top: 10px;font-size: 32px; font-weight: bold; color: #ff2f4b;line-height: 1em; white-space: nowrap;">{{amount}}+</div> </div>
    style object
    background-colorstring
    Example: #FFFBF2
    item_fixed_amount object
    valuestring
    Example: <div style="color:#ff2f4b;font-family: Lato, Lato-Regular;white-space: nowrap;" data-mce-style="color:#ff2f4b;font-family: Lato, Lato-Regular;white-space: nowrap;"> <span class="popups___need_scale" style="line-height: 1em;display: block;font-size: 60px; color: #ff2f4b;font-weight: bold; white-space: nowrap;" data-mce-style="line-height: 1em;display: block;font-size: 60px; color: #ff2f4b;font-weight: bold; white-space: nowrap;">-{{rebate}}</span> <div class="popups___needless_scale" style="line-height: 1em;margin-top: 14px;font-size: 34px; color: #ff2f4b;font-weight: bold;" data-mce-style="line-height: 1em;margin-top: 14px;font-size: 34px; color: #ff2f4b;font-weight: bold;">{{amount}} <span style="color: #AE6002;font-weight: normal;" data-mce-style="color: #AE6002;font-weight: normal;">ITEMS+</span></div> <div class="popups___needless_scale" style="line-height: 1em;margin-top: 10px;color: #AE6002;font-size: 24px;opacity: 0.3;" data-mce-style="line-height: 1em;margin-top: 10px;color: #AE6002;font-size: 24px;opacity: 0.3;">FOR ORDER OVER</div> </div>
    style object
    background-colorstring
    Example: #FFFBF2
    fixed_amount object
    valuestring
    Example: <div style="text-align: center;font-family: Lato, Lato-Regular;white-space: nowrap;" data-mce-style="text-align: center;font-family: Lato, Lato-Regular;white-space: nowrap;"> <span class="popups___need_scale" style="display: block;font-size: 64px; font-weight: bold; color: #ff2f4b;line-height: 1em; white-space: nowrap;" data-mce-style="display: block;font-size: 64px; font-weight: bold; color: #ff2f4b;line-height: 1em; white-space: nowrap;">-{{rebate}}</span> <span class="popups___need_scale" style="display: block;font-size: 40px; color: #b06410;margin-top: 16px;line-height: 1em;" data-mce-style="display: block;font-size: 40px; color: #b06410;margin-top: 16px;line-height: 1em;">BUY {{amount}}</span> </div>
    style object
    background-colorstring
    Example: #FFFBF2
    percentage object
    across object
    valuestring
    Example: <div style="color:#ff2f4b;font-family: Lato, Lato-Regular;white-space: nowrap;" data-mce-style="color:#ff2f4b;font-family: Lato, Lato-Regular;white-space: nowrap;"> <div style="display: flex;justify-content: center;" data-mce-style="display: flex;justify-content: center;"> <span style="font-size: 88px; color: #ff2f4b;line-height: 1em;" data-mce-style="display: block;font-size: 88px; color: inherit;line-height: 1em;">{{rebate}}</span> <div style="margin-left: 12px;display: flex;flex-direction: column;justify-content: center;" data-mce-style="margin-left: 5px;display: flex;flex-direction: column;justify-content: center;"> <span style="font-size: 48px;display: block;line-height: 1em;" data-mce-style="display: block;font-size: 48px; color: #ff2f4b;line-height: 1em;">%</span> <span style="color:#b06410;font-size: 24px;line-height: 1em;" data-mce-style="color:#b06410;font-size: 24px;line-height: 1em;">OFF</span> </div> </div> <div style="margin-top: 10px;font-size: 36px; color: #ff2f4b;line-height: 1em;" data-mce-style="margin-top: 10px;font-size: 36px; color: #ff2f4b;line-height: 1em;"><span style="font-weight: bold;" data-mce-style="font-weight: bold;">{{amount}}</span> <span style="color: #AE6002;" data-mce-style="color: #AE6002;">ITEMS+</span></div> <div style="margin-top: 10px;color: #AE6002;font-size: 24px;opacity: 0.3;line-height: 1em;" data-mce-style="margin-top: 10px;color: #AE6002;font-size: 24px;opacity: 0.3;">FOR ORDER OVER</div> </div>
    each object
    valuestring
    Example: <div style="color:#ff2f4b;font-family: Lato, Lato-Regular;white-space: nowrap;" data-mce-style="color:#ff2f4b;font-family: Lato, Lato-Regular;white-space: nowrap;"> <div style="display: flex;justify-content: center;" data-mce-style="display: flex;justify-content: center;"> <span style="font-size: 88px; color: #ff2f4b;line-height: 1em;" data-mce-style="display: block;font-size: 88px; color: inherit;line-height: 1em;">{{rebate}}</span> <div style="margin-left: 12px;display: flex;flex-direction: column;justify-content: center;" data-mce-style="margin-left: 5px;display: flex;flex-direction: column;justify-content: center;"> <span style="font-size: 48px;display: block;line-height: 1em;" data-mce-style="display: block;font-size: 48px; color: #ff2f4b;line-height: 1em;">%</span> <span style="color:#ff2f4b;font-size: 24px;line-height: 1em;" data-mce-style="color:#ff2f4b;font-size: 24px;line-height: 1em;">OFF</span> </div> </div> <div style="margin-top: 10px;color: #AE6002;font-size: 20px;opacity: 0.3;line-height: 1em;" data-mce-style="margin-top: 10px;color: #AE6002;font-size: 20px;opacity: 0.3;">FOR THE</div> <div style="margin-top: 10px;font-size: 24px; color: #AE6002;line-height: 1em;" data-mce-style="margin-top: 10px;font-size: 24px; color: #AE6002;line-height: 1em;">{{amount}} <span style="color: #AE6002;" data-mce-style="color: #AE6002;">ITEM</span></div> </div>
    style object
    background-colorstring
    Example: #FFFBF2
    coupon object
    typestring
    Example: overlay
    titleNamestring
    Example: popups.coupons
    style object
    background-colorstring
    Example: #FFFBF2
    declaration object
    typestring
    Example: text
    titleNamestring
    Example: popups.activity_declaration
    valuestring
    Example: <span style="font-size: 14px; color: #ffffff;font-family: Lato, Lato-Regular;" data-mce-style="font-size: 14px; color: #ffffff;font-family: Lato, Lato-Regular;">*Discounts would automatically apply when placing an order</span>
    style object
    background-colorstring
    Example: #FF274B
    mainButton object
    typestring
    Example: button
    valuestring
    Example: <span style="color: #FF0022; font-size: 16px; font-weight: bold;font-family: Lato, Lato-Regular;" data-mce-style="color: #FF0022; font-size: 16px; font-weight: bold;font-family: Lato, Lato-Regular;">COLLECT ALL</span>
    style object
    background-colorstring
    Example: #fff3be
    border-colorstring
    Example: #fff3be
    closeButton object
    typestring
    Example: closeBtn
    modifierstring
    Example: show
    toolShowCloseBtnboolean
    Default value: true
    Example: false
    showCloseBtnboolean
    Default value: true
    Example: true
    style object
    colorstring
    Example: #ffffff
    resetarray
    conversion_ratestring
    Example: 100.00
    coupon_code
    create_typestring
    Example: manual
    discount_typestring
    Example: fixed_amount
    ends_atstring
    Example: -1
    exposurestring
    Example: 1
    frequency_numstring
    Example: 1
    frequency_typestring
    Example: 6
    idstring
    Example: 4b8395bb-09a0-4bb1-84c9-749375d9562b
    namestring
    Example: tzt-满减活动-吸引客户购买更多
    opportunitystring
    Example: 1
    order_amount object
    limitinteger
    Default value: 0
    Example: 0
    min
    max
    order_num object
    limitinteger
    Default value: 0
    Example: 0
    min
    max
    pages_typestring
    Example: 1
    progressstring
    Example: ongoing
    resource_idstring
    Example:
    starts_atstring
    Example: 1682652084
    statusstring
    Example: 1
    subscribestring
    Example: 1
    target_userstring
    Example: 1
    themestring
    Example: template_rebate_1
    typestring
    Example: popups
    user_loginstring
    Example: 0
    user_subscribestring
    Example: 0
    wait_secondsstring
    Example: 0
    activity_detail object
    idstring
    Example: 47d2a827-e914-49e0-a14c-3161edb1ae9e
    titlestring
    Example: tzt-满减活动-吸引客户购买更多
    price_rule_idstring
    Example: 1d5c3eba-ac32-49a5-8961-b5b705e61db1
    discount_typestring
    Example: fixed_amount
    starts_atstring
    Example: 1682652084
    ends_atstring
    Example: -1
    statusstring
    Example: 1
    popups_settingstring
    Example: close
    global_show_textstring
    Example: close
    popups_idstring
    Example:
    prerequisite_subtotal_range object[]
  • Array [
  • greater_than_or_equal_tostring
    Example: 123
    valuestring
    Example: 1
    value_event_typestring
    Example:
    value_conditionstring
    Example: less_than_or_equal_to
    target_typestring
    Example:
    target_dataarray
    target_data_variantarray
    target_data_collectionarray
  • ]
  • prerequisite_quantity_range
    prerequisite_customer_range
    prerequisite_threshold_subtotal_range
    prerequisite_threshold_quantity_range
    allocation_methodstring
    Example: across
  • ]