Get Coupons

Get coupons

get

Query parameters

NamestringOptional

Filter by the name of the coupon

CodestringOptional

Filter by the code of the coupon

DescriptionstringOptional

Filter by the description of the coupon

Percentagenumber · doubleOptional

Filter by the percentage of the coupon

Quantityinteger · int32Optional

Filter by the quantity of the coupon

AutoApplyToPricebooleanOptional

Filter by the auto apply to price of the coupon

TagsstringOptional

Filter by the tags of the coupon

Statusstring · enumOptional

Filter by the status of the coupon

Possible values:

KeywordsstringOptional

Filter by the keywords of the coupon

TestModebooleanOptional

Filter by the test mode of the coupon. Default is false.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

The sort order to sort. By default, the value is Descending.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

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

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "code": "COUPON1",
        "name": "Coupon 1",
        "description": "This is a coupon",
        "tags": "tag1, tag2",
        "percentage": 10,
        "quantity": 100,
        "startDate": "2025-07-15T14:34:48.2409128+07:00",
        "endDate": "2025-08-14T14:34:48.2409133+07:00",
        "autoApplyToPrice": true,
        "status": "Active",
        "testMode": false,
        "modifiedDate": "2025-07-15T14:34:48.2409146+07:00"
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null
  },
  "errors": []
}