Open Inventory / Docs
EndpointsPurchasingPurchase ordersOrderid

Retrieve one purchase order

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

GET
/purchase-orders/{orderId}

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

orderId*string
Formatuuid

Header Parameters

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Response Body

Purchase order

application/json
  1. response
order*
Example Request
curl -X GET 'https://inventory.example.com/api/v1/purchase-orders/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "order": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "reference": "string",    "supplier": "string",    "status": "draft",    "orderedAt": "2019-08-24T14:15:22Z",    "expectedAt": "2019-08-24T14:15:22Z",    "note": "string",    "createdBy": "string",    "lines": [      {        "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",        "orderedQuantity": 1,        "purchaseQuantity": 1,        "expectedAt": "2019-08-24T14:15:22Z",        "note": "string",        "unitPriceCents": 0,        "priceCurrency": "str",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "resourceName": "string",        "resourceSku": "string",        "resourceCurrency": "str",        "baseUnitName": "string",        "purchaseUnitName": "string",        "purchaseUnitFactor": 1,        "orderedPurchaseQuantity": 0,        "receivedPurchaseQuantity": 0,        "openPurchaseQuantity": 0,        "receivedQuantity": 0,        "openQuantity": 0,        "trackingMode": "bulk",        "totalPriceCents": 0      }    ],    "totalOrdered": 0,    "totalReceived": 0,    "totalOpen": 0  }}