Reward Fulfillment object

A reward fulfillment is a reward (e.g. discount code) has been issued to a customer. Reward fulfillments cannot be directly created, they are automatically generated by the system based on the merchant’s loyalty program configuration when an activity is created or a points product is purchased.

integer

Unique identifier for the reward fulfillment.

Example:

625478984

name

string

The name of the reward fulfillment.

Example:

"$5 off coupon"

code

string

A unique code for the customer to use or apply the reward fulfillment. 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.

Example:

"5off-e26d02e39149"

customer_id

string

The ID of the customer that the reward fulfillment belongs to.

Example:

"304169228"

fulfillment_status

enum<string>

The fulfillment status of the reward fulfillment, indicating whether the reward is available to the customer.

Available options:

pending,

issued,

cancelled,

failed

Example:

"issued"

image_url

string

An image for the reward fulfillment.

Example:

"https://platform-images.smilecdn.co/9283449.png"

action_text

string

A short call-to-action style text, appropriate for use in buttons or links, guiding the customer on how to use the reward fulfillment. This field may be blank

action_url

string

A URL destination guiding the customer on how to use the reward, often paired with the action_text for use in buttons or links. This field may be blank.

usage_instructions

string

A description of how the customer can use or apply the reward fulfillment.

Example:

"Use this discount code on your next order!"

terms_and_conditions

string

A description of the reward fulfillment's limitations or restrictions. When the reward is a discount code, this commonly includes expiry date, minimum order amounts, or applicability to specific product collections.

Example:

"Reward expires on June 7, 2025. Reward can only be used on purchase of $50 or more. Reward can only be used on select product collections."

expires_at

string<date-time>

The date and time when the reward fulfillment expires. When the reward is a discount code, this refers to the expiry date of the discount.

Example:

"2025-06-07T23:59:59.999Z"

usage_status

enum<string>

The usage status of the reward fulfillment, indicating whether the generated reward has been used by the customer.

Available options:

used,

unused,

untracked

Example:

"unused"

used_at

string<date-time>

The date and time when the reward fulfillment was used by the customer. If the reward fulfillments does not support usage tracking, this field may be blank even after the reward fulfillment has been used.

created_at

string<date-time>

The date and time when the reward fulfillment was created.

Example:

"2024-12-07T20:15:27.893Z"

updated_at

string<date-time>

The date and time when the reward fulfillment was last updated.

Example:

"2024-12-07T20:15:27.893Z"

REST API

API resources