Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dev.smile.io/llms.txt

Use this file to discover all available pages before exploring further.

A reward is the configuration for a type of coupon, discount, benefit, or perk that can be issued to a customer. When the configuration is used to issue a reward, a reward fulfillment is generated. It is returned as part of a points product object.
​
id
integer

Unique identifier for the reward.

Example:

924565472

​
name
string

The name of the reward.

Example:

"Order discount"

​
description
string | null

A description of the reward.

Example:

"Applies to one-time purchases."

​
imageUrl
string

An image for the reward.

Example:

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

​
createdAt
string<date-time>

The date and time when the reward was created.

Example:

"2024-04-04T15:10:42.030Z"

​
updatedAt
string<date-time>

The date and time when the reward was last updated.

Example:

"2024-04-04T15:10:42.030Z"