Skip to main content
Version: 202201

Discount Code List

GET 
/openapi/2022-01/discount_codes

Retrieves a list of discount code.

Request​

Query Parameters

    limit int32

    Limit per page

    page int32

    Page number

    need_detail_url boolean

    details url return in responses

Responses​

200

Schema
    pageinteger
    Default value: 0
    Example: 1
    limitinteger
    Default value: 0
    Example: 20
    totalstring
    Example: 1
    data object[]
  • Array [
    • allocation_limitstring
    Example: 1
    allocation_limit_amountstring
    Example: 0.0000
    allocation_methodstring
    Example:
    app_idstring
    Example:
    codestring
    Example: 123234
    customer_selectionstring
    Example: all
    detail_urlstring
    Example: tzt.myshoplaza.com/promotions/coupon/1783371b-76c1-41ab-a09c-531ff54425fc
    discount_typestring
    Example: percentage
    ends_atstring
    Example: -1
    entitled_filter_idsarray
    entitled_filter_listarray
    entitled_product_idsarray
    idstring
    Example: 1783371b-76c1-41ab-a09c-531ff54425fc
    is_admin_showstring
    Example: 1
    once_per_customerstring
    Example: 1
    prerequisitestring
    Example: 0
    prerequisite_customer_idsarray
    prerequisite_customer_segment_idsarray
    product_num
    progressstring
    Example: ongoing
    sortstring
    Example: {"by":"title","direction":"asc"}
    starts_atstring
    Example: 1682652119
    statusstring
    Example: 1
    target_price_typestring
    Example: combined_price
    target_selectionstring
    Example: all
    target_typestring
    Example: line_item
    times_usedstring
    Example: 0
    titlestring
    Example: tzt-优惠码-促进成交
    usage_limitstring
    Example: 1
    use_with_otherstring
    Example: 0
    using_statestring
    Example: normal
    valueinteger
    Default value: 0
    Example: 1
    value_typestring
    Example: percentage
    variant_product_idsarray
  • ]