Get available coupons

Returns only active coupons assigned to this user (allowedUser = current user id).
General/public coupons are not listed here. Supports page, limit, search, orderBy, order.

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Responses

🟢200OK

application/json

Coupons retrieved successfully

Body

Example

{
    "status": "success",
    "message": "Coupons fetched successfully",
    "data": {
        "coupons": [
            {
                "_id": "64f1a2b3c4d5e6f7890a1234",
                "code": "SUMMER2024",
                "type": "percentage",
                "value": 20,
                "minOrderValue": 100,
                "maxDiscountValue": 50,
                "description": "Summer discount",
                "startDate": "2019-08-24T14:15:22.123Z",
                "endDate": "2019-08-24T14:15:22.123Z",
                "isActive": true,
                "maxUsesPerUser": 1,
                "maxUses": 100,
                "usedCount": 0,
                "createdAt": "2019-08-24T14:15:22.123Z",
                "updatedAt": "2019-08-24T14:15:22.123Z"
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 10,
            "total": 40,
            "totalPages": 4
        }
    }
}

🟠401Unauthorized

Get available coupons

Request

Responses