ReceiveTransferOrder
Records goods received from a transfer order, updating its quantities and status. This is a Beta API.
Stored Procedure Specific Information
Execute
You need to provide the TransferOrderId, an IdempotencyKey, and a Receipt aggregate to receive items from a transfer order. The transfer order must be in STARTED status. Note: This is a Beta API.
EXECUTE ReceiveTransferOrder TransferOrderId = 'MYQUPHN3EIRBCKJR', IdempotencyKey = 'receive-tro-20240721-001', Receipt = '{"line_items":[{"transfer_order_line_uid":"Z4PB6EZYV52WIN7F","quantity_received":"5"}]}'
You can include damaged and canceled quantities in the receipt line items:
EXECUTE ReceiveTransferOrder TransferOrderId = 'MYQUPHN3EIRBCKJR', IdempotencyKey = 'receive-tro-20240721-001', Receipt = '{"line_items":[{"transfer_order_line_uid":"Z4PB6EZYV52WIN7F","quantity_received":"3","quantity_damaged":"1","quantity_canceled":"1"}]}'
You can optionally provide TransferOrderVersion for optimistic concurrency control:
EXECUTE ReceiveTransferOrder TransferOrderId = 'MYQUPHN3EIRBCKJR', IdempotencyKey = 'receive-tro-20240721-001', Receipt = '{"line_items":[{"transfer_order_line_uid":"Z4PB6EZYV52WIN7F","quantity_received":"5"}]}', TransferOrderVersion = 4
You can provide all inputs together, including a receipt with multiple line items:
EXECUTE ReceiveTransferOrder TransferOrderId = 'MYQUPHN3EIRBCKJR', IdempotencyKey = 'receive-tro-20240721-001', Receipt = '{"line_items":[{"transfer_order_line_uid":"Z4PB6EZYV52WIN7F","quantity_received":"3","quantity_damaged":"1","quantity_canceled":"1"},{"transfer_order_line_uid":"DPKVDLYUN5UXTAE4","quantity_received":"2","quantity_canceled":"1"}]}', TransferOrderVersion = 4
Input
| Name | Type | Required | Description |
| TransferOrderId | String | True | The ID of the transfer order to receive. |
| IdempotencyKey | String | True | A unique string that identifies this request. Keys can be any valid string but must be unique for every request. |
| Receipt | String | True | The receipt details containing line items with transfer order line UIDs and quantities (received, damaged, canceled). Pass raw JSON or aggregate. |
| TransferOrderVersion | Int64 | False | The current version of the transfer order, used for optimistic concurrency control. |
Result Set Columns
| Name | Type | Description |
| CurrentStatus | String | The status of the transfer order after receiving (for example, RECEIVED). |
| Success | Boolean | Whether the operation was successful. |