<- Transfer Order API

Transfer Order API

All versions ->

Create transfer orderBeta

POST

 /v2/transfer-orders

Creates a new transfer order in DRAFT status.

A transfer order represents the intent to move CatalogItemVariations from one Location to another. The source and destination locations must be different and must belong to your Square account.

In DRAFT status, you can:

  • Add or remove items
  • Modify quantities
  • Update shipping information
  • Delete the entire order via DeleteTransferOrder

The request requires source_location_id and destination_location_id. Inventory levels are not affected until the order is started via StartTransferOrder.

Common integration points:

  • Sync with warehouse management systems
  • Automate regular stock transfers
  • Initialize transfers from inventory optimization systems

Creates a transfer_order.created webhook event.

Permissions:INVENTORY_READ, INVENTORY_WRITE
Try in API Explorer
Link to section

Request body

Example code

Link to section

idempotency_key

string

Required

A unique string that identifies this CreateTransferOrder request. Keys can be any valid string but must be unique for every CreateTransferOrder request.

Link to section

transfer_order

Required

The transfer order to create

Link to section

Response fields

Link to section

transfer_order

The created transfer order

Link to section

errors

Any errors that occurred during the request

Error descriptions