All codes and tiers provided in redeemables are validated during the request and the result of their validation is returned in the API response.
|valid ||If all redeemables can be applied in the given context, the API returns |
|redeemables ||redeemables array lists results of validation of each redeemable. If a redeemable can be applied, the API returns "status": "APPLICABLE"|
|order ||order object presents details of the order provided in the request after all discounts are applied. Read more about returned order object.|
Responses will vary depending on the strings passed in the options.expand string array.
|Expand Option||Response Body|
|["order"]||- Same response as fallback response (without an options object).|
- Order data with calculated discounts are listed in each child redeemable object.
- Metadata not included for each discount type.
|["redeemable"]||Expands redeemable objects by including |
|["order", "redeemable"]||- Order data with calculated discounts are listed in each child redeemable object.|
|["category"]||- Returns an expanded |