API documentation
Method list
Test your request
Changelog


addInventoryTransferItems
The method allows you to add planning items to an inventory transfer in draft status, or to update the quantity of an existing item by item_id. Entering the product with the ID updates the previously saved position only if all other parameters match. If any parameter differs (e.g. location), a new item will be added.


Input parameters
transfer_idintTransfer identifier
itemsarrayList of items to add or update. At most 1000 items with item_id can be updated at a time
| - item_idint(optional) Existing item identifier. When set, quantity is required and is the only field that can be updated
| - product_idintProduct identifier, required when item_id is not provided
| - quantityintQuantity to transfer. Must be a positive integer. Required when item_id is not provided.
| - location_namevarchar(20)(optional) Source WMS stock unit location. Must match an existing stock unit.
| - target_location_namevarchar(20)(optional) Target storage location name
| - expiry_datevarchar(10)(optional) Expiry date in YYYY-MM-DD format (ISO 8601). Used for WMS unit matching.
| - batchvarchar(128)(optional) Batch number. Used for WMS unit matching.
| - serial_novarchar(128)(optional) Serial number. Used for WMS unit matching.



Output data
The method returns the data in JSON format.
statusvarchar(30)SUCCESS - request executed correctly
ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
itemsarrayList of created or updated transfer items
| - item_idintItem identifier
| - positionintItem position in transfer



Sample
Input data:
Output data:
A sample request in PHP: