Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
Response body schema for POST v1/redemptions
.
An array of redeemables. You can combine voucher
(s) and promotion_tier
(s). Alternatively, send one uniquepromotion_stack
in the array. Each unique redeemable can be sent in one request only once.
1 - 30
elements- Voucher Redeemable
- Promotion Tier Redeemable
- Promotion Stack Redeemable
- Gift Card Redeemable
- Loyalty Card Redeemable
Configure parameters returned in the response.
Order information.
Customer's information.
Schema model for session lock object. The session object is required to establish a session between multiple parallel validation and redemption requests. If you only send the type parameter in the request, then by default the session lock will be established for 7 days. Read more on establishing a validation session.
Is correspondent to Customer's source_id
A set of key/value pairs that you can attach to a redemption object. It can be useful for storing additional information about the redemption in a structured format.
Response
Depending on your project settings: all redeemables must be valid or just one must be valid to result as valid redemption. Read more in the Stacking Rule Documentation.
Response body schema for POST v1/redemptions
.
This is an object representing a redemption for POST v1/redemptions
and POST /client/v1/redemptions
.
Contains the order details associated with the redemption. Order information.
Lists validation results of each inapplicable redeemable.
Lists validation results of each redeemable. If a redeemable can be applied, the API returns "status": "APPLICABLE"
.