Search Transfer Orders - Automate.ax

square.searchTransferOrders searches for transfer orders using filters.

Example

automations/square-search-transfer-orders.automation.ts

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

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

  square.searchTransferOrders({
    query: {
      filter: {
        sourceLocationIds: ["EXAMPLE_SOURCE_LOCATION_ID_123"],
        destinationLocationIds: ["EXAMPLE_DEST_LOCATION_ID_456"],
        statuses: ["STARTED", "PARTIALLY_RECEIVED"],
      },
      sort: {
        field: "UPDATED_AT",
        order: "DESC",
      },
    },
    cursor: "eyJsYXN0X3VwZGF0ZWRfYXQiOjE3NTMxMTg2NjQ4NzN9",
    limit: 10,
  })
})

Inputs

Every input accepts a compatible signal. It requires INVENTORY_READ.

Field	Type	Required	Default	Description
`query`	`Square.TransferOrderQuery`	No	—	The search query
`cursor`	`string`	No	—	Pagination cursor from a previous search response
`limit`	`number`	No	—	Maximum number of results to return (1-100)

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

Output

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