Retrieve Loyalty Program - Automate.ax

square.retrieveLoyaltyProgram retrieves the loyalty program in a seller’s account, specified by the program ID or the keyword main.

Example

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

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

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

  square.retrieveLoyaltyProgram({
    programId: "program_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires LOYALTY_READ.

Field	Type	Required	Default	Description
`programId`	`string`	Yes	—	The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller.

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

Output

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