Get the list of coupons already claimed by the current user, supporting pagination display and status filtering.
Points to note
- This interface is used to get the current user's coupon list information
- Supports pagination query, can be controlled by current and pageSize parameters
- Support filtering coupons by status (unused, used, or all)
- You need to log in to get the coupon list
- Ensure that the domain address is correctly configured
- The returned results include total information for easy pagination processing
Request address
{域名地址}/api/coupon/codes
Description:{域名地址}Replace it with your domain name, such ashttps://en.anqicms.com/api/coupon/codes
Request Syntax
GET /api/coupon/codes
Request Headers
This interface involves only public request headers. For more information, please refer toCommon Request Headers (Common Request Headers).
Request parameters
| Field name | Type | Required | Description |
|---|---|---|---|
| current | int | No | Retrieve specified pagination data, current page number |
| pageSize | int | No | Display quantity, number per page |
| status | int | No | Status 0 = unused, 1 = used, not provided to get all |
Response header
This interface only involves common response headers. For more information, please refer toCommon Request Headers (Common Request Headers).
Return parameters
| Field name | Type | Description |
|---|---|---|
| code | int | Error code |
| msg | string | Error description |
| data | object[] | result content |
| Total | int | Total |
data result item parameter
| Field name | Type | Description |
|---|---|---|
| id | int | Coupon code ID |
| Title | string | Coupon name |
| coupon_id | int | Coupon ID |
| start_time | int | start time |
| End Time | int | end time |
| user_id | int | User ID |
| money | Float | Discount Amount |
| max money | Float | Highest Discount Amount |
| get_time | int | Claim Time |
| use_time | int | Usage Time |
| order_id | int | Order ID |
| money_type | int | Discount amount type 0 = Fixed amount, 1 = Random amount, 2 = Percentage discount |
| description | string | description |
Usage Example
Request example
GET /api/coupon/codes?current=1&pageSize=10&status=0 HTTP/1.1
Host: www.anqicms.com
Response Example
{
"code": 0,
"data": [
{
"id": 1,
"title": "新用户优惠券",
"coupon_id": 1,
"start_time": 1624494644,
"end_time": 1627173044,
"user_id": 1,
"money": 10.00,
"max_money": 0.00,
"get_time": 1624494644,
"use_time": 0,
"order_id": 0,
"money_type": 0,
"description": "新用户专享优惠券"
},
{
"id": 2,
"title": "满减优惠券",
"coupon_id": 2,
"start_time": 1624494644,
"end_time": 1627173044,
"user_id": 1,
"money": 20.00,
"max_money": 0.00,
"get_time": 1624494650,
"use_time": 0,
"order_id": 0,
"money_type": 0,
"description": "满100可用"
}
],
"msg": "",
"total": 2
}
Error code
| Error code | Description |
|---|---|
| 0 | OK |
| -1 | Error, the reason is indicated in msg |
| 1001 | Not logged in |
| 1002 | Not authorized |
| 200 | API request OK |