[lightMode]

List Coupon Codes

GET/coupons/codes

[updatedIn] 2 months ago

This endpoint allows you to return all the child coupons of the parent coupon by passing the coupon_id as a query parameter.

`marketing.read` - Marketing Read Only

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

[message.queryParameter]

coupon_id

integer

required

The unique number of the coupon. Get a list of Coupon IDs from here

Example:

1257881496

Request samples

[api.label.responses]

Success(200)

Not Found(404)

Error Validation(422)

HTTP Code: 200

Content Type : JSONapplication/json

status

integer

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (ChildCouponCodes) {2}]

optional

integer

required

A Coupon ID is a unique identifier assigned to a specific coupon code. List of coupons cane be found here.

code

string

required

Generated coupon code

<= 10 characters

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 385681437,
      "code": "coupgmrGA"
    },
    {
      "id": 1622792886,
      "code": "coupgedkl"
    },
    {
      "id": 847582715,
      "code": "coupYgPYm"
    },
    {
      "id": 207766776,
      "code": "coupTyWXg"
    },
    {
      "id": 1582287441,
      "code": "coupgOuHi"
    },
    {
      "id": 672429890,
      "code": "coupgKhcv"
    },
    {
      "id": 997861675,
      "code": "coupgVbU8"
    },
    {
      "id": 1474282764,
      "code": "coupgPQFE"
    },
    {
      "id": 56440983,
      "code": "coupgmrEQ"
    },
    {
      "id": 19378402502,
      "code": "coupggFg9"
    },
    {
      "id": 1299038111,
      "code": "coupgBzJc"
    },
    {
      "id": 525025974,
      "code": "coupgUvBh"
    },
    {
      "id": 1762616341,
      "code": "coupRVtYC"
    },
    {
      "id": 989684078,
      "code": "coupgyIYy"
    },
    {
      "id": 349932097,
      "code": "coupgiDru"
    }
  ],
  "pagination": {
    "count": 15,
    "total": 200,
    "perPage": 15,
    "currentPage": 3,
    "totalPages": 14,
    "links": {
      "previous": "http://api.salla.dev/admin/v2/coupons/codes?coupon_id=626791646&page=2",
      "next": "http://api.salla.dev/admin/v2/coupons/codes?coupon_id=626791646&page=4"
    }
  }
}

[updatedIn] 2 months ago