<- Transfer Order API

Transfer Order API

All versions ->

Start transfer orderBeta

POST

 /v2/transfer-orders/{transfer_order_id}/start

This decrements inventory at the source Location and marks it as in-transit.

The order must be in DRAFT status and have all required fields populated. Once started, the order can no longer be deleted, but it can be canceled via CancelTransferOrder.

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 start. Must be in DRAFT status.

Link to section

Request body

Link to section

idempotency_key

string

Required

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

Min Length
1
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 with status changed to STARTED

Link to section

errors

Any errors that occurred during the request

Error descriptions