getInventoryTransfers

Retrieve Inventory Transfers.

In Erply, an Inventory Transfer is a document that moves inventory between locations (stores); subtracts from one location and adds to the other. An Inventory Transfer contains a list of products and quantities.

Non-stock products and bundles cannot be transferred (these items do not have inventory).

To create or update an Inventory Transfer, see saveInventoryTransfer. To delete one, see deleteInventoryTransfer.

To get a CSV report of Inventory Transfers, see getInventoryTransferReport. If you need all Transfers that have taken place in a certain time period, it is more efficient to get the report — you will get all the data with just one query.

Input parameters

Parameter name Description Possible value Required
inventoryTransferID Get one specific Inventory Transfer integer
inventoryTransferIDs Multiple Inventory Transfer IDs, separated by commas, such as: 1,2,3,4,5. string
inventoryTransferNo integer
creatorID integer
warehouseFromID Retrieve transfers from a specific source location (warehouse, store). See getWarehouses. integer
warehouseFromIDs Multiple source location IDs, separated by commas, such as: 1,2,3,4,5. string
warehouseToID Retrieve transfers to a specific destination location (warehouse, store). See getWarehouses. integer
warehouseToIDs Multiple destination location IDs, separated by commas, such as: 1,2,3,4,5. string
dateFrom Date (yyyy-mm-dd)
dateTo Date (yyyy-mm-dd)
getCost If set to 1, API also returns the cost. integer
confirmed integer 0 or 1. integer
statuses Comma separated list. Possible values: CREATED, ACCEPTED, REJECTED and FULFILLED. string
reasonID Reason ID. integer
returnReasonID Reason ID. integer
referenceNumber Reference number. string
type Possible values: TRANSFER, TRANSFER_ORDER. string
fulfilled If set to 1, API returns only fulfilled Inventory Transfer Orders. Integer (0 or 1)
searchAttributeName Name of attribute to search from. Both "searchAttributeName" and "searchAttributeValue" have to be specified. Error 1030 will be returned if value is an array. string
searchAttributeValue Attribute value to search for. Error 1030 will be returned if value is an array. string
changedSince Retrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with Erply. Integer (Unix timestamp)
orderBy Possible values: 'inventoryTransferID', 'date', 'lastModified'. By default, 'inventoryTransferID'. string
orderByDir Sort direction: 'asc' (ascending order) or 'desc' (descending order). By default, items are sorted in ascending order. string
recordsOnPage Number of records API should return. By default 20, at most 100. integer
pageNo API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". integer

Response

Field name Type Description
inventoryTransferID integer ID of inventory transfer
inventoryTransferNo integer Inventory transfer number
creatorID integer
warehouseFromID integer
warehouseToID integer
deliveryAddressID integer Address ID that has been selected for deliveries.
currencyCode string Currency code: EUR, USD.
currencyRate number eg. 1.25543
Exchange rate of the inventory transfer currency against system's default currency.
type string Possible values: TRANSFER, TRANSFER_ORDER.
inventoryTransferOrderID integer Source document ID.
followupInventoryTransferID integer
date string Format: yyyy-mm-dd. eg. 2010-01-29
shippingDate string Format: yyyy-mm-dd. eg. 2010-01-29. Used for inventory transfer order types. Indicates the requested shipping date.
shippingDateActual string Format: yyyy-mm-dd. eg. 2010-01-29. Used for inventory transfer order types. Indicates the actual shipping date.
inventoryTransactionDate string Format: yyyy-mm-dd. Inventory transaction date.
This is the date on which the document was confirmed and when the items on this document were added into inventory, or removed from inventory. While "document date" can be edited by users at any time, "inventory transaction date" is always set by Erply and cannot be changed.
Inventory Reports and COGS reports are based on the inventory transaction date.
status string Used for inventory transfer order types - CREATED, APPROVED, REJECTED.
reasonID integer Reason ID. See getReasonCodes.
referenceNumber String/Null Reference number.
notes string
confirmed integer 0 or 1
added integer Unix timestamp. Creation time.
lastModified integer Unix timestamp. Last modification time.
rows array Each row contains the following fields:

Field nameTypeDescription
stableRowIDIntegerStable row ID.
productIDIntegerID of the transferred product.
priceDecimal

Unit cost at which the transfer was done. However, it is recommended to use the "cost" field instead.

When you create an Inventory Transfer, Erply sets the cost automatically, depending on which inventory batches the quantity is drawn from. In the past, it was possible to set it manually, hence we have the separate "price" field.

amountDecimalTransferred quantity.
costDecimal

Unit cost. This value is retrieved directly from inventory records, so it always reflects the true cost at which the items were transferred.

To retrieve this field, you need to set input parameter "getCost" = 1.

packageIDInteger

Package ID, if the item has been transferred in packages.

To retrieve the packages of a particular product, see getProducts, block "productPackages".

This field, and the following ones, are not returned if your account does not have the "Packages on Inventory Transfers" extra module activated.

amountOfPackagesDecimalAmount of packages
amountInPackageDecimalAmount of products contained in one package
packageTypeStringReadable package type name
packageTypeIDIntegerType ID of the package.
returnReasonIDIntegerReturn reason ID.
jdocObjectContains data that is saved using the JSON Api. Contents of this field change depending on what is saved into the json field. Output is always given as valid json or null when the field is not set.
Example: {"myValue":"123"}
attributes array Additional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value