Skip to content

List orders

Request

Retrieve purchase orders for the location using cursor pagination. Optional filters: status, patient ID, appointment ID. Results are ordered by creation time; use sortDir for ascending or descending order.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

Query
statusstring(?i)DRAFT|PENDING|CANCELED|SUBMITTED|VOID

Filter by order status

Enum:"DRAFT""PENDING""CANCELED""SUBMITTED""VOID"
Example:status=PENDING
patientIdinteger, (int64)

Filter by patient ID

Example:patientId=1234
appointmentIdinteger, (int64)

Filter by appointment ID

Example:appointmentId=5678
sortDirstring(?i)ASC|DESC

Sort direction for creation time

Default:"DESC"
Enum:"ASC""DESC"
cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20
Example:limit=20
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/order?status=PENDING&patientId=1234&appointmentId=5678&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Orders retrieved successfully

Bodyapplication/json
nextCursorstring

Opaque cursor for fetching the next page

ordersArray of objects(OrderDTO)

List of orders

Response
{
  "nextCursor": "string",
  "orders": [
    { … }
  ]
}