Retrieve Loyalty Promotion - Automate.ax

square.retrieveLoyaltyPromotion retrieves a loyalty promotion.

Example

automations/square-retrieve-loyalty-promotion.automation.ts

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

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

  square.retrieveLoyaltyPromotion({
    programId: "program_id",
    promotionId: "promotion_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires LOYALTY_READ.

Field	Type	Required	Default	Description
`programId`	`string`	Yes	—	The ID of the base loyalty program. To get the program ID, call RetrieveLoyaltyProgram using the `main` keyword.
`promotionId`	`string`	Yes	—	The ID of the loyalty promotion to retrieve.

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

Output

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