Receive Transfer Order - Automate.ax

square.receiveTransferOrder records receipt of CatalogItemVariations for a transfer order.

Example

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

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

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

  square.receiveTransferOrder({
    transferOrderId: "transfer_order_id",
    idempotencyKey: "EXAMPLE_IDEMPOTENCY_KEY_101",
    receipt: {
      lineItems: [
        {
          transferOrderLineUid: "1",
          quantityReceived: "3",
          quantityDamaged: "1",
          quantityCanceled: "1",
        },
        {
          transferOrderLineUid: "2",
          quantityReceived: "2",
          quantityCanceled: "1",
        },
      ],
    },
    version: BigInt("1753118664873"),
  })
})

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 receive items for
`idempotencyKey`	`string`	Yes	—	A unique key to make this request idempotent
`receipt`	`Square.TransferOrderGoodsReceipt`	Yes	—	The receipt details
`version`	`bigint`	No	—	Version for optimistic concurrency

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

Output

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