Stackable Redemptions Object

Data model description

AttributesDescriptionExample
redemptions
parent_redemption

This is an object representing a stacked redemption.

Stacked Redemption

AttributesDescriptionExample
id

Unique redemption ID.

r_0bc92f81a6801f9bca

object

The type of object represented by the JSON. This object stores information about the redemption.

date

Timestamp in ISO 8601 format indicating when the redemption occured.

2022-10-03T12:24:58.008Z

customer_id

Unique customer ID of the redeeming customer.

cust_i8t5Tt6eiKG5K79KQlJ0Vs64

tracking_id

Hashed customer source ID.

track_fxEMFiLowFHg==

metadata

The metadata object stores all custom attributes in the form of key/value pairs assigned to the redemption.

result

Redemption result.

Available values: SUCCESS, FAILURE
order

Defines the details of the order that is related to the redemption.

customer

Defines the customer making the stacked redemption.

AttributesDescriptionExample
id

The unique ID of a customer that is assigned by Voucherify.

cust_eWgXlBBiY6THFRJwX45Iakv4

name

Customer's first and last name.

email

Customer's email address.

source_id

The merchant’s customer ID if it is different from the Voucherify customer ID. It is really useful in case of an integration between multiple systems. It can be a customer ID from a CRM system, database or 3rd-party service.

metadata

The metadata object stores all custom attributes assigned to the customer. A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format.

object

Type of object represented is customer.

related_object_type

Defines the related object.

Available values: redemption
related_object_id

Unique related object ID assigned by Voucherify, i.e. r_0c5d07222e08a34ace for a redemption.

voucher
order

Contains the order details associated with the redemption.

Language
URL
Click Try It! to start a request and see the response here!