Skip to main content
GET
/
inventory
/
purchase-orders
/
{id}
Get Purchase Order
curl --request GET \
  --url https://api.decodahealth.com/inventory/purchase-orders/{id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "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
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Path Parameters

​
id
string
required

Response

Successful Response

Purchase order response with computed lead time.

​
supplierId
string
required

ID of the supplier

​
id
string

Unique identifier for the purchase order

​
status
enum<string>
default:PENDING

Status of the purchase order

Available options:
PENDING,
PLACED,
COMPLETED,
CANCELLED
​
issueDate
string<date-time> | null

Date when the purchase order was sent to supplier

​
completedDate
string<date-time> | null

Date when all shipments are DELIVERED (purchase order completed)

​
supplier
Supplier · object

Optional supplier details

​
lineItems
PurchaseOrderLineItemWithDetails · object[] | null

Line items with details

​
notes
PurchaseOrderNote · object[] | null

Notes attached to this purchase order

​
createdDate
string<date-time> | null

Date and time the purchase order was created

​
updatedDate
string<date-time> | null

Date and time the purchase order was last updated

​
isArchived
boolean
default:false

Whether the purchase order is archived

​
leadTimeDays
integer | null

Maximum lead time in days across all line items (estimated delivery time from order placement)