Batch Retrieve Orders - Automate.ax

square.batchRetrieveOrders retrieves a set of orders by their IDs.

Example

automations/square-batch-retrieve-orders.automation.ts

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

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

  square.batchRetrieveOrders({
    locationId: "057P5VYJ4A5X1",
    orderIds: ["CAISEM82RcpmcFBM0TfOyiHV3es", "CAISENgvlJ6jLWAzERDzjyHVybY"],
  })
})

Inputs

Every input accepts a compatible signal. It requires ORDERS_READ.

Field	Type	Required	Default	Description
`locationId`	`string \| null`	No	—	The ID of the location for these orders. This field is optional: omit it to retrieve orders within the scope of the current authorization’s merchant ID.
`orderIds`	`string[]`	Yes	—	The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request.

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

Output

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