<- Transfer Order API

Transfer Order API

All versions ->

Update transfer orderBeta

PUT

 /v2/transfer-orders/{transfer_order_id}

Updates an existing transfer order.

This endpoint supports sparse updates, allowing you to modify specific fields without affecting others.

Creates a transfer_order.updated webhook event.

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

Path parameters

Example code

Link to section

transfer_order_id

string

Required

The ID of the transfer order to update

Link to section

Request body

Link to section

idempotency_key

string

Required

A unique string that identifies this UpdateTransferOrder request. Keys must contain only alphanumeric characters, dashes and underscores

Min Length
1
Link to section

transfer_order

Required

The transfer order updates to apply

Link to section

version

integer(64-bit)

Version for optimistic concurrency

Link to section

Response fields

Link to section

transfer_order

The updated transfer order

Link to section

errors

Any errors that occurred during the request

Error descriptions