Retrieving a List of Transfers

Maxim

Maxim

Last updated on Oct 8, 2026

Returns the company's transfers, from newest to oldest: by date, and within one date by ID. Lines are not included in the list; they are returned by v1/transfers/get_entry.

v1/transfers/get_list.php

Parameters

Field Type Required Description
storage_id int No Only transfers where this storage location is the source or the target
date_from string No Transfers from this date inclusive, YYYY-MM-DD
date_to string No Transfers up to this date inclusive, YYYY-MM-DD
status int No Status: 0 Plan, 1 Sent, 2 Received
limit int No Page size, from 1 to 1000
offset int No How many records to skip

Without limit the whole list is returned. See Common Rules for pagination.

Response

An array transfers with the transfer's fields:

Field Type Description
id int Transfer ID
num string Number
date string Transfer date, YYYY-MM-DD
status int Status: 0 Plan, 1 Sent, 2 Received
source_storage_id int Source storage location
source_storage_name string Source storage location name
target_storage_id int Target storage location
target_storage_name string Target storage location name
cost float Cost of what was transferred
price float Value of the products at their sale price. 0 for a material transfer
amount float Total quantity. null if the items have different units
lines int Number of lines
notes string Notes

The total field holds the total number of transfers matching the filters.

Example request

{
    "storage_id": 4001,
    "status": 1,
    "limit": 100,
    "offset": 0
}

Example response

{
    "success": true,
    "transfers": [
        {
            "id": 6967,
            "num": "31",
            "date": "2026-10-06",
            "status": 1,
            "source_storage_id": 3998,
            "source_storage_name": "Main",
            "target_storage_id": 4001,
            "target_storage_name": "Store",
            "cost": 61500,
            "price": 125000,
            "amount": 25,
            "lines": 2,
            "notes": "To the Main St store"
        }
    ],
    "total": 1
}

Errors

Error Reason
Date is not a valid date in format YYYY-MM-DD Invalid date_from or date_to
Invalid status value. Must be a number status is not a number
Invalid limit value. Must be between 1 and 1000 Invalid limit
Offset requires limit offset passed without limit