/
Retrieve coupons

Retrieve coupons

Request

Retrieves a list of coupons.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

qstring

Use this field to perform a partial search of text fields.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/coupons?limit=1000&offset=1000&filter=string&q=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of coupons retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the coupon. This value is also known as the coupon redemption code.

Example:"cpn_0YVCNKF81GD778N4YNVGDJK558"
discountobject(Discount)required
restrictionsArray of objects(CouponRestriction)

Coupon restrictions. All type values in this array must be unique.

redemptionsCountinteger, >= 0read-only

Total number of times that a coupon is redeemed.

statusstringread-only

Specifies the current status of the coupon.

Enum:"draft""issued""expired"
descriptionstring

Description of the coupon. Use this field to provide a description for the invoice discount item.

If this field is empty, the invoice discount item description uses the related coupon ID, in the following format: Coupon "COUPON-ID".

issuedTimestring, (date-time)required

Date and time when the coupon is issued. This value may also be described as start time of the coupon.

expiredTimestring or null, (date-time)

Date and time when the coupon expires.

revisionintegerread-only

Number of times the coupon data has been modified.

Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "cpn_0YVCNKF81GD778N4YNVGDJK558",
    "discount": { … },
    "restrictions": [ … ],
    "redemptionsCount": 0,
    "status": "draft",
    "description": "string",
    "issuedTime": "2019-08-24T14:15:22Z",
    "expiredTime": "2019-08-24T14:15:22Z",
    "revision": 0,
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]