Pick the List Customer Redeemables action (under Customers).
Fill in the fields below, then reference the result from later steps as {{listCustomerRedeemables.response.data}}.
Request
Path parameters
customerIdstringrequired
Unique identifier of a customer represented by an internal customer ID or customer source ID.
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.
orderstring
Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
One ofid-id
starting_after_idstring
A cursor for pagination. It retrieves the events starting after an event with the given ID.
filtersobject
Filters for listing customer redeemables.
idobject1 fields
Unique redeemable holder ID, i.e. `rh_0e77502f84f0f4a6a8`.
created_atobject1 fields
Timestamp representing the date and time when the customer redeemable was created. The value is shown in the ISO 8601 format.
redeemable_idobject1 fields
Unique redeemable ID, e.g. `v_hS8JFl8S6lNcd1L69wLIoXgTio7eWEgk`.
redeemable_objectobject1 fields
Unique related object, i.e. `voucher`.
holder_roleobject1 fields
Holder role of the redeemable. Allowed values:
`OWNER`,
`REFEREE`,
`REFERRER`.
campaign_idobject1 fields
Unique campaign identifer, e.g. `camp_bfrwAVsP6Q1EM1ZjgHwheKYr`.
campaign_typeobject1 fields
Type of the campaign. Allowed values:
`DISCOUNT_COUPONS`,
`REFERRAL_PROGRAM`,
`GIFT_VOUCHERS`,
`LOYALTY_PROGRAM`
voucher_typeobject1 fields
Type of the voucher. Allowed values:
`DISCOUNT_VOUCHER`,
`GIFT_VOUCHER`,
`LOYALTY_CARD`.
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 {{listCustomerRedeemables.response.data.<field>}}.
Need more? See the Voucherify guide for connection setup and behaviour shared by every action.
Was this page helpful?
List Customer Redeemables — Voucherify — Documentation
