transfer_order

List Transfer Orders

Get a list of transfer orders based on search parameters.

get/transfer-orders

Request

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

Query parameters

openboolean

True to filter for transfer orders that are not drafts, completed, deleted, or cancelled.

completedboolean

True to filter for transfer orders that have been completed.

draftboolean

True to filter for draft transfer orders.

cancelledboolean

True to filter for non-draft transfer orders that have been cancelled.

deletedboolean

True to filter for draft transfer orders that have been deleted.

originWarehouseIdinteger

Search for transfer orders originating from this warehouse.

originWarehouseNamestring

Search for transfer orders originating from this warehouse. Ignored if originWarehouseId is provided.

destinationWarehouseIdinteger

Search for transfer orders bound for this warehouse.

destinationWarehouseNamestring

Search for transfer orders bound for this warehouse. Ignored if destinationWarehouseId is provided.

createdTostring date-time

Search for transfer orders created at or after this time.

createdFromstring date-time

Search for transfer orders created at or before this time.

requiredByTostring date-time

Search for transfer orders that are required by at or after this time.

requiredByFromstring date-time

Search for transfer orders that are required by at or before this time.

orderBy'' | 'id' | 'originWarehouse' | 'destinationWarehouse' | 'createdDate' | 'requiredByDate'

Field to order results by.

orderDir'asc' | 'desc'

Direction to order the results by. Only used if orderBy is not an empty string.

pageinteger

Page number of the results to get.

perPageinteger

Page number of the results to get.

Response

Success

Example response

{
  "transferOrders": [
    {
      "id": 78,
      "originWarehouse": {
        "id": 1,
        "name": "Main Warehouse"
      },
      "destinationWarehouse": {
        "id": 2,
        "name": "Second Warehouse"
      },
      "draft": false,
      "completed": false,
      "requiredBy": "2023-07-30T12:00:00-07:00",
      "createdDate": "2023-07-26T16:36:47-07:00",
      "preparedBy": {
        "id": 1,
        "name": "Mr Sparks"
      },
      "preparedDate": "2023-07-26T17:23:18-07:00",
      "shipVia": "fedex_ground",
      "deleted": false,
      "deletedBy": null,
      "deletedDate": "",
      "cancelled": false,
      "cancelledBy": null,
      "cancelledDate": "",
      "cancelledReason": "",
      "notes": "Monthly transfer",
      "tags": [],
      "items": [
        {
          "id": 96,
          "itemId": 2330,
          "sku": "FumoFumo-006",
          "description": "Alice Margatroid",
          "quantity": 5,
          "uom": "each",
          "allocatedQuantity": 0,
          "pickedQuantity": 0,
          "deliveredQuantity": 0
        },
        {
          "id": 97,
          "itemId": 2306,
          "sku": "FumoFumo-002",
          "description": "Marisa Kirisame",
          "quantity": 5,
          "uom": "each",
          "allocatedQuantity": 0,
          "pickedQuantity": 0,
          "deliveredQuantity": 0
        }
      ]
    }
  ],
  "meta": {
    "count": 1,
    "page": 1,
    "perPage": 20,
    "totalPages": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.