Skip to main content
GET
/
inventory
/
purchase-orders
/
list
List Purchase Orders
curl --request GET \
  --url https://api.decodahealth.com/inventory/purchase-orders/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "supplierId": "<string>",
      "id": "<string>",
      "status": "PENDING",
      "issueDate": "2023-11-07T05:31:56Z",
      "completedDate": "2023-11-07T05:31:56Z",
      "supplier": {
        "name": "<string>",
        "description": "<string>",
        "website": "<string>",
        "email": "<string>",
        "preferredContactMethod": "<string>",
        "phoneNumber": "<string>",
        "addressLineOne": "<string>",
        "addressLineTwo": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "shipmentTime": 123,
        "isArchived": false,
        "defaultNotes": [
          {
            "content": "<string>",
            "id": "<string>",
            "supplierId": "<string>",
            "name": "<string>"
          }
        ],
        "id": "<string>"
      },
      "lineItems": [
        {
          "supplierToStockUomId": "<string>",
          "locationId": "<string>",
          "quantity": 123,
          "id": "<string>",
          "purchaseOrderId": "<string>",
          "status": "PENDING",
          "quantityReceived": 1,
          "supplierToStockUom": {
            "supplierPartNumber": "<string>",
            "uom": "AMPOULES",
            "id": "<string>",
            "supplierToStockId": "<string>",
            "supplierToStock": {
              "supplierId": "<string>",
              "stockId": "<string>",
              "id": "<string>",
              "stock": {
                "name": "<string>",
                "unit": "AMPOULES",
                "id": "<string>",
                "description": "<string>",
                "notes": "<string>",
                "category": "<string>",
                "minStockLevel": 123,
                "isArchived": false
              }
            },
            "conversionFactor": 1,
            "isDefault": false,
            "displayLabel": "<string>",
            "price": 123,
            "leadTime": 1,
            "createdDate": "2023-11-07T05:31:56Z",
            "updatedDate": "2023-11-07T05:31:56Z",
            "isArchived": false
          },
          "location": {
            "id": "<string>",
            "name": "<string>",
            "isVirtual": true
          },
          "cost": 1,
          "createdDate": "2023-11-07T05:31:56Z",
          "updatedDate": "2023-11-07T05:31:56Z"
        }
      ],
      "notes": [
        {
          "content": "<string>",
          "id": "<string>",
          "purchaseOrderId": "<string>",
          "name": "<string>"
        }
      ],
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "isArchived": false,
      "leadTimeDays": 123
    }
  ],
  "total": 123
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
page
integer | null
​
per_page
integer | null
​
sort_by
string | null
​
sort_direction
enum<string> | null
Available options:
asc,
desc
​
location_id
string | null
​
ids
string[] | null

Optional list of IDs of the purchase orders

​
supplier_id
string | null

Optional ID of the supplier

​
status
enum<string> | null

Optional status of the purchase order The status of a purchase order.

Available options:
PENDING,
PLACED,
COMPLETED,
CANCELLED
​
is_archived
boolean | null

Optional archived status of the purchase order

Response

Successful Response

​
data
PurchaseOrderResponse · object[]
required
​
total
integer
required