# Warehouse Transfer Orders

`GET /inventory/warehouse-transfer-orders`

Group: Inventory › Warehouse Transfer Orders · Operation ID: `warehouseTransferOrders`

Returns a list of warehouse transfer orders. To filter by item, use POST inventory/warehouse-transfer-orders/search.

The warehouse transfer order collection returns headers only. lines is a collection field and cannot be expressed here, so the collection returns lineCount and openLineCount instead. Every other field matches GET inventory/warehouse-transfer-orders/:id. To filter by item, use POST inventory/warehouse-transfer-orders/search, which returns the lines.

openLineCount is how much of the order is still open. Zero means every line has been taken by a transfer, and on a draft order it equals lineCount.

The warehouse names and referenceNumber are returned but cannot be filtered or ordered on. entityId can be filtered, so a collection can be scoped to one legal entity.

[Open in the interactive reference](https://docs.api.lensing.ai/?op=warehouseTransferOrders)

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Api-Version` | header | `"v1"` | yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`. |

## Query surface

- `id` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `documentNumber` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `documentStatus` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `documentDate` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `entityId` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `locationId` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `targetLocationId` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `lastModifiedDate` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- Orderable: id, documentNumber, documentDate, documentStatus, createdDate, lastModifiedDate
- Selectable: id, documentNumber, documentStatus, documentDate, referenceNumber, entityId, entityName, locationId, locationCode, locationName, targetLocationId, targetLocationCode, targetLocationName, notes, lineCount, openLineCount, createdDate, lastModifiedDate

## Response

`200` Success

Under `data`, an array of warehouseTransferOrdersRow:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | no | The unique identifier for the transfer order. |
| `documentNumber` | string or null | no | The transfer order's number, for example 'WTO-1043'. |
| `documentStatus` | string | no | The status of the transfer order, computed from the lines and set by no endpoint directly. Possible values: 'DRAFT', 'IN_TRANSFER', 'PARTIALLY_PROCESSED', 'PROCESSED'. 'DRAFT' while the order is being written, 'IN_TRANSFER' while a transfer created from it has yet to commit, 'PARTIALLY_PROCESSED' once a transfer has moved part of what was asked for and a remainder is still open, and 'PROCESSED' once nothing is open. |
| `documentDate` | string (date) or null | no | The date the transfer order is dated. Format YYYY-MM-DD. |
| `referenceNumber` | string or null | no | Your own reference on the transfer order. |
| `entityId` | string or null | no | The legal entity the transfer order belongs to. See id on GET base/entities. |
| `entityName` | string or null | no | The name of that legal entity. |
| `locationId` | string or null | no | The warehouse the goods leave, where the order names one for the whole document. A line may name its own. See id on GET inventory/warehouses/:id. |
| `locationCode` | string or null | no | The code of that warehouse. |
| `locationName` | string or null | no | The name of that warehouse. |
| `targetLocationId` | string or null | no | The warehouse the goods go to. See id on GET inventory/warehouses/:id. |
| `targetLocationCode` | string or null | no | The code of that warehouse. |
| `targetLocationName` | string or null | no | The name of that warehouse. |
| `notes` | string or null | no | Free text on the document. |
| `lineCount` | number or null | no | The number of lines on the transfer order. |
| `openLineCount` | number or null | no | How many lines still have quantity left to transfer. Zero means everything has been taken. |
| `createdDate` | string (date-time) or null | no | The date and time the transfer order was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
| `lastModifiedDate` | string (date-time) or null | no | The date and time the transfer order record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |

## Statuses

- `400` — Invalid request or business failure
- `401` — Missing or invalid access token
- `403` — Not authorized
- `404` — Not found
- `429` — Too many requests
- `500` — Internal server error