# xMenu API Doc

## Docs

- [Restaurant info](https://api-doc.xmenu.it/docs/en/account-info/restaurant-info.md): Returns main information about the restaurant account.
- [Subrestaurants list](https://api-doc.xmenu.it/docs/en/account-info/subrestaurants-list.md): Returns the list of subrestaurants (locations) associated with the restaurant account.
- [Apply coupon](https://api-doc.xmenu.it/docs/en/coupon-actions/coupon-apply.md): Validates and applies a coupon to an order, calculating the resulting discount
- [Generate coupon](https://api-doc.xmenu.it/docs/en/coupon-actions/coupon-generate.md): Generates a new coupon using a predefined generator configured in the restaurant backend
- [Customer list](https://api-doc.xmenu.it/docs/en/customer-registry/customer-list.md): Returns a paginated list of customers registered or with existing orders in xMenu.
- [Single customer](https://api-doc.xmenu.it/docs/en/customer-registry/single-customer.md): Returns detailed information about a specific customer identified by email or unique identifier.
- [Import menu](https://api-doc.xmenu.it/docs/en/menu-import/import.md): Import or update your menu structure including categories, products, and options.
- [List categories](https://api-doc.xmenu.it/docs/en/menu/categories-list.md): Returns a paginated list of menu categories for the specified restaurant.
- [Get category](https://api-doc.xmenu.it/docs/en/menu/category-get.md): Returns details of a single category by its unique identifier.
- [Get product](https://api-doc.xmenu.it/docs/en/menu/product-get.md): Returns details of a single product by its unique identifier.
- [List products](https://api-doc.xmenu.it/docs/en/menu/products-list.md): Returns a paginated list of products. You can retrieve all products for a restaurant or products from a specific category.
- [Order closure](https://api-doc.xmenu.it/docs/en/order-actions/order-close.md): Close and archive a completed order
- [Order confirmation](https://api-doc.xmenu.it/docs/en/order-actions/order-confirm.md): Confirms a pending order awaiting confirmation
- [Order creation](https://api-doc.xmenu.it/docs/en/order-create.md): Inserts a new order that appears immediately in the restaurant's incoming orders queue.
- [Pickup / delivery times](https://api-doc.xmenu.it/docs/en/order-pickup-delivery-times.md): Retrieval of available times for pickup at the location or home delivery
- [Delivery address validation](https://api-doc.xmenu.it/docs/en/order-validate-address.md): Validates a delivery address before order creation, confirming if the location is reachable and retrieving delivery zone information.
- [Single order](https://api-doc.xmenu.it/docs/en/orders-get.md): Retrieves complete details of a specific single order using its unique identifier.
- [Orders list](https://api-doc.xmenu.it/docs/en/orders-list.md): Retrieves a paginated list of restaurant orders. Orders can be filtered by date range.
- [API settings](https://api-doc.xmenu.it/docs/en/overview/api-settings.md): How to enable and configure API access
- [Authentication](https://api-doc.xmenu.it/docs/en/overview/authentication.md): API authentication methods and how to use them
- [Base URL](https://api-doc.xmenu.it/docs/en/overview/base-url.md): API base URL and test environment
- [Data types](https://api-doc.xmenu.it/docs/en/overview/data-types.md): Data types used in xMenu API documentation
- [General error codes](https://api-doc.xmenu.it/docs/en/overview/error-codes.md): Error codes common to all API requests
- [Introduction](https://api-doc.xmenu.it/docs/en/overview/introduction.md): Welcome to the xMenu API documentation
- [Webhook security](https://api-doc.xmenu.it/docs/en/overview/webhook-security.md): Validate webhook notifications to ensure they come from xMenu
- [Create notification](https://api-doc.xmenu.it/docs/en/push-notifications/push-notification-create.md): Creates a new reusable push notification for subsequent delivery. The created notification can be sent to all registered devices using the notification send endpoint.
- [Send notification](https://api-doc.xmenu.it/docs/en/push-notifications/push-notification-send.md): Sends a previously created push notification to all registered devices. The delivery occurs asynchronously after a successful API response. If the notification was created with a subrestaurant filter, it will only be sent to users of that location.
- [Send notification to customer](https://api-doc.xmenu.it/docs/en/push-send.md): Sends a push notification to a customer's registered devices. The customer must be registered in the xMenu app and have at least one active device.
- [Loyalty points movement](https://api-doc.xmenu.it/docs/en/webhooks/loyaltylog-created.md): Webhook triggered when a loyalty points movement is created
- [Order closure](https://api-doc.xmenu.it/docs/en/webhooks/order-closed.md): Webhook triggered when an order is archived
- [Order confirmed](https://api-doc.xmenu.it/docs/en/webhooks/order-confirmed.md): Webhook triggered when an order is confirmed by the restaurant
- [Order confirmation countdown started](https://api-doc.xmenu.it/docs/en/webhooks/order-countdown-started.md): Webhook triggered when the confirmation countdown begins
- [Delivery in progress](https://api-doc.xmenu.it/docs/en/webhooks/order-delivery-travelling.md): Webhook triggered when a delivery order is in transit
- [New order](https://api-doc.xmenu.it/docs/en/webhooks/order-new.md): Webhook triggered when a new order is received
- [Order ready for pickup](https://api-doc.xmenu.it/docs/en/webhooks/order-pickup-ready.md): Webhook triggered when an order is ready for customer pickup
- [Order not confirmed / rejected](https://api-doc.xmenu.it/docs/en/webhooks/order-timeout.md): Webhook triggered when an order is not confirmed in time or is rejected

## OpenAPI Specs

- [openapi-it](https://api-doc.xmenu.it/openapi-it.json)
- [openapi-en](https://api-doc.xmenu.it/openapi-en.json)