1. Docs
2. /
3. Tool reference
4. /
5. Commerce
6. /
7. setShopRewards

Commerce

setShopRewards

Set Shop Rewards

Change a shop's rewards program: points on or off, points per dollar, the redemption step, tier names and thresholds, punch card on or off, card size and reward, the spend ladder steps, and the…

write

Arguments

• birthdayEnabledbooleanoptionalWhether members get the birthday reward.
• birthdayLabelstringoptionalWhat the birthday reward is called, e.g. "Birthday minicake".
• birthdayMinOrdersintegeroptionalOrders a member needs before the birthday reward unlocks.
• cardSizeintegeroptionalPunches that fill one card (one punch per order).
• ladderobject[]optionalThe spend ladder, replacing the whole list. Each step pays once at atMinor CENTS of spend into the cycle (44400 is $444); the last step closes the cycle and it starts again. Ascending.
• pointsEnabledbooleanoptionalfalse stops customers earning points. Balances stay and can still be redeemed.
• pointsPerDollarintegeroptionalPoints earned per whole dollar of merchandise.
• punchEnabledbooleanoptionalfalse stops the punch card, the ladder and the birthday reward.
• punchRewardLabelstringoptionalWhat a full card earns, e.g. "Case treat".
• redemptionMinorintegeroptionalCredit one redemption step is worth, in CENTS (500 is $5).
• redemptionPointsintegeroptionalPoints one redemption step costs (100 by default).
• spacestringoptionalSame as `spaceId`: the Space id or slug (see listPageSpaces) of the shop whose rewards to use.
• spaceIdstringoptionalSame as `space`: the Space id (see listPageSpaces) of a Space-owned shop. Pass either one. Omit both for your personal shop.
• tiersobject[]optionalTier names and thresholds, replacing the whole list. Ascending; the first starts at 0 points.

Returns

The registry does not declare a return shape.

Declared limits

• birthdayLabel: maximum length 60
• birthdayMinOrders: minimum 1
• birthdayMinOrders: maximum 100
• cardSize: minimum 2
• cardSize: maximum 50
• ladder: minimum items 1
• ladder: maximum items 6
• pointsPerDollar: minimum 1
• pointsPerDollar: maximum 100
• punchRewardLabel: maximum length 60
• redemptionMinor: minimum 1
• redemptionMinor: maximum 100000
• redemptionPoints: minimum 1
• redemptionPoints: maximum 100000
• tiers: minimum items 1
• tiers: maximum items 8

Ask for it

The Cloud routes these requests to this verb.

• give 2 points per dollar
• rename Gold to Wedding Cake
• make the punch card 10
• turn off the birthday reward

Pair it with

The verbs that finish the job.

• getShopRewards