Get a Coupon

Gets a coupon by the given id.

get

Path parameters

idstringRequired

The id of the coupon.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/coupons/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "code": "COUPON1",
    "name": "Coupon 1",
    "description": "This is a coupon",
    "tags": "tag1, tag2",
    "percentage": 10,
    "quantity": 100,
    "startDate": "2025-09-19T11:20:20.2798834+07:00",
    "endDate": "2025-10-19T11:20:20.2798838+07:00",
    "autoApplyToPrice": true,
    "status": "Active",
    "testMode": false,
    "modifiedDate": "2025-09-19T11:20:20.2798842+07:00"
  },
  "errors": []
}