<- Object

Object

All versions ->

TransferOrderLineBeta

Represents a line item in a transfer order.

Each line item tracks a specific CatalogItemVariation being transferred, including ordered quantities and receipt status.

Link to section

Properties

Link to section

uid

string

Read only Unique system-generated identifier for the line item. Provide when updating/removing a line via UpdateTransferOrder.

Link to section

item_variation_id

string

Required

The required identifier of the CatalogItemVariation being transferred. Must reference a valid catalog item variation that exists in the Catalog.

Link to section

quantity_ordered

string

Required

Total quantity ordered, formatted as a decimal string (e.g. "10 or 10.0000"). Required to be a positive number.

To remove a line item, set remove to true in UpdateTransferOrder.

Link to section

quantity_pending

string

Read only Calculated quantity of this line item's yet to be received stock. This is the difference between the total quantity ordered and the sum of quantities received, canceled, and damaged.

Link to section

quantity_received

string

Read only Quantity received at destination. These items are added to the destination Location's inventory with InventoryState of IN_STOCK.

This field cannot be updated directly in Create/Update operations, instead use ReceiveTransferOrder.

Link to section

quantity_damaged

string

Read only Quantity received in damaged condition. These items are added to the destination Location's inventory with InventoryState of WASTE.

This field cannot be updated directly in Create/Update operations, instead use ReceiveTransferOrder.

Link to section

quantity_canceled

string

Read only Quantity that was canceled. These items will be immediately added to inventory in the source location.

This field cannot be updated directly in Create/Update operations, instead use ReceiveTransferOrder or CancelTransferOrder.