Skip to main content
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. Reward fulfillments can be preloaded.
​
id
integer

The unique identifier of the reward fulfillment.

Example:

625478984

​
name
string

The reward fulfillment's name.

Example:

"$5 off coupon"

​
code
string

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.

Example:

"5off-e26d02e39149"

​
fulfillmentStatus
enum<string>

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

  • pending - The reward fulfillment is pending issuance.
  • issued - The reward fulfillment has been issued to the customer.
  • cancelled - The reward fulfillment has been cancelled.
  • failed - The reward fulfillment has failed to be issued.
Available options:
pending,
issued,
cancelled,
failed
Example:

"issued"

​
expiresAt
string<date-time> | null

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.

Example:

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

​
imageUrl
string

The reward fulfillment's image.

Example:

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

​
usedAt
string<date-time> | null

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.

Example:

null

​
createdAt
string<date-time>

Date and time at which the reward fulfillment was created.

Example:

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

​
updatedAt
string<date-time>

Date and time at which the reward fulfillment was updated.

Example:

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