Skip to main content
Version: 202201

Coupon List

GET 
/openapi/2022-01/coupons

Retrieves a paginated list of coupons available in the system.

Request​

Query Parameters

    page int32

    Page number

    limit int32

    Limit count per page

    progress string

    Progress of coupons, available: not_started, ongoing, finished

    type string

    Type of coupons, available: fixed_amount, percentage

    keywords string

    Search coupons' title

Responses​

200

Schema
    pageinteger
    Default value: 0
    Example: 0
    limitinteger
    Default value: 0
    Example: 10
    totalinteger
    Default value: 0
    Example: 2
    data object[]
  • Array [
    • idstring
    Example: 202314454241654711
    store_idinteger
    Default value: 0
    Example: 11218
    life_cycle_typestring
    Example: begin_end
    survival_timeinteger
    Default value: 0
    Example: 86400
    starts_atinteger
    Default value: 0
    Example: 1673246985
    ends_atinteger
    Default value: 0
    Example: -1
    statusinteger
    Default value: 0
    Example: 0
    discount_typestring
    Example: percentage
    value_typestring
    Example: percentage
    valuestring
    Example: 10
    usage_limitinteger
    Default value: 0
    Example: -1
    once_per_customerinteger
    Default value: 0
    Example: 0
    titlestring
    Example: coupon1
    stockinteger
    Default value: 0
    Example: 0
    codestring
    Example:
    prerequisiteinteger
    Default value: 0
    Example: 0
    is_admin_showinteger
    Default value: 0
    Example: 0
    target_selectionstring
    Example: all
    progressstring
    Example: ongoing
    using_statestring
    Example:
    allocation_limit_amountstring
    Example: 0
    entitled_area_listarray
    prerequisite_quantity_range object[]
  • Array [
    • greater_than_or_equal_tostring
    Example:
    valuestring
    Example:
    value_conditionstring
    Example:
    target_typestring
    Example:
    target_data
    target_data_variant
    target_data_collection
  • ]
    • prerequisite_subtotal_range object[]
  • Array [
    • greater_than_or_equal_tostring
    Example:
    valuestring
    Example:
    value_conditionstring
    Example:
    target_typestring
    Example:
    target_data
    target_data_variant
    target_data_collection
  • ]
    • entitled_product_idsarray
    entitled_variant_idsarray
    entitled_sortarray
    times_usedinteger
    Default value: 0
    Example: 1
    sort object
    bystring
    Example: sales
    directionstring
    Example: desc
    use_with_otherinteger
    Default value: 0
    Example: 0
    prerequisite_customer_idsarray
    prerequisite_customer_segment_idsarray
    config object
    banner_urlstring
    Example:
    banner_sizestring
    Example:
    count_down object
    show_count_downboolean
    Default value: true
    Example: false
    formatstring
    Example:
    background_color_startstring
    Example:
    background_color_endstring
    Example:
    colorstring
    Example:
    count_down_background_colorstring
    Example:
    count_down_colorstring
    Example:
    detail_page_show_codeboolean
    Default value: true
    Example: false
    allocation_methodstring
    Example:
    allocation_limitinteger
    Default value: 0
    Example: 0
    customer_selectionstring
    Example:
    entitled_collection_idsarray
    tips object
    msgstring
    Example:
    countdownstring
    Example:
    countdown_daystring
    Example:
    use_codestring
    Example:
    copy_codestring
    Example:
    entitled_extra_list
    prerequisite_customer_range
    buysPrerequisiteValueinteger
    Default value: 0
    Example: 0
    getsMaxOrderUseValueinteger
    Default value: 0
    Example: 0
    getsDiscountValueinteger
    Default value: 0
    Example: 0
    only_valid_first_order_customerboolean
    Default value: true
    Example: false
  • ]