List Redemptions
Returns a list of redemptions previously created. The redemptions are returned in a sorted order, with the most recent redemptions appearing first. The response returns a list of redemptions of all vouchers.
Filtering results
The result can be narrowed according to specified (or default) filters, for example, you can sort redemptions by date: https://api.voucherify.io/v1/redemptions?limit=3&[created_at][before]=2017-09-08T13:52:18.227Z. A filter based on the object created_at field narrows down the results and lists redemptions done before or after a particular date time. You can use the following options: [created_at][after], [created_at][before]. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before]=2017-09-08T13:52:18.227Z.
Failed Redemptions
A redemption may fail for various reasons. You can figure out an exact reason from the failure_code:
- resource_not_found - voucher with given code does not exist
- voucher_not_active - voucher is not active yet (before start date)
- voucher_expired - voucher has already expired (after expiration date)
- voucher_disabled - voucher has been disabled (active: false)
- quantity_exceeded - voucher's redemptions limit has been exceeded
- gift_amount_exceeded - gift amount has been exceeded
- customer_rules_violated - customer did not match the segment
- order_rules_violated - order did not match validation rules
- invalid_order - order was specified incorrectly
- invalid_amount - order amount was specified incorrectly
- missing_amount - order amount was not specified
- missing_order_items - order items were not specified
- missing_customer - customer was not specified
Query parameters
Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
Which page of results to return. The lowest value is 1, the highest value is 99.
A filter on the list based on the redemption result. Available options are: SUCCESS, FAILURE. You can provide multiple values by repeating the param.
A filter by the campaign name that the redemption resources originate from.
Return redemptions performed by the customer with given id or source_id.
Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before]=2017-09-08T13:52:18.227Z
{
"before": "2021-12-22T10:13:06.487Z",
"after": "2021-12-22T10:13:06.487Z"
}Filters for listing responses.
Response
Returns a list of redemption objects. Each entry in the array is a separate redemption object. If no more redemptions are available, the resulting array will be empty. If you provide a non-existent customer ID, this call returns an empty object.