> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Start Transfer Order

> Changes a [DRAFT](entity:TransferOrderStatus) transfer order to [STARTED](entity:TransferOrderStatus) status.

`square.startTransferOrder` changes a [DRAFT](entity:TransferOrderStatus) transfer order to [STARTED](entity:TransferOrderStatus) status.

## Example

```ts automations/square-start-transfer-order.automation.ts theme={null}
import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

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

  square.startTransferOrder({
    transferOrderId: "transfer_order_id",
    idempotencyKey: "EXAMPLE_IDEMPOTENCY_KEY_789",
    version: BigInt("1753109537351"),
  })
})
```

## Inputs

Every input accepts a compatible signal. It requires `INVENTORY_READ` and `INVENTORY_WRITE`.

| Field             | Type     | Required | Default | Description                                                                                                                                              |
| ----------------- | -------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `transferOrderId` | `string` | Yes      | —       | The ID of the transfer order to start. Must be in DRAFT status.                                                                                          |
| `idempotencyKey`  | `string` | Yes      | —       | A unique string that identifies this UpdateTransferOrder request. Keys can be any valid string but must be unique for every UpdateTransferOrder request. |
| `version`         | `bigint` | No       | —       | Version for optimistic concurrency                                                                                                                       |

Use the official [StartTransferOrder reference](https://developer.squareup.com/reference/square/transfer-order-api/start-transfer-order) for provider field semantics and limits.

## Output

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