v1
latestOpenAPI 3.1.02026-07-22155403592.5 KBProperty Management System
Orders
Get orders (PMS)
Returns a list of the orders
get/consumers/{consumer_id}/pms/orders
Path parameters
consumer_idstring uuid required
Query parameters
pageinteger
Page number
sizeinteger
Page size
date_fromstring date required
date_tostring date required
location_idstring nullable
state'consumed' | 'closed'
Response
Successful Response
Example response
{
"items": [
{
"id": "123",
"order_number": "1",
"creation_date": "2025-01-01T00:00:00Z",
"closing_date": "2025-01-01T00:00:00Z",
"service_date": "2025-01-01T00:00:00Z",
"device_id": "device-123",
"total": 11,
"tax_amount": 1,
"total_discount": 10,
"total_refund": 5,
"total_tip": 1,
"delivery_fee": 1,
"currency": "EUR",
"country": "FR",
"loyalty": 100,
"customer_id": "customer-123",
"location_id": "location-123",
"taxes": [
{
"tax_id": "371ca583-d218-4900-b236-397532cf0e39"
}
],
"guests": 1,
"items": [
{
"id": "123",
"menu_id": "456",
"quantity": 1,
"unit_price": 10,
"total": 11,
"tax_amount": 1,
"tax_rate": 10,
"tax_id": "371ca583-d218-4900-b236-397532cf0e39",
"description": "Pizza",
"discounts": [],
"product_id": "789",
"accounting_category_id": "123"
}
],
"reservation": {
"start_date": "2024-10-01T12:00:00",
"end_date": "2024-10-10T12:00:00",
"creation_date": "2024-09-25T12:00:00",
"resource_name": "Room 101",
"resource_identifier": "R101"
},
"bills": [
{
"invoice_number": "INV-12345",
"creation_date": "2023-10-01T12:00:00",
"closing_date": "2023-10-10T12:00:00",
"partners": [
{
"address": {
"address_type": "home",
"name": "Home",
"street": "Main Street",
"number": "123",
"box": "A",
"city": "Paris",
"postal_code": "75000",
"country": "FR"
},
"first_name": "John",
"last_name": "Doe",
"company_name": "Acme Corp"
}
]
}
]
}
]
}