Inventory Transfer
An inventory transfer transaction records the change in quantity when items are transferred between locations. It also decreases the on-hand quantity in the source location and increases it in the new location.
This transaction is available when the Locations feature and the Multi-Location Inventory (MLI) feature are enabled. For more details about this type of transaction, see Transferring Inventory.
The REST API Browser includes information about the field names and field types of the inventory transfer record, and about the HTTP methods, request parameters, and operations available to this record. For details, see the REST API Browser’s inventory transfer reference page.
For information about using the REST API Browser, see The REST API Browser.
Record IDs
The record ID for an inventory transfer REST record is inventorytransfer.
The record ID for an inventory detail REST subrecord is inventorydetail.
Prerequisites
There are no prerequisites for using the record in REST.
Sample Codes
The sample codes show common use cases for inventory transfers.
Creating an Inventory Transfer
The following example shows how to create an inventory transfer:
POST {{REST_SERVICES}}/record/v1/inventorytransfer
{ "subsidiary": {"id": 1}, "location": {"id": 1}, "transferLocation": {"id": 2}, "inventory": { "items": [{ "item": { "id": 20 }, "adjustQtyBy": 10 }] }
}
Updating an inventory transfer
The following example shows how to update an inventory transfer:
PATCH {{REST_SERVICES}}/record/v1/inventorytransfer/2072 { "total": 10.0, "inventory": { "items": [{ "line": 1, "adjustQtyBy": 2, "inventoryDetail": { "inventoryAssignment": { "items": [ { "internalId": 7207, "inventoryDetail": 1476, "inventoryStatus": {"id": 1}, "toInventoryStatus": {"id": 1}, "quantity": 2.0 } ] } } }] }
}