Retrieve Transfer Order - Automate.ax

square.retrieveTransferOrder retrieves a specific TransferOrder by ID.

Example

automations/square-retrieve-transfer-order.automation.ts

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

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

  square.retrieveTransferOrder({
    transferOrderId: "transfer_order_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires INVENTORY_READ.

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

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

Output

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