Get Purchase Order

GET

/api/v1/purchase-orders/:id

GET

/api/v1/purchase-orders/:id

$ curl https://api.getply.com/api/v1/purchase-orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
>      -H "API_KEY: <apiKey>"

1 {
2   "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3   "itemCount": 1,
4   "assignedUserIds": [
5     "e1f2a3b4-c5d6-7890-efab-901234567890"
6   ],
7   "orderNumber": "PO-1042",
8   "status": "DRAFT",
9   "type": "STANDARD",
10   "totalCost": 1250,
11   "subtotal": 1250,
12   "note": "Please ship to back warehouse entrance.",
13   "supplier": {
14     "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
15     "name": "Acme Supply Co."
16   },
17   "location": {
18     "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
19     "name": "Main Warehouse"
20   },
21   "dueDate": "2026-04-15",
22   "receivedAt": null,
23   "createdAt": "2026-03-20T14:30:00Z",
24   "updatedAt": "2026-03-20T14:30:00Z"
25 }

Returns a single purchase order by ID.

Requires scope: purchase_orders:read

Authentication

API_KEYstring

API Key authentication via header

Path parameters

idUUIDRequired

Purchase order ID.

Response

This endpoint returns an object.

idUUID

Unique identifier for the purchase order.

itemCountinteger

Number of line items in this purchase order.

assignedUserIdslist of UUIDs

IDs of users assigned to this purchase order.

orderNumberstring

Human-readable order reference number (e.g. PO-1042).

statusenum

Current lifecycle status of the purchase order.

typestring

Optional classification tag for the order (e.g. STANDARD, EMERGENCY).

totalCostdouble

Grand total cost of all items in USD.

subtotaldouble

Subtotal before any adjustments in USD.

notestring

Free-text note for the supplier.

supplierobject

Reference to the supplier for this order.

locationobject

Reference to the destination location.

dueDatedate

ISO 8601 date when the order is expected (e.g. 2026-04-15).

receivedAtdatetime

ISO 8601 timestamp when the order was marked received. null if not yet received.

createdAtdatetime

ISO 8601 timestamp when the record was created.

updatedAtdatetime

ISO 8601 timestamp when the record was last updated.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error