# Get a list of coupons
# Interface call specification
Http request method: POST
https://api.weixin.qq.com/shop/coupon/get_list?access_token=xxxxxxxxx
# Request Parameter Sample
{
"page_size": 3,
"offset": 2
}
# Return Package Example
{
"errcode": 0,
"total_in a": 10,
"result_list": [{
"coupon": {
"out_coupon_id": "out_coupon_id_3",
"type": 101,
"promote_type": 4,
"coupon_info": {
"name": "Test 3,"
"promote_info": {
"promote_type": "PROMOTE_TYPE_FINDER",
"finder": {}
},
"receive_info": {
"total_in a": 100
},
"ext_info": {
"valid_time": 1625226181
}
},
"status": 0,
"create_time": 1625218450,
"update_time": 1625238573,
"appid" : "wx9e20708660a0991b"
},
"coupon_stock": {
"out_coupon_id": "out_coupon_id_3",
"stock_info": {
"issued_in a": 99,
"receive_in a": 1
},
"create_time": 1625226181,
"update_time": 1625237877,
"appid" : "wx9e20708660a0991b"
}
}, {
"coupon": {
"out_coupon_id": "out_coupon_id_4",
"type": 101,
"promote_type": 4,
"coupon_info": {
"name": "Test 4,"
"promote_info": {
"promote_type": "PROMOTE_TYPE_FINDER",
"finder": {}
},
"receive_info": {
"total_in a": 1000
}
},
"status": 1,
"create_time": 1625239595,
"update_time": 1625239595,
"appid" : "wx9e20708660a0991b"
}
}, {
"coupon": {
"out_coupon_id": "coupon_id_1",
"type": 101,
"promote_type": 4,
"coupon_info": {
"name": Sample Coupon,
"promote_info": {
"promote_type": "PROMOTE_TYPE_FINDER",
"finder": {
"nickname": "Video Number Nickname"
}
},
"discount_info": {
"discount_condition": {
"product_cnt": 2,
"product_price": 5000,
"out_product_ids": ["product_id_3", "product_id_4"],
"tradein_info": {
"out_product_id": "product_id_5",
"price": 10000
},
"buyget_info": {
"buy_out_product_id": "product_id_1",
"buy_product_cnt": 3,
"get_out_product_id": "product_id_2",
"get_product_cnt": 2131241242
}
},
"discount_in a": 9800,
"discount_fee": 6400
},
"receive_info": {
"start_time": 1625451250,
"end_time": 1625454250,
"limit_A_one_person": 10,
"total_in a": 100
},
"valid_info": {
"valid_type": "COUPON_VALID_TYPE_TIME",
"valid_day_in a": 10,
"start_time": 1625451250,
"end_time": 1625464250
},
"ext_info": {
"valid_time": 1625473652
}
},
"status": 2,
"create_time": 1625454641,
"update_time": 1625473652,
"appid" : "wx9e20708660a0991b"
},
"coupon_stock": {
"out_coupon_id": "coupon_id_1",
"stock_info": {
"issued_in a": 99,
"receive_in a": 1
},
"create_time": 1625473652,
"update_time": 1625474308,
"appid" : "wx9e20708660a0991b"
}
}]
}
# Request Parameter Dxplaination
| parameter | type | Introductions |
|---|---|---|
| page_size | number | Page size, up to 200 |
| offset | number | Offset, starting at 0 |
# Return parameter specification
| parameter | type | Introductions |
|---|---|---|
| total_A | number | total |
| coupon.out_coupon_id | string | Merchant Side Coupon ID |
| coupon.type | number | Coupon Type |
| coupon.promote_type | number | Coupon Promotion Type |
| coupon.coupon_info.name | string | Coupon Name |
| coupon.coupon_info.promote_info.promote_type | number | Coupon Promotion Type |
| coupon.coupon_info.promote_info.finder.nickname | string | Promotional Video Number |
| coupon.coupon_info.discount_info.discount_condition.product_cnt | number | Number of goods |
| coupon.coupon_info.discount_info.discount_condition.product_price | number | Amount of merchandise |
| coupon.coupon_info.discount_info.discount_condition.out_product_ids | string array | Specify product merchant side ID |
| coupon.coupon_info.discount_info.discount_condition.tradein_info.out_product_id | string | Merchant Side ID |
| coupon.coupon_info.discount_info.discount_condition.tradein_info.price | number | Amount to be paid, per cent |
| coupon.coupon_info.discount_info.discount_condition.buyget_info.buy_out_product_id | string | Buy Merchandise Merchant Side ID |
| coupon.coupon_info.discount_info.discount_condition.buyget_info.buy_product_cnt | number | Number of items purchased |
| coupon.coupon_info.discount_info.discount_condition.buyget_info.get_out_product_id | string | Business side ID |
| coupon.coupon_info.discount_info.discount_condition.buyget_info.get_product_cnt | number | Number of items donated |
| coupon.coupon_info.discount_info.discount_A | number | The amount of discount, such as 5.1%, is 5100 |
| coupon.coupon_info.discount_info.discount_fee | number | Less amount, expressed in points |
| coupon.coupon_info.receive_info.start_time | number | Collection Start Time |
| coupon.coupon_info.receive_info.end_time | number | End of collection |
| coupon.coupon_info.receive_info.limit_A_one_person | number | Number of claims |
| coupon.coupon_info.receive_info.total_A | number | Total issued |
| coupon.coupon_info.valid_info.valid_type | number | Validity Type, 1: Product Specified Time Interval, 2: Effective Days |
| coupon.coupon_info.valid_info.valid_day_A | number | Days of entry into force |
| coupon.coupon_info.valid_info.start_time | number | Entry into force |
| coupon.coupon_info.valid_info.end_time | number | Effective end time |
| coupon.status | number | Coupon status |
| coupon.create_time | number | Create time |
| coupon.update_time | number | Update time |
| coupon.coupon_stock.out_coupon_id | string | Merchant Side Coupon ID |
| coupon.coupon_stock.stock_info.issued_A | number | Coupon stock surplus |
| coupon.coupon_stock.stock_info.receive_A | number | Number of Vouchers issued |
| coupon.coupon_stock.create_time | number | Create time |
| coupon.coupon_stock.update_time | number | Update time |