TransferOrder
ReceiveTransferOrder
Records receipt of CatalogItemVariations for a transfer order. This endpoint supports partial receiving - you can receive items in multiple batches.
For each line item, you can specify:
- Quantity received in good condition (added to destination inventory with InventoryState of IN_STOCK)
- Quantity damaged during transit/handling (added to destination inventory with InventoryState of WASTE)
- Quantity canceled (returned to source location's inventory)
The order must be in STARTED or PARTIALLY_RECEIVED status. Received quantities are added to the destination Location's inventory according to their condition. Canceled quantities are immediately returned to the source Location's inventory.
When all items are either received, damaged, or canceled, the order moves to COMPLETED status.
Creates a transfer_order.updated webhook event.
post/v2/transfer-orders/{transfer_order_id}/receive
Path parameters
transfer_order_idstring required
The ID of the transfer order to receive items for
Request body
Example request
{
"idempotency_key": "EXAMPLE_IDEMPOTENCY_KEY_101",
"receipt": {
"line_items": [
{
"quantity_canceled": "1",
"quantity_damaged": "1",
"quantity_received": "3",
"transfer_order_line_uid": "1"
},
{
"quantity_canceled": "1",
"quantity_received": "2",
"transfer_order_line_uid": "2"
}
]
},
"transfer_order_id": "EXAMPLE_TRANSFER_ORDER_ID_123",
"version": 1753118664873
}Response
Success
Example response
{
"transfer_order": {
"completed_at": "2025-01-15T10:55: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": "1",
"quantity_damaged": "1",
"quantity_ordered": "5",
"quantity_pending": "0",
"quantity_received": "3",
"uid": "1"
},
{
"item_variation_id": "EXAMPLE_ITEM_VARIATION_ID_002",
"quantity_canceled": "1",
"quantity_damaged": "0",
"quantity_ordered": "3",
"quantity_pending": "0",
"quantity_received": "2",
"uid": "2"
}
],
"notes": "Example transfer order for inventory redistribution between locations",
"source_location_id": "EXAMPLE_SOURCE_LOCATION_ID_123",
"status": "COMPLETED",
"tracking_number": "TRACK123456789",
"updated_at": "2025-01-15T10:55:00Z",
"version": 1753118667248
}
}