CustomerRewardCreateInput

input

The input fields for creating and issuing a customer reward.

Fields

buyerIds ● [String!]!non-null

A list of IDs of customers to whom the reward applies.
Maximum size: 100

businessId ● ID!non-null

The unique identifier for the reward issuance.
Maximum length: 64

rewardType ● RewardTypeCreate!non-null

The discount type of the reward.

benefitsDetails ● String!non-null

The discount value of the reward.
Example: Setting rewardType to PERCENTAGE_DISCOUNT and benefitsDetails to 50 indicates a 50% discount.

rewardUsageInstructionType ● RewardUsageInstructionTypeCreate!non-null

The type of the reward usage threshold.

rewardUsageInstructionValue ● String

The value of the reward usage threshold.
Example: Setting rewardType to PERCENTAGE_DISCOUNT, rewardUsageInstructionType to MIN_ITEM_QUANTITY, and rewardUsageInstructionValue to 2 indicates that a customer needs to purchase at least 2 items to use this reward.

usageLimits ● Int

The reward usage limit. Pass null or omit if there is no reward usage limit.

autoStackLimit ● Boolean

Whether the reward can be used with automatic discounts.

true: The reward can be used with automatic discounts.
false: The reward cannot be used with automatic discounts.

codeStackLimit ● Boolean

Whether the reward can be used with discount codes.

true: The reward can be used with discount codes.
false: The reward cannot be used with discount codes.

rewardExpiryTime ● String

The date and time when the reward expires. Format: ISO 8601. Pass null or omit if the reward is valid indefinitely.
Example: 2026-06-10T19:49:00.000Z

Map

Argument from

Mutation.customerRewardCreate

CustomerRewardCreateInput

Was this article helpful to you?

SHOPLINE

Legal