Skip to content

Get a fulfillment line

Hospitality module

GET/fulfillment-lines/{id}fulfillmentLines.get

A line of a fulfillment. Returns one fulfillment line with its `ETag`. A fulfillment 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

fulfillmentLines.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the fulfillment line.
fieldsFieldsNoSparse 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: FulfillmentLine

fulfillmentLines.get: FulfillmentLine
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the fulfillment line.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
fulfillment_idstring (uuid)YesIdentifier of the fulfillment.
descriptionstringYesLine description.Constraints: length 1 to 300
quantitynumberYesQuantity.
unit_price_minorinteger (int64) | nullYesUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullYesISO 4217 currency of the price; required when the line is priced.Constraints: pattern ^[A-Z]{3}$
person_idstring (uuid) | nullYesIdentifier of the guest the line is for, such as a room night.
{
  "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",
  "fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "King room, 3 nights",
  "quantity": 4,
  "unit_price_minor": 32900,
  "currency_code": "USD",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X GET "$XOS_BASE_URL/fulfillment-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.fulfillmentLines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.fulfillment_lines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos fulfillment-lines get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f