FoyerDevelopers

Generated · Live registry

orders tools

9 tools in this domain, generated from the running registry.

All tool domains

orders.list

read-only

List in-stay orders for this tenant, newest-first. Filter by stayId (per-stay folio drill-down) or status (pending/confirmed/delivered/cancelled). Read-only.

Input parameters

FieldTypeRequiredNotes
stayIdstringno
statusenumnoOne of: pending, confirmed, delivered, cancelled
limitintegernoDefault: 50

Output fields

FieldTypeRequiredNotes
ordersarray of objectyes
orders.idstringyes
orders.stayIdstringyes
orders.itemIdstringyes
orders.quantityintegeryes
orders.notestring · nullableyes
orders.statusenumyesOne of: pending, confirmed, delivered, cancelled
orders.folioLineIdstring · nullableyes
orders.orderedAtstringyes
orders.updatedAtstringyes

orders.listCatalog

read-only

Orders: list catalog. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
descriptionstring · nullableyes
priceCentsintegeryes
currencystringyes
categorystringyes
activebooleanyes
sortOrderintegeryes
createdAtstringyes

orders.listCatalogByToken

read-only

Orders: list catalog by token. Read-only query. See the input schema for argument details.

Input parameters

FieldTypeRequiredNotes
tokenstringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
namestringyes
descriptionstring · nullableyes
priceCentsintegeryes
currencystringyes
categorystringyes

orders.listOrders

read-only

Orders: list orders. Read-only query. See the input schema for argument details.

Input parameters

FieldTypeRequiredNotes
stayIdstringno
statusenumnoOne of: pending, confirmed, delivered, cancelled

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
stayIdstringyes
itemIdstringyes
quantityintegeryes
notestring · nullableyes
statusenumyesOne of: pending, confirmed, delivered, cancelled
folioLineIdstring · nullableyes
orderedAtstringyes
updatedAtstringyes

orders.placeOrderByToken

writes

Orders: place order by token. Mutation — changes data. See the input schema for argument details.

Input parameters

FieldTypeRequiredNotes
tokenstringyes
itemIdstringyes
quantityintegernoDefault: 1
notestringno

Output fields

FieldTypeRequiredNotes
idstringyes
folioLineIdstring · nullableyes

orders.place_order

writes

Place an in-stay order on behalf of a guest. Verifies the catalog item belongs to this tenant + is active, inserts the stay_orders row, then writes a folio_lines charge (VAT 19% for in-stay extras). Best-effort: if the folio insert fails the order still exists with folioLineId=NULL.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
itemIdstringyes
quantityintegernoDefault: 1
notestringno

Output fields

FieldTypeRequiredNotes
idstringyes
folioLineIdstring · nullableyes

orders.updateOrderStatus

writes

Advance a guest order's status (received / preparing / delivered).

Input parameters

FieldTypeRequiredNotes
idstringyes
statusenumyesOne of: confirmed, delivered, cancelled

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

orders.update_status

writesconfirm

Transition an order to confirmed / delivered / cancelled. Owner-only. Cancellation does NOT remove the associated folio_lines row — staff must reverse the charge manually if needed. Confirmation-gated.

Input parameters

FieldTypeRequiredNotes
idstringyes
statusenumyesOne of: confirmed, delivered, cancelled

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

orders.upsertCatalogItem

writes

Orders: upsert catalog item. Mutation — changes data. See the input schema for argument details.

Input parameters

FieldTypeRequiredNotes
idstringno
namestringyes
descriptionstringno
priceCentsintegeryes
currencystringnoDefault: "EUR"
categorystringnoDefault: "general"
activebooleannoDefault: true
sortOrderintegernoDefault: 0

Output fields

FieldTypeRequiredNotes
idstringyes