查询优惠券列表

GET 
/openapi/2022-01/coupons

分页获取系统中可用的优惠券列表。

请求

Query参数

page int32

Page number

limit int32

Limit count per page

progress string
按优惠券进度筛选。
• not_started: 未开始。
• ongoing: 进行中。
• finished: 已结束。
type string
按优惠券类型筛选。
• fixed_amount: 固定金额折扣。
• percentage: 百分比折扣。
• voucher: 代金券。
keywords string

Search coupons' title

响应

200

200

application/json

数据结构

数据结构

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

示例

{
  "page": 0,
  "limit": 10,
  "total": 2,
  "data": [
    {
      "id": "202314454241654711",
      "store_id": 11218,
      "life_cycle_type": "begin_end",
      "survival_time": 86400,
      "starts_at": 1673246985,
      "ends_at": -1,
      "status": 0,
      "discount_type": "percentage",
      "value_type": "percentage",
      "value": "10",
      "usage_limit": -1,
      "once_per_customer": 0,
      "title": "coupon1",
      "stock": 0,
      "code": "",
      "prerequisite": 0,
      "is_admin_show": 0,
      "target_selection": "all",
      "progress": "ongoing",
      "using_state": "",
      "allocation_limit_amount": "0",
      "entitled_area_list": [
        null
      ],
      "prerequisite_quantity_range": [
        {
          "greater_than_or_equal_to": "",
          "value": "",
          "value_condition": "",
          "target_type": "",
          "target_data": {},
          "target_data_variant": {},
          "target_data_collection": {}
        }
      ],
      "prerequisite_subtotal_range": [
        {
          "greater_than_or_equal_to": "",
          "value": "",
          "value_condition": "",
          "target_type": "",
          "target_data": {},
          "target_data_variant": {},
          "target_data_collection": {}
        }
      ],
      "entitled_product_ids": [
        null
      ],
      "entitled_variant_ids": [
        null
      ],
      "entitled_sort": [
        null
      ],
      "times_used": 1,
      "sort": {
        "by": "sales",
        "direction": "desc"
      },
      "use_with_other": 0,
      "prerequisite_customer_ids": [
        null
      ],
      "prerequisite_customer_segment_ids": [
        null
      ],
      "config": {
        "banner_url": "",
        "banner_size": "",
        "count_down": {
          "show_count_down": false,
          "format": "",
          "background_color_start": "",
          "background_color_end": "",
          "color": "",
          "count_down_background_color": "",
          "count_down_color": "",
          "detail_page_show_code": false
        }
      },
      "allocation_method": "",
      "allocation_limit": 0,
      "customer_selection": "",
      "entitled_collection_ids": [
        null
      ],
      "tips": {
        "msg": "",
        "countdown": "",
        "countdown_day": "",
        "use_code": "",
        "copy_code": ""
      },
      "entitled_extra_list": {},
      "prerequisite_customer_range": {},
      "buysPrerequisiteValue": 0,
      "getsMaxOrderUseValue": 0,
      "getsDiscountValue": 0,
      "only_valid_first_order_customer": false
    }
  ]
}

Result

{
    "page": 0,
    "limit": 10,
    "total": 2,
    "data": [
        {
            "id": "202314454241654711",
            "store_id": 11218,
            "life_cycle_type": "begin_end",
            "survival_time": 86400,
            "starts_at": 1673246985,
            "ends_at": -1,
            "status": 0,
            "discount_type": "percentage",
            "value_type": "percentage",
            "value": "10",
            "usage_limit": -1,
            "once_per_customer": 0,
            "title": "coupon1",
            "stock": 0,
            "code": "",
            "prerequisite": 0,
            "is_admin_show": 0,
            "target_selection": "all",
            "progress": "ongoing",
            "using_state": "",
            "allocation_limit_amount": "0",
            "entitled_area_list": [],
            "prerequisite_quantity_range": [
                {
                    "greater_than_or_equal_to": "",
                    "value": "",
                    "value_condition": "",
                    "target_type": "",
                    "target_data": null,
                    "target_data_variant": null,
                    "target_data_collection": null
                }
            ],
            "prerequisite_subtotal_range": [
                {
                    "greater_than_or_equal_to": "",
                    "value": "",
                    "value_condition": "",
                    "target_type": "",
                    "target_data": null,
                    "target_data_variant": null,
                    "target_data_collection": null
                }
            ],
            "entitled_product_ids": [],
            "entitled_variant_ids": [],
            "entitled_sort": [],
            "times_used": 1,
            "sort": {
                "by": "sales",
                "direction": "desc"
            },
            "use_with_other": 0,
            "prerequisite_customer_ids": [],
            "prerequisite_customer_segment_ids": [],
            "config": {
                "banner_url": "",
                "banner_size": "",
                "count_down": {
                    "show_count_down": false,
                    "format": "",
                    "background_color_start": "",
                    "background_color_end": "",
                    "color": "",
                    "count_down_background_color": "",
                    "count_down_color": "",
                    "detail_page_show_code": false
                }
            },
            "allocation_method": "",
            "allocation_limit": 0,
            "customer_selection": "",
            "entitled_collection_ids": [],
            "tips": {
                "msg": "",
                "countdown": "",
                "countdown_day": "",
                "use_code": "",
                "copy_code": ""
            },
            "entitled_extra_list": null,
            "prerequisite_customer_range": null,
            "buysPrerequisiteValue": 0,
            "getsMaxOrderUseValue": 0,
            "getsDiscountValue": 0,
            "only_valid_first_order_customer": false
        },
        {
            "id": "202310134632812624",
            "store_id": 11218,
            "life_cycle_type": "begin_end",
            "survival_time": 86400,
            "starts_at": 1673246985,
            "ends_at": -1,
            "status": 0,
            "discount_type": "percentage",
            "value_type": "percentage",
            "value": "10",
            "usage_limit": -1,
            "once_per_customer": 0,
            "title": "coupon2",
            "stock": 0,
            "code": "",
            "prerequisite": 0,
            "is_admin_show": 0,
            "target_selection": "all",
            "progress": "ongoing",
            "using_state": "",
            "allocation_limit_amount": "0",
            "entitled_area_list": [],
            "prerequisite_quantity_range": [
                {
                    "greater_than_or_equal_to": "",
                    "value": "",
                    "value_condition": "",
                    "target_type": "",
                    "target_data": null,
                    "target_data_variant": null,
                    "target_data_collection": null
                }
            ],
            "prerequisite_subtotal_range": [
                {
                    "greater_than_or_equal_to": "",
                    "value": "",
                    "value_condition": "",
                    "target_type": "",
                    "target_data": null,
                    "target_data_variant": null,
                    "target_data_collection": null
                }
            ],
            "entitled_product_ids": [],
            "entitled_variant_ids": [],
            "entitled_sort": [],
            "times_used": 0,
            "sort": {
                "by": "sales",
                "direction": "desc"
            },
            "use_with_other": 0,
            "prerequisite_customer_ids": [],
            "prerequisite_customer_segment_ids": [],
            "config": {
                "banner_url": "",
                "banner_size": "",
                "count_down": {
                    "show_count_down": false,
                    "format": "",
                    "background_color_start": "",
                    "background_color_end": "",
                    "color": "",
                    "count_down_background_color": "",
                    "count_down_color": "",
                    "detail_page_show_code": false
                }
            },
            "allocation_method": "",
            "allocation_limit": 0,
            "customer_selection": "",
            "entitled_collection_ids": [],
            "tips": {
                "msg": "",
                "countdown": "",
                "countdown_day": "",
                "use_code": "",
                "copy_code": ""
            },
            "entitled_extra_list": null,
            "prerequisite_customer_range": null,
            "buysPrerequisiteValue": 0,
            "getsMaxOrderUseValue": 0,
            "getsDiscountValue": 0,
            "only_valid_first_order_customer": false
        }
    ]
}