Get a BEO line
Hospitality module
GET/beo-lines/{id}beoLines.get
A line of a banquet event order. Returns one BEO line with its `ETag`. A BEO line the caller may not see returns 404.
- Requires the capability hospitality.fulfillment.read.
- OAuth scopes: hospitality.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the beo line. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: BeoLine
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the beo line. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| beo_id | string (uuid) | Yes | Identifier of the BEO. |
| description | string | Yes | Menu item or service.Constraints: length 1 to 300 |
| quantity | number | Yes | Quantity. |
| unit_price_minor | integer (int64) | null | Yes | Unit price. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | Yes | ISO 4217 currency of the price; required when the line is priced.Constraints: pattern ^[A-Z]{3}$ |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"beo_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "Grilled vegetable wraps",
"quantity": 140,
"unit_price_minor": 1450,
"currency_code": "USD"
}Code samples
curl -X GET "$XOS_BASE_URL/beo-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.beoLines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.beo_lines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos beo-lines get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f