<- Transfer Order API

Transfer Order API

All versions ->

Receive transfer orderBeta

POST

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

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.

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 receive items for

Link to section

Request body

Link to section

idempotency_key

string

Required

A unique key to make this request idempotent

Min Length
1
Link to section

receipt

Required

The receipt details

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