Update coupon

Admin-only endpoint to update a coupon

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

API Key

Add parameter in header

x-api-key

Example:

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

Path Params

Body Params application/jsonRequired

Example

{
    "code": "AUTUMN2024",
    "type": "percentage",
    "value": 15,
    "minOrderValue": 150,
    "maxDiscountValue": 75,
    "description": "Autumn discount",
    "startDate": "2019-08-24T14:15:22.123Z",
    "endDate": "2019-08-24T14:15:22.123Z",
    "maxUsesPerUser": 2,
    "maxUses": 200,
    "allowedUser": "string",
    "vendors": [
        "string"
    ]
}

Responses

🟢200OK

application/json

Coupon updated successfully

Body

Example

{
    "status": "success",
    "message": "Coupon updated successfully",
    "data": {
        "coupon": {
            "_id": "64f1a2b3c4d5e6f7890a1234",
            "code": "SUMMER2024",
            "type": "percentage",
            "value": 20,
            "minOrderValue": 0,
            "maxDiscountValue": 0,
            "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,
            "allowedUser": null,
            "vendors": [],
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    }
}

🟠400Bad Request

🟠404Not Found

🟠409Conflict