Updates a transfer. Only the fields you pass are changed, the rest stay as they were. See Common Rules for partial editing.
v1/transfers/edit.php
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| transfer_id | int | Yes | Transfer ID |
| materials | array | No | Materials to move: id or sku and amount |
| products | array | No | Products to move: id or sku and amount |
| source_storage_id | int | No | Storage location items are moved from |
| target_storage_id | int | No | Storage location items are moved to |
| num | string | No | Number |
| date | string | No | Transfer date, YYYY-MM-DD |
| notes | string | No | Notes |
If materials or products is passed, the lines are replaced as a whole. Lines are passed in one array only, as in v1/transfers/add; to change the transfer type, pass the lines in the other array. If neither array is passed, the lines are unchanged. The status is not changed by this method; use v1/transfers/update_status.
The storage locations are validated only if storage locations or lines are passed. So a transfer whose storage location was later deleted can be edited as long as you do not pass storage locations or lines.
Example request
{
"transfer_id": 6967,
"target_storage_id": 4005,
"notes": "To the Gagarin St store"
}
Example response
{
"success": true
}
Errors
| Error | Reason |
|---|---|
| No transfer_id in input | transfer_id is missing |
| Transfer not found or access denied | Transfer not found or deleted |
| A transfer moves either materials or products. Create separate transfers | Both materials and products were passed |
| No products or materials in input | The line arrays were passed but empty |
| Product with id 512 not found | Product not found or deleted |
| Amount must be greater than 0 for product with id 512 | Quantity is not a number or not above 0 after rounding |
| Storage ID is not set | A storage location equal to 0 or empty |
| Storage ID not found | Storage location not found or deleted |
| Source and target storage locations must be different | The storage locations are the same |
| Storage location 4005 does not store products | The storage location does not store items of this type |
| Date is not a valid date in format YYYY-MM-DD | Invalid date format |
Other line errors are the same as in v1/transfers/add.