GENERAL INFORMATION
With this endpoint you can retrieve the transfers that Wair has generated. These transfers either are for an initial distribution, replenishment or re-allocation. Important to be aware of when implementing this endpoint is that we do not keep track which transfers have been retrieved, so we always expose all open transfers. Use the referenceId in the response payload along with the FromConfirmedDateTime queryparameter to ensure no duplicate transfers will be created on the source system.
Direct link to Swagger documentation:
REQUEST
Authentication:
Bearer token, information on page POST /Token
Headers
Name | Description | Example |
|---|---|---|
X-Tenant | Tenant code supplied by Wair | “TENANT” |
QueryParameters:
Name | Description | Example |
|---|---|---|
Offset | The offset of records you want to retrieve | 100 |
Limit | Maximum number of records you want to retrieve | 10 |
FromConfirmedDateTime | A filter from which point of time you want to retreive transfers. Use case; you have called this API and succesfully processed it’s result. For the next time you call this API you pass the datetime you have last successfully processed the results in order to minimize the payload for fast processing. | 2025-07-30 00:00:00.00 |
Body example:
No body required.
RESPONSE
StatusCodes:
200 = OK
401 = Unauthorized, which means an expired/missing/invalid token
500 = System error, see body of the response to check which error has occured or contact integration support
Body Example:
{
"transfers": [
{
"fromLocationId": "001",
"toLocationId": "002",
"skuId": "10001-10-XL",
"quantity": 1.00000,
"referenceId": "RD_71ff7006-23f8-4960-8c4d-ce654772f54c",
"approvalBatchId": "38822F29-6120-4405-AB87-C8ECFE7C413F",
"fromLocationGLN": "9876543219876",
"toLocationGLN": "9876543219889",
"transferType": "Redistribution",
"approvalBatchDescription": "Redistribution Tshirt 20251114",
"plannedDispatchDate": "2025-11-21"
}
],
"offset": 0,
"limit": 0,
"moreRecordsAvailable": true
}fromLocationId = the id of the location the item needs to be transferred from
toLocationId = the id of the location the item needs to be transferred to
skuId = the id of the sku
quantity = the quantity that is recommended to transfer
referenceId = a unique id of a transfer created by Wair. Use this as a consumer of the API to keep track of the transfers you have processed to prevent duplicates.
approvalBatchId = we assign a batch id for every replenishment/redistribution/initial distribution that a user executes. So all transfers that are created from the same action are assigned the same batchId, which you could use for grouping the transfers.
fromLocationGLN = the 13 number GLN code of the location the item needs to be transferred from. This will be null in case you have not sent us the GLN number in the locations interface.
toLocationGLN = the 13 number GLN code of the location the item needs to be transferred to. This will be null in case you have not sent us the GLN number in the locations interface.
transferType = The Type of the transfer, which can be InitialDistribution, Replenishment or Redistribution.
approvalBatchDescription = this is an optional field which is filled with user input. If someone creates a batch of replenishment/redistribution/initial distribution they are asked to input a free text field which they can use to describe the transfer
plannedDispatchDate = this is also an optional field where a user can assign a specific dispatch date, which can be used by the ERP/WMS to the transfers on a dispatch date in the future.
offset = The offset you used as queryParam
limit = The limit you used as queryParam
moreRecordsAvailable = if there are more records available after your offset/limit