API documentation
Method list
Test your request
Changelog


addInventoryTransfer
The method allows you to create a new inventory transfer in draft status. Both source and target warehouses must belong to inventories with advanced WMS enabled.


Input parameters
warehouse_idintSource warehouse identifier
target_warehouse_idintTarget warehouse identifier. Can be the same as source warehouse for intra-warehouse location transfers.
transfer_typeint(optional) Transfer type: 0 - replenishment (default), 1 - putaway transfer, 2 - location change
namevarchar(100)(optional) Transfer name/description
priorityint(optional) Priority: 0 - low (default), 1 - medium, 2 - high, 3 - urgent
assigned_toint(optional) Assigned employee identifier
date_scheduledint(optional) Scheduled date (unix timestamp)
date_dueint(optional) Due date (unix timestamp). Must be later than or equal to date_scheduled.
notesvarchar(255)(optional) Transfer notes/comments



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
transfer_idintCreated transfer identifier
transfer_numbervarchar(30)Generated transfer document number



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