Retrieve Location - Automate.ax

square.retrieveLocation retrieves details of a single location.

Example

automations/square-retrieve-location.automation.ts

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

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

  square.retrieveLocation({
    locationId: "location_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires MERCHANT_PROFILE_READ.

Field	Type	Required	Default	Description
`locationId`	`string`	Yes	—	The ID of the location to retrieve. Specify the string `main` to return the main location.

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

Output

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