Pick the List Redemptions action (under Redemptions).
Fill in the fields below, then reference the result from later steps as {{listRedemptions.response.data}}.
Request
Query parameters
limitinteger
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.
pageinteger
Which page of results to return. The lowest value is `1`, the highest value is `99`.
resultstring
A filter on the list based on the redemption result. Available options are: `SUCCESS`, `FAILURE`. You can provide multiple values by repeating the param.
campaignstring
A filter by the campaign **name** that the redemption resources originate from.
customerstring
Return redemptions performed by the customer with given `id` or `source_id`.
orderstring
Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
One ofcreated_at-created_atid-idvoucher_code-voucher_codetracking_id-tracking_idcustomer_id-customer_id
created_atobject
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`
beforestring (date-time)
Timestamp representing the date and time before the voucher was created. The value is shown in the ISO 8601 format.
afterstring (date-time)
Timestamp representing the date and time after the voucher was created. The value is shown in the ISO 8601 format.
filtersobject
Filters for listing responses.
voucher_codeobject1 fields
Unique voucher code.
related_object_idobject1 fields
Unique related object ID, i.e. v_hS8JFl8S6lNcd1L69wLIoXgTio7eWEgk.
related_object_parent_idobject1 fields
Unique related object parent ID, i.e. camp_22noMlhTADb7Fq2UL3vWu3d1.
parent_redemption_idobject1 fields
Unique parent redemption ID, i.e. r_0c5952900bcbfd54b6.
failure_codeobject1 fields
Failure code, i.e. quantity_exceeded.
resultobject1 fields
Result, i.e. `SUCCESS` or `FAILURE`.
objectobject1 fields
Specify which type of object to return, i.e. `redemption` or `redemption_rollback`.
customer_idobject1 fields
Unique customer ID, i.e. cust_sehkNIi8Uq2qQuRqSr7xn4Zi.
campaign_nameobject1 fields
Campaign name.
user_loginobject1 fields
User login used to login to Voucherify, i.e. name.lastname@email.com
junctionstring
Logical Operator Between Filters. Filter by conditions set on the `junction` parameter indicating how the `conditions` should be accounted for in the query. An `AND` is an all-inclusive logical operator, meaning the `AND` operator displays a record if **ALL** the conditions separated by AND are TRUE, while an `OR` operator displays a record if **ANY** of the conditions separated by OR is TRUE.
One ofandor
Response
Returns 200 with an object. Read it in later steps with {{listRedemptions.response.data.<field>}}.
objectstring
The type of the object represented by JSON. This object stores information about redemptions in a dictionary.
Default "list"
data_refstring
Identifies the name of the attribute that contains the array of redemption objects.
