| Attribute | Description |
|---|---|
id | The unique identifier of the reward fulfillment. |
name | The reward fulfillment’s name. |
code | A unique code for the customer to use. This is commonly a discount code the customer applies at checkout on their next order, but it can be a unique code they use for other purposes like accessing an exclusive page on the merchant’s website. |
fulfillment_status | The fulfillment status of the reward fulfillment, indicating whether the reward is available to the customer. Possible values are:pending - The reward is being fulfilled asynchronously and is not yet available to the customer.issued - The reward has been successfully fulfilled and is available for use by the customer.cancelled - The reward has been revoked and is no longer available to the customer.failed - The reward could not be fulfilled and is not available to the customer. |
expires_at | Date and time at which the code associated with the reward fulfillment expires and is no longer valid. If empty, the code does not expire. |
image_url | The reward fulfillment’s image. |
used_at | Date and time at which the reward fulfillment was used by the customer. This field will be blank if the reward fulfillment has not yet been used, or if it does not support usage tracking. |
created_at | Date and time at which the reward fulfillment was created. |
updated_at | Date and time at which the reward fulfillment was updated. |
Other objects
Reward fulfillment object
A reward fulfillment is a reward that has been issued to a customer. It commonly contains a unique discount code for customers to apply at checkout on their next order.