Skip to content

Get order by ID

Request

Retrieve a single purchase order for the location, including line items and subscriptions.

Security
PartnerApiKey and PartnerOAuth
Path
orderIdinteger, (int64)required

Order ID

Example:1234
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/order/1234' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Order retrieved successfully

Bodyapplication/json
appointmentIdinteger, (int64)

Appointment ID when applicable

Example:700
createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
idinteger, (int64)

Order ID

Example:1234
lineItemsArray of objects(OrderLineItemDTO)

Line items (present on single-order responses only)

locationIdinteger, (int64)

Location ID

Example:200
patientIdinteger, (int64)

Patient ID

Example:300
paymentCustomerIdinteger, (int64)

Payment customer ID

Example:400
statusstring

Order status

Enum:"DRAFT""PENDING""CANCELED""SUBMITTED""VOID"
Example:"PENDING"
updatedAtstring, (date-time)

Last update timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
Response
{
  "appointmentId": 700,
  "createdAt": "2025-01-15T14:00:00Z",
  "id": 1234,
  "lineItems": [
    { … }
  ],
  "locationId": 200,
  "patientId": 300,
  "paymentCustomerId": 400,
  "status": "PENDING",
  "updatedAt": "2025-01-15T14:00:00Z"
}