---
title: "List Transfer Orders"
method: GET
path: "/transfer-orders"
tags: ["transfer_order"]
---

# List Transfer Orders

`GET /transfer-orders`

## Request

- Base URL: `https://app.zenventory.com/rest`
- URL: `https://app.zenventory.com/rest/transfer-orders`
- Auth: none declared

Get a list of transfer orders based on search parameters.

## Query parameters

- `open` boolean
- `completed` boolean
- `draft` boolean
- `cancelled` boolean
- `deleted` boolean
- `originWarehouseId` integer
- `originWarehouseName` string
- `destinationWarehouseId` integer
- `destinationWarehouseName` string
- `createdTo` string, date-time
- `createdFrom` string, date-time
- `requiredByTo` string, date-time
- `requiredByFrom` string, date-time
- `orderBy` '' | 'id' | 'originWarehouse' | 'destinationWarehouse' | 'createdDate' | 'requiredByDate'
- `orderDir` 'asc' | 'desc'
- `page` integer
- `perPage` integer

## Response `200`

Success

- TransferOrderList
  - `transferOrders` TransferOrder[]
    - `id` integer
    - `originWarehouse` WarehouseCompact
      - `id` integer
      - `name` string
    - `destinationWarehouse` WarehouseCompact
      - `id` integer
      - `name` string
    - `draft` boolean
    - `completed` boolean
    - `requiredBy` string, date-time
    - `createdDate` string, date-time
    - `preparedBy` UserCompact
      - `id` integer
      - `name` string
    - `preparedDate` string, date-time
    - `shipVia` string
    - `deleted` boolean
    - `deletedBy` UserCompact
      - `id` integer
      - `name` string
    - `deletedDate` string, date-time
    - `cancelled` boolean
    - `cancelledBy` UserCompact
      - `id` integer
      - `name` string
    - `cancelledDate` string, date-time
    - `cancelledReason` string
    - `notes` string
    - `tags` Tag[]
      - `id` integer
      - `tag` string
      - `note` string
    - `items` TransferOrderItem[]
      - `id` integer
      - `itemId` integer
      - `sku` string
      - `description` string
      - `quantity` integer
      - `uom` string
      - `allocatedQuantity` integer
      - `pickedQuantity` integer
      - `deliveredQuantity` integer
  - `meta` PaginationMeta
    - `count` integer: Total number of objects in the result set.
    - `page` integer: The page of the result set in the response.
    - `perPage` integer: Number of objects per page.
    - `totalPages` integer: Total number of pages in the result set.

---

[API](https://skmtc.dev/zenventory/apis/zenventory-rest-api.md) · [All operations](https://skmtc.dev/zenventory/apis/zenventory-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zenventory/apis/zenventory-rest-api/revisions/b40aa340773b?raw)
