# Get a list of coupons

# Interface call request specification

Http request method: POST
https://api.weixin.qq.com/product/coupon/get_list?access_token=xxxxxxxxx

# Request Parameter Sample

{
    "start_create_time": "2020-03-25 12:05:25",
    "end_create_time": "2020-04-25 12:05:25",
    "status": 2,
    "page": 1,
    "page_size": 10
}

# Return Package Example

{
    "errcode": 0,
    "errmsg": "ok",
    "coupons": 
    [
        {
            "coupon_id": 123,
            "type": 1,
            "status": 1,
            "create_time": "2020-05-30 00:00:00",
            "update_time": "2020-05-30 12:00:00",
            "coupon_info":
            {
                "name": "Dress 100-50,"
                "valid_info": 
                {
                    "valid_type": "COUPON_VALID_TYPE_TIME",  // Enumeration field The meaning is shown in the table below
                    "valid_day_in a": 0                      //valid_It makes sense when type = 2
                    "start_time": "2020-06-01 00:00:00"     //valid_Type = 1 makes sense
                    "end_time": "2020-07-01 00:00:00"       //valid_Type = 1 makes sense
                },
                "promote_info":
                {
                    "promote_type": "PROMOTE_TYPE_SHOP",       // Enumeration field The meaning is shown in the table below
                    "customize_channel": "xxxx" //Custom promotion channel specific content, promote_It makes sense when type = 2
                },
                "discount_info": {
                    "discount_condition": {
                        "product_price": 10000,
                        "product_ids": []
                    },
                    "discount_fee": 600
                }
            },
            "stock_info":
            {
                "issued_in a": 100,
                "receive_in a": 100,
                "used_in a": 100
            }
        }
    ],
    "total_in a": 10
}

# Request Parameter Dxplaination

parameter type Is it necessary to fill out Introductions
start_create_time string yes Coupon Creation Time Search Start Time
end_create_time string yes Coupon creation time Search end time
status number yes Coupon status
page number yes Page number (1 minimum)
page_size number yes Number of pages(Not more than 200)

# Return parameter specification

parameter type Introductions
Errcode number Error code
errmsg string Error message
coupons[].coupon_id number Coupon
coupons[].type number Coupon Type
coupons[].status number Coupon status
coupons[].create_time string Coupon Creation Time
coupons[].update_time string Coupon Renewal Time
coupons[].coupon_info.name string Coupon Name
coupons[].coupon_info.valid_info.valid_type string Coupon Validity Types, see the table below
coupons[].coupon_info.valid_info.valid_day_A number Coupon Valid Days_It makes sense when type = 2
coupons[].coupon_info.valid_info.start_time string Coupon Validity Start Time_Type = 1 makes sense
coupons[].coupon_info.valid_info.end_time string The end time of the coupon validity_Type = 1 makes sense
coupons[].coupon_info.promote_info.promote_type string Types of promotion, see table below
coupons[].coupon_info.promote_info.customize_channel string Custom promotion channel specific content, promote_It makes sense when type = 2
coupons[].stock_info.issued_A number Coupon Surplus
coupons[].stock_info.receive_A number Coupon usage
coupons[].stock_info.used_A number Coupon used
coupons[].coupon_info.discount_info.discount_A number Coupon Discounts * 1000, for example 5.1% -> 5100
coupons[].coupon_info.discount_info.discount_fee number Coupons reduce the amount, Unit points, For example $0.5 -> 50
coupons[].coupon_info.discount_info.discount_condition.product_cnt number Conditions for use of coupons, Full x items available
coupons[].coupon_info.discount_info.discount_condition.product_price number Conditions for use of coupons, Price full x available, unit points
coupons[].coupon_info.discount_info.discount_condition.product_ids[] number array Conditions for use of coupons, Specify product id available
coupons[].coupon_info.ext_info.invalid_time string Coupon Expiration Time
coupons[].coupon_info.ext_info.jump_product_id number Product id after receiving discount coupon
coupons[].coupon_info.ext_info.notes string Remarks information
coupons[].coupon_info.ext_info.valid_time string Coupon Valid Time
coupons[].coupon_info.receive_info.end_time string End Time of Coupon Collection
coupons[].coupon_info.receive_info.limit_A_one_person number Single Limited Tickets
coupons[].coupon_info.receive_info.start_time string Coupon Collection Start Time
coupons[].coupon_info.receive_info.total_A number Total number of coupons received
total_A number Total coupons

# Enumerations-type

Enumeration value describe
1 Discount coupon for condition of goods
2 Coupon Coupon
3 Unified Merchandise Discount Coupon
4 Commodities Direct Coupon
101 Shop Condition Discount Coupon
102 Shop full discount coupon
103 Shop unified discount coupon
104 Shop Direct Coupon

# Enumerate - status

Enumeration value describe
1 Not in force, in editing
2 Take effect
3 Expired
4 Cancelled
5 delete
200 Be overdue or Voided coupons

# Enumerations-promote_type

Enumeration field name Enumeration value describe
PROMOTE_TYPE_SHOP 1 Shop promotion
PROMOTE_TYPE_CUSTOMIZE 2 Custom promotion channels
PROMOTE_TYPE_TARGET 3 Directional discount

# Enumerations-valid_type

Enumeration field name Enumeration value describe
COUPON_VALID_TYPE_TIME 1 Product specified time interval
COUPON_VALID_TYPE_DAY 2 Days of entry into force

# Return code

Return code Type of error
-1 System exception
-2 Token is too long
9401020 Wrong parameter