Skip to main content

Coupons

Get coupon info​

Request paramters​

  • Method: GET
  • URL: GET https://api.ssc-gateway.com/v1/coupons/{code}
  • Headers:
    • Content-Type: application/json
    • Authorization: x-api-key <token>

Response​

  • Status Codes:

    • 200 OK: API call successfully processed.
    • 400 Bad Request: Invalid query parameters.
    • 401 Unauthorized: Authentication failed.

  • Body Status Codes

    • 200: Coupon is found and the data is returned
    • 404: The given coupon could not be found

Example Request​

GET https://api.ssc-gateway.com/v1/coupons/2k86me

Example Response​

{
    "data": {
        "campaign": "cam_1218243",
        "code": "17ywun",
        "custom_field_1": "",
        "custom_field_2": "",
        "custom_field_3": "",
        "custom_field_4": "",
        "custom_field_5": "",
        "expiration_date": "2025-03-21T01:00:00",
        "expired": false,
        "redeemed": false,
        "session": "2k86meqv2hwrnfjs0jcs0",
        "subtitle": "Your coupon subtitle",
        "title": "YOUR COUPON TITLE HERE",
        "value": ""
    },
    "message": "Coupon info fetched.",
    "status_code": 200
}

Redeem a Coupon​

  • Method: POST
  • URL: POST https://api.ssc-gateway.com/v1/coupons/{code}/redeem
  • Headers:
    • Content-Type: application/json
    • Authorization: x-api-key <token>

Response​

  • Status Codes:

    • 200 OK: API call successfully processed.
    • 400 Bad Request: Invalid query parameters.
    • 401 Unauthorized: Authentication failed.

  • Body Status Codes

    • 200: Coupon is found and successfully redeemed
    • 404: The given coupon could not be found
    • 409: The given coupon is already redeemed

Example Request​

POST https://api.ssc-gateway.com/v1/coupons/2k86me/redeem

Example Response​

{
    "data": {},
    "message": "Coupon redeemed.",
    "status_code": 200
}