Coupon Api

Fire this api to show coupon information.

List of all coupons

api/coupon

GET https://yourdomain.com/api/coupon

This end point allows to you list of all coupons informations.

Query Parameters

Name	Type	Description
secret	string	Client secret key will goes here which you get from admin panel.

Headers

Name	Type	Description
Authorization*	string	Bearer { bearer_token without bracket }
Accept*	string	application/json

200: OK List of all coupons information retrived successfully

{
    "coupon": [
       
        {
            "id": 6,
            "coupon_code": "NEW100",
            "percent_off": null,
            "currency": "USD",
            "amount_off": 75,
            "duration": "repeating",
            "max_redemptions": "1",
            "redeem_by": "2021-08-02T18:30:00.000000Z",
            "created_at": "2021-08-03T19:38:46.000000Z",
            "updated_at": "2021-08-03T19:38:46.000000Z",
            "in_stripe": 1
        }
    ]
}

401: Unauthorized if user is not authenticated

{
    "message": "Unauthorized !"
}

//or

{
    "message": "Secret Key is required"
}

404: Not Found Invalid secret key

{
    "message": "Invalid Secret Key !"
}

Verify Coupon

api/verifycoupon

POST https://yourdomain.com/api/verifycoupon

This end point allow to verifycoupon.

Query Parameters

Name	Type	Description
secret	string	Client secret key will goes here which you get from admin panel.

Headers

Name	Type	Description
AUthorization*	string	Bearer { bearer_token without bracket }
Accept*	string	application/json

Request Body

Name	Type	Description
coupon_code*	string	enter the coupon code

200: OK Coupon is verified successfully

{
    "message": "Coupon is applied !"
}

401: Unauthorized Unauthorized or coupon expired or not available

{
    "message": "Unauthorized !"
}

//or

{
    "message": "Secret Key is required"
}

//or

{
    "message": "Coupon is not available !"
}

//or

{
    "message": "Coupon Expired !"
}

404: Not Found Invalid secret key or coupon invalid

{
    "message": "Invalid Secret Key !"
}

//or

{
    "message": "Coupon is applied !"
}

422: Unprocessable Entity Validation failed

{
    "msg": "The coupon_code field is required.",
    "status": "fail"
}