logo

Retrieve a list of coupon redemptions

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

Responses
200

Coupons redemptions were retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
Array
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

couponId
string <= 50 characters

Coupon's ID.

customerId
string (CustomerId) <= 50 characters

The customer resource ID. Defaults to UUID v4.

Array of objects (RedemptionRestriction)

Additional restrictions for coupon's redemptions.

Array
type
required
string

Coupon's restriction type.

quantity
required
integer

Restriction quantity.

createdTime
string <date-time>

Coupon redeem time.

canceledTime
string <date-time>

Coupon redemption canceled time.

Array of objects (Self) non-empty

The links related to resource.

Array (non-empty)
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/coupons-redemptions
Request samples
$couponRedemptions = $client->couponsRedemptions()->search([
    'filter' => 'customerId:testCustomer',
]);
Response samples
application/json
[
  • {
    }
]
➔ Next to Redeem a coupon