TransferOrder
CancelTransferOrder
Cancels a transfer order in STARTED or PARTIALLY_RECEIVED status. 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.
post/v2/transfer-orders/{transfer_order_id}/cancel
Path parameters
transfer_order_idstring required
The ID of the transfer order to cancel. Must be in STARTED or PARTIALLY_RECEIVED status.
Request body
Example request
{
"idempotency_key": "65cc0586-3e82-4d08-b524-3885cffd52",
"transfer_order_id": "EXAMPLE_TRANSFER_ORDER_ID_123",
"version": 1753117449752
}Response
Success
Example response
{
"transfer_order": {
"completed_at": "2025-01-15T10:45:00Z",
"created_at": "2025-01-15T10:30:00Z",
"created_by_team_member_id": "EXAMPLE_TEAM_MEMBER_ID_789",
"destination_location_id": "EXAMPLE_DEST_LOCATION_ID_456",
"expected_at": "2025-11-09T05:00:00Z",
"id": "EXAMPLE_TRANSFER_ORDER_ID_123",
"line_items": [
{
"item_variation_id": "EXAMPLE_ITEM_VARIATION_ID_001",
"quantity_canceled": "5",
"quantity_damaged": "0",
"quantity_ordered": "5",
"quantity_pending": "0",
"quantity_received": "0",
"uid": "1"
},
{
"item_variation_id": "EXAMPLE_ITEM_VARIATION_ID_002",
"quantity_canceled": "3",
"quantity_damaged": "0",
"quantity_ordered": "3",
"quantity_pending": "0",
"quantity_received": "0",
"uid": "2"
}
],
"notes": "Example transfer order for inventory redistribution between locations",
"source_location_id": "EXAMPLE_SOURCE_LOCATION_ID_123",
"status": "CANCELED",
"tracking_number": "TRACK123456789",
"updated_at": "2025-01-15T10:45:00Z",
"version": 1753117461842
}
}