The promotion endpoint allows users to apply a promotion to their account by putting in a promotion code. This endpoint require an access token in the Authorization HTTP header. Once the promo is applied to the user’s account successfully, the promo will show in the Customer Checkout call’s response.

Apply a promo

HTTP Request

POST /customer/promo/deal

Request Body

{
    "deal_code":"HU25",
}
Property Name Type Description
deal_code String The promotion code.

Success Response

HTTP 200 OK


{
    "deal": {
        "name": "Howard University: Get 25% Off Your First Order",
        "minimum": 10,
        "id": "893564",
        "reward": "percent_off",
        "value": 25,
        "limitType": "dollar_off",
        "valueLimit": "dollar_off"
    },
    "message": [
        {
            "code": "deal_add_success",
            "user_msg": "Sweet! The deal has been added successfully.",
            "dev_msg": "Sweet! The deal has been added successfully."
        }
    ]
}

Bad Response

HTTP 400 Bad Request

{
    "deal": null,
    "message": [
        {
            "code": "deal_first_only",
            "user_msg": "Sorry, but this promotion is for first-time customers only.",
            "dev_msg": "Sorry, but this promotion is for first-time customers only."
        }
    ]
}