Read a purchase order

Admin, branch manager, or auditor. Returns one order with its items and agreed unit costs. An unknown order id is refused with 404 rather than answered with an empty document.

GET/api/v1/purchase-orders/{purchaseOrderId}

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Path parameters

purchaseOrderIdstringrequired

The purchase order id.

Responses

200

The purchase order and its items

idstringrequired

supplier_idstringrequired

branch_idstringrequired

statusstringrequired

expected_datestring | nullrequired

notesstringrequired

created_bystringrequired

created_atstringrequired

updated_atstringrequired

supplier_namestringrequired

branch_namestringrequired

created_by_namestringrequired

item_countinteger

min -9007199254740991 · max 9007199254740991

itemsobject[]required

Show properties

Array of object

idstringrequired

po_idstringrequired

medicine_idstringrequired

ordered_qtyintegerrequired

min -9007199254740991 · max 9007199254740991

agreed_unit_coststringrequired

medicine_namestringrequired

401

Not authenticated

detailstringrequired

403

Access forbidden for this role

detailstringrequired

404

PO not found

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

purchaseOrderIdpath*The purchase order id.

Request

curl -X GET 'http://localhost:8000/api/v1/purchase-orders/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/purchase-orders/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/purchase-orders/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "id": "string",
  "supplier_id": "string",
  "branch_id": "string",
  "status": "string",
  "expected_date": "string",
  "notes": "string",
  "created_by": "string",
  "created_at": "string",
  "updated_at": "string",
  "supplier_name": "string",
  "branch_name": "string",
  "created_by_name": "string",
  "item_count": -9007199254740991,
  "items": [
    {
      "id": "string",
      "po_id": "string",
      "medicine_id": "string",
      "ordered_qty": -9007199254740991,
      "agreed_unit_cost": "string",
      "medicine_name": "string"
    }
  ]
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}