Docs
Get Order
GET /orders/{orderId}
GET
/orders/{orderId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Returns full detail for a single order, including billing and delivery information, line item groups, and all line items with their asset data.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| orderId | Guid | Required | The ID of the order. Replace `{{orderId}}` in the URL. |
Response
| Field | Type | Description |
|---|---|---|
| id | Guid | Order ID. |
| name | string | Order name. |
| status | string | Current status. |
| internalNotes | string | Internal-facing notes. |
| externalNotes | string | External/vendor-facing notes. |
| isDelivery | bool | Whether this order requires delivery. |
| startDateTime | DateTime| null | Order start date/time. |
| endDateTime | DateTime| null | Order end date/time. |
| billingInformation | Billing | Billing contact and address details. |
| billingInformation.name | string | Billing contact name. |
| billingInformation.company | string | Company name. |
| billingInformation.email | string | Email. |
| billingInformation.phone | string | Phone. |
| billingInformation.address | string | Street address. |
| billingInformation.city | string | City. |
| billingInformation.state | string | State/province. |
| billingInformation.country | string | Country. |
| billingInformation.postalCode | string | Postal/ZIP code. |
| deliveryInformation | Delivery | Delivery address details. Same shape as `billingInformation`. |
| lineItemGroups | LineItemGroup[] | Groups that organize line items within the order. |
| lineItemGroups[].id | Guid | Group ID. |
| lineItemGroups[].name | string | Group name. |
| lineItemGroups[].notes | string | Group-level notes. |
| lineItemGroups[].index | int | Sort order. |
| lineItemGroups[].isDelivery | bool | Whether this group has its own delivery details. |
| lineItemGroups[].startDateTime | DateTime| null | Group start date/time. |
| lineItemGroups[].endDateTime | DateTime| null | Group end date/time. |
| lineItemGroups[].deliveryInformation | Delivery | Group-level delivery details if `isDelivery` is true. |
| lineItems | LineItem[] | All line items on the order. |
| lineItems[].id | Guid | Line item ID. |
| lineItems[].index | int | Sort order. |
| lineItems[].quantity | int | Quantity. |
| lineItems[].lineItemGroupId | Guid | The group this line item belongs to. |
| lineItems[].asset | ProcAsset | The procurement asset for this line item. |
| lineItems[].asset.procurementId | Guid | Parent procurement ID. |
| lineItems[].asset.id | Guid | Asset ID. |
| lineItems[].asset.type | object | Asset type (`{ id, label, icon, lineItemLabel }`). |
| lineItems[].asset.subAssets | SubAsset[] | Sub-assets, each with their own `properties`. |
| lineItems[].asset.properties | Property[] | Asset properties (`{ id, templatePropertyId, value }`). |