Mozrest Endpoints
These endpoints are exposed by Mozrest so POS systems can send order and check updates to the middleware. Mozrest forwards all updates to the connected RMS.
Environments
| Environment | Base URL |
|---|---|
| Sandbox | https://api-sandbox.mozrest.com/v1/pos |
| Production | https://api.mozrest.com/v1/pos |
All endpoint paths below are relative to these base URLs.
Create Order
When an order is opened in the POS and no matching reservation exists in the RMS, send it to Mozrest to create one.
POST /venue/{venueId}/order
Authorization: Bearer {api_key}
Content-Type: application/json
Payload
{
"id": "62ebe5e7210c83a0f3adf9d1",
"status": "open",
"tables": ["T12"],
"partySize": 2,
"checks": [
{
"checkNumber": "98766",
"status": "open",
"totalAmount": 150.00,
"tax": 12.00,
"tip": 20.00,
"discount": 10.00,
"paymentMethod": "card",
"items": [
{ "id": 1, "name": "Steak", "price": 40.00, "quantity": 2 },
{ "id": 2, "name": "Wine", "price": 70.00, "quantity": 1 }
]
}
]
}
Use
tables(array). ThetableIdfield is deprecated.
Response
{
"id": "fd30c18b-71fb-43f7-b895-34ab0b9ceced",
"status": "open"
}
Update Order
When an order is updated in the POS (items added, check modified), send the update to Mozrest.
PUT /venue/{venueId}/order/{orderId}
Authorization: Bearer {api_key}
Content-Type: application/json
{orderId} may be either the Mozrest order ID (returned when you created the order in Mozrest, or sent as id when Mozrest created the order in your POS) or your own POS-side order ID — Mozrest resolves both. The same applies to the Close and Void endpoints.
The payload uses the same structure as Create Order with updated values.
Response
{
"id": "fd30c18b-71fb-43f7-b895-34ab0b9ceced",
"status": "open"
}
Close Order
When an order is closed in the POS (guest has paid), send the final bill to Mozrest.
PUT /venue/{venueId}/order/{orderId}/close
Authorization: Bearer {api_key}
Content-Type: application/json
Payload
{
"id": "62ebe5e7210c83a0f3adf9d1",
"status": "closed",
"tables": ["T12"],
"partySize": 2,
"checks": [
{
"checkNumber": "98766",
"status": "closed",
"totalAmount": 150.00,
"tax": 12.00,
"tip": 20.00,
"discount": 10.00,
"paymentMethod": "card",
"items": []
}
]
}
Response
{
"id": "fd30c18b-71fb-43f7-b895-34ab0b9ceced",
"status": "closed"
}
Void Order
When an order is voided in the POS, notify Mozrest so the RMS is updated accordingly.
PUT /venue/{venueId}/order/{orderId}/void
Authorization: Bearer {api_key}
Content-Type: application/json
Payload
{
"id": "62ebe5e7210c83a0f3adf9d1",
"status": "void",
"tables": ["T12"],
"partySize": 2,
"checks": [
{
"checkNumber": "98766",
"status": "void",
"totalAmount": 150.00,
"tax": 12.00,
"tip": 20.00,
"discount": 10.00,
"paymentMethod": "card",
"items": []
}
]
}
Response
{
"id": "fd30c18b-71fb-43f7-b895-34ab0b9ceced",
"status": "void"
}