purchase_order

List Purchase Orders

Get a list of purchase orders based on search parameters.

get/purchase-orders

Request

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

Query parameters

orderNumberstring

Search for purchase orders with exactly or partially matching order number.

warehouseIdinteger

Id of the warehouse the purchase orders are for.

warehouseNamestring

Name of the warehouse the purchase orders are for. Ignored if warehouseId is provided.

supplierIdinteger

Id of the supplier the purchase orders are for.

supplierNamestring

Name of the supplier the purchase orders are for. Ignored if supplierId is provided.

clientIdinteger

Id of the client the purchase orders are for.

clientNamestring

Name of the client the purchase orders are for. Ignored if clientId is provided and is nonzero.

openboolean

True to filter for open purchase orders.

completedboolean

True to filter for completed purchase orders.

draftboolean

True to filter for draft purchase orders.

deletedboolean

True to filter for deleted purchase orders.

createdFromstring date-time

Get purchase orders created at or after this time.

createdTostring date-time

Get purchase orders created at or before this time.

orderBy'' | 'id' | 'orderNumber' | 'createdDate' | 'preparedDate' | 'requiredByDate' | 'userField1' | 'userField2' | 'userField3'

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

{
  "purchaseOrders": [
    {
      "id": 333,
      "orderNumber": "PO#375",
      "supplier": {
        "id": 35,
        "name": "Gift"
      },
      "warehouse": {
        "id": 1,
        "name": "Main Warehouse"
      },
      "client": "name",
      "user": {
        "id": 1,
        "name": "Mr Sparks"
      },
      "draft": true,
      "completed": false,
      "deleted": false,
      "createdDate": "20220-12-02T10:24:26-07:00",
      "preparedDate": "",
      "requiredByDate": "2020-12-02",
      "projectNumber": "",
      "notes": "",
      "shipMethod": "",
      "terms": "",
      "userField1": "",
      "userField2": "",
      "userField3": "",
      "items": [
        {
          "id": 456,
          "itemId": 2306,
          "sku": "FumoFumo-002",
          "description": "Marisa Kirisame",
          "quantity": 10,
          "uom": "Each",
          "unitCost": 20
        },
        {
          "id": 457,
          "itemId": 2330,
          "sku": "FumoFumo-006",
          "description": "Alice Margatroid",
          "quantity": 10,
          "uom": "Each",
          "unitCost": 20
        }
      ]
    },
    {
      "id": 334,
      "orderNumber": "PO#376",
      "supplier": {
        "id": 35,
        "name": "Gift"
      },
      "warehouse": {
        "id": 1,
        "name": "Main Warehouse"
      },
      "client": "name",
      "user": {
        "id": 1,
        "name": "Mr Sparks"
      },
      "draft": true,
      "completed": false,
      "deleted": false,
      "createdDate": "20220-12-04T12:09:37-07:00",
      "preparedDate": "",
      "requiredByDate": "2020-12-05",
      "projectNumber": "",
      "notes": "",
      "shipMethod": "",
      "terms": "",
      "userField1": "",
      "userField2": "",
      "userField3": "",
      "items": [
        {
          "id": 458,
          "itemId": 2305,
          "sku": "FumoFumo-001",
          "description": "Reimu Hakurei",
          "quantity": 10,
          "uom": "Each",
          "unitCost": 20
        },
        {
          "id": 459,
          "itemId": 2308,
          "sku": "FumoFumo-004",
          "description": "Remilia Scarlet",
          "quantity": 5,
          "uom": "Each",
          "unitCost": 20
        }
      ]
    },
    "..."
  ],
  "meta": {
    "count": 70,
    "page": 1,
    "perPage": 20,
    "totalPages": 4
  }
}

Changes

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