<- Transfer Order API

Transfer Order API

All versions ->

Cancel transfer orderBeta

POST

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

Any unreceived quantities will no longer be receivable and will be immediately returned to the source Location's inventory.

Common reasons for cancellation:

  • Items no longer needed at destination
  • Source location needs the inventory
  • Order created in error

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 cancel. Must be in STARTED or PARTIALLY_RECEIVED 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 CANCELED

Link to section

errors

Any errors that occurred during the request

Error descriptions