Retrieve Order - Automate.ax

square.retrieveOrder retrieves an Order by ID.

Example

automations/square-retrieve-order.automation.ts

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

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

  square.retrieveOrder({
    orderId: "order_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires ORDERS_READ.

Field	Type	Required	Default	Description
`orderId`	`string`	Yes	—	The ID of the order to retrieve.

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

Output

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