Redeem Loyalty Reward - Automate.ax

square.redeemLoyaltyReward redeems a loyalty reward.

Example

automations/square-redeem-loyalty-reward.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Redeem Square Loyalty Reward", () => {
  onDashboardRun({ title: "Redeem Square Loyalty Reward" })

  square.redeemLoyaltyReward({
    rewardId: "reward_id",
    idempotencyKey: "98adc7f7-6963-473b-b29c-f3c9cdd7d994",
    locationId: "P034NEENMD09F",
  })
})

Inputs

Every input accepts a compatible signal. It requires LOYALTY_WRITE.

Field	Type	Required	Default	Description
`rewardId`	`string`	Yes	—	The ID of the loyalty reward to redeem.
`idempotencyKey`	`string`	Yes	—	A unique string that identifies this `RedeemLoyaltyReward` request. Keys can be any valid string, but must be unique for every request.
`locationId`	`string`	Yes	—	The ID of the location where the reward is redeemed.

Use the official RedeemLoyaltyReward reference for provider field semantics and limits.

Output

Returns the official Square.RedeemLoyaltyRewardResponse response as a codec-safe object. Square integer money amounts remain bigint values.