# Maple Docs

> Complete guide for setting up and managing your Maple voice AI and order management system

## Docs

- [Introduction](https://docs.maple.inc/index.md): Welcome to the Maple documentation
- [Quickstart](https://docs.maple.inc/quickstart.md): Get your Maple voice AI up and running in 15 minutes
- [Complete your Onboarding](https://docs.maple.inc/onboarding.md): Setting Up Your Maple Agent
- [Maple Dashboard Overview](https://docs.maple.inc/dashboard-overview.md): A complete walkthrough of your Maple dashboard — what's where and how to use it.
- [Going Live](https://docs.maple.inc/going-live.md): Test your agent, then switch on call forwarding to launch Maple.
- [Need Help?](https://docs.maple.inc/need-help.md)
- [Maple Voice Core Overview](https://docs.maple.inc/voice-core/overview.md): Understand the foundation of your Maple voice AI system
- [FAQ Setup](https://docs.maple.inc/voice-core/faqs.md): Configure FAQs to train your voice AI
- [Store Hours Configuration](https://docs.maple.inc/voice-core/store-hours.md): Set your operating hours and special schedules
- [Voice Configuration](https://docs.maple.inc/voice-core/voice-configuration.md): Customize your AI voice personality and settings
- [Getting a Phone Number](https://docs.maple.inc/voice-core/phone/getting-number.md): Acquire a new phone number for your Maple voice AI
- [Porting Your Phone Number](https://docs.maple.inc/voice-core/phone/porting.md): Transfer your existing phone number to Maple
- [SMS A2P Registration](https://docs.maple.inc/voice-core/sms-a2p.md): Enable SMS messaging for your Maple number
- [Maple Voice Core FAQ](https://docs.maple.inc/voice-core/faq.md): Common questions about Maple Voice Core features
- [Orders Module Overview](https://docs.maple.inc/orders/overview.md): Enable automated order-taking via phone and SMS with POS integration
- [Orders Module Prerequisites](https://docs.maple.inc/orders/prerequisites.md): Requirements before enabling order taking
- [POS Integration Overview](https://docs.maple.inc/orders/pos/overview.md): Select the right integration path for your restaurant
- [Toast](https://docs.maple.inc/orders/pos/toast.md): Connect Maple to your Toast POS system for automatic order processing
- [Square](https://docs.maple.inc/orders/pos/square.md): Connect Maple to your Square POS system
- [Clover](https://docs.maple.inc/orders/pos/clover.md): Connect Maple to your Clover POS system
- [SpotOn](https://docs.maple.inc/orders/pos/spoton.md): Connect Maple to your SpotOn POS system for automatic order processing
- [Smile](https://docs.maple.inc/orders/pos/smile.md): Connect Maple to your Smile POS system
- [SkyTab by Shift4](https://docs.maple.inc/orders/pos/skytab.md): Connect Maple to your SkyTab POS system
- [NCR Aloha](https://docs.maple.inc/orders/pos/ncr-aloha.md): Connect Maple to your NCR Aloha Cloud POS system
- [NCR Voyix](https://docs.maple.inc/orders/pos/ncr-voyix.md): Connect Maple to your NCR Aloha Essentials POS system
- [Quantic](https://docs.maple.inc/orders/pos/quantic.md): Connect Maple to your Quantic or Pixl POS system
- [Qu](https://docs.maple.inc/orders/pos/qu.md): Connect Maple to your Qu POS system
- [Genius](https://docs.maple.inc/orders/pos/genius.md): Connect Maple to your Genius (Heartland Restaurant) POS system
- [Tray](https://docs.maple.inc/orders/pos/tray.md): Connect Maple to your Tray POS system for automatic order processing
- [Chowbus](https://docs.maple.inc/orders/pos/chowbus.md): Connect Maple to your Chowbus POS system for automatic order processing
- [Manual Setup (No POS)](https://docs.maple.inc/orders/pos/manual-setup.md): Configure order taking without POS integration
- [Payment Methods Configuration](https://docs.maple.inc/orders/config/payment-methods.md): Set up payment processing for orders
- [Delivery Configuration](https://docs.maple.inc/orders/config/delivery.md): Set up delivery zones, fees, and providers for your restaurant
- [Menu Management](https://docs.maple.inc/orders/config/menu-management.md): Manage your menu for order taking
- [Orders Module FAQ](https://docs.maple.inc/orders/faq.md): Common questions about order taking features
- [Bookings Module](https://docs.maple.inc/bookings/overview.md): AI-powered table booking management through voice and SMS
- [Developer API](https://docs.maple.inc/developer-api/overview.md): Connect your POS or platform to Maple — receive and decide orders, publish menus, and subscribe to signed webhooks.
- [Quickstart](https://docs.maple.inc/developer-api/quickstart.md): From a test API key to a verified webhook delivery in about ten minutes.
- [How Maple works](https://docs.maple.inc/developer-api/how-maple-works.md): The objects and relationships behind every integration — apps, locations, connections, and the division of responsibility between you and Maple.
- [Receive and decide orders](https://docs.maple.inc/developer-api/guides/receive-orders.md): Build the order loop: connect a location, subscribe to webhooks, verify deliveries, and drive each order with accept, deny, ready, and complete calls.
- [Order lifecycle](https://docs.maple.inc/developer-api/concepts/order-lifecycle.md): Every status an order moves through, how your decisions drive it, and the fulfillment and payment fields it carries.
- [Publish a menu](https://docs.maple.inc/developer-api/guides/publish-menu.md): Send a location’s full menu as one JSON document keyed by your own stable IDs, then read it back. Publishing is a diff, so re-publishing is safe.
- [The menu model](https://docs.maple.inc/developer-api/concepts/the-menu-model.md): How a Maple menu is structured, how to map your own catalog onto it, and the rules that prevent wrong assumptions.
- [Menu recipes](https://docs.maple.inc/developer-api/guides/menu-recipes.md): Worked menu fragments for the scenarios real restaurants need — multi-select modifiers, nested choices, dayparted specials, and happy-hour discounts.
- [Authentication](https://docs.maple.inc/developer-api/concepts/authentication.md): Every request carries a Bearer API key. The key selects the environment and carries the scopes your app holds.
- [Environments and test mode](https://docs.maple.inc/developer-api/concepts/environments.md): Two environments, each with its own host. Build against the sandbox, then point at production to go live.
- [Organizations, merchants, and locations](https://docs.maple.inc/developer-api/concepts/entities.md): How Maple structures the businesses you integrate with — and why the Developer API works at the location level.
- [Webhooks](https://docs.maple.inc/developer-api/concepts/webhooks.md): Subscribe to event types, verify HMAC-signed deliveries, dedupe at-least-once delivery, and replay from the event ledger.
- [Money and amounts](https://docs.maple.inc/developer-api/concepts/money.md): Every amount in the API is an integer in the currency’s minor units. No floats, no rounding surprises.
- [Errors](https://docs.maple.inc/developer-api/concepts/errors.md): Standard HTTP status codes with a JSON body carrying a stable machine-readable tag and a human-readable message.
- [Idempotency and replay safety](https://docs.maple.inc/developer-api/concepts/idempotency.md): How Maple makes retries safe without an idempotency key — replay-safe decisions, diff-applied menus, idempotent replay, and dedupe on your side.
- [End-to-end example](https://docs.maple.inc/developer-api/guides/end-to-end-order.md): A complete walkthrough from sandbox key to a fulfilled order, in one place.
- [Conventions](https://docs.maple.inc/developer-api/api-reference.md): Base URL, resource conventions, IDs, money, and list behavior shared across every Developer API endpoint.
- [Webhook events](https://docs.maple.inc/developer-api/webhook-events.md): The catalog of webhook event types and the payload each one carries.
- [Developer API status](https://docs.maple.inc/api-reference/general/developer-api-status.md): Unauthenticated readiness probe for the Developer API.
- [Current app](https://docs.maple.inc/api-reference/general/current-app.md): Returns the developer app and effective scopes for the authenticated credential.
- [List locations](https://docs.maple.inc/api-reference/locations/list-locations.md): Lists the locations the authenticated app has been granted access to.
- [Get location](https://docs.maple.inc/api-reference/locations/get-location.md): Returns a single location the authenticated app has been granted access to.
- [Get connection](https://docs.maple.inc/api-reference/connections/get-connection.md): Returns the app's connection to a granted location, if one exists.
- [Create connection](https://docs.maple.inc/api-reference/connections/create-connection.md): Connects the app to a granted location as its POS receiver, provisioning and activating the integration.
- [Delete connection](https://docs.maple.inc/api-reference/connections/delete-connection.md): Disconnects the app from a location, removing the Developer API connection (the location can then be connected to a different POS).
- [Get location menu](https://docs.maple.inc/api-reference/menu/get-location-menu.md): The location's current published menu: categories, items, and variations (prices in integer minor units), shared modifier groups, and tax/fee/discount definitions. Every object echoes the `externalId` you published it under. Requires `menus:read` and an active connection to the location.
- [Publish location menu](https://docs.maple.inc/api-reference/menu/publish-location-menu.md): Publishes the full menu document for a connected location. Validation is all-or-nothing (a 400 lists every issue); the document is applied as a diff against the current menu, so an identical re-publish is a no-op and object identities stay stable across publishes by their `externalId`. Returns the r…
- [List webhook event types](https://docs.maple.inc/api-reference/webhooks/list-webhook-event-types.md): Lists the event types a webhook subscription can subscribe to.
- [List webhook subscriptions](https://docs.maple.inc/api-reference/webhooks/list-webhook-subscriptions.md): Lists the app's webhook subscriptions in the credential's environment.
- [Create webhook subscription](https://docs.maple.inc/api-reference/webhooks/create-webhook-subscription.md): Subscribes a notification URL to event types. Returns the HMAC signing secret once.
- [Get webhook subscription](https://docs.maple.inc/api-reference/webhooks/get-webhook-subscription.md): Retrieves a single webhook subscription owned by the app.
- [Delete webhook subscription](https://docs.maple.inc/api-reference/webhooks/delete-webhook-subscription.md): Permanently deletes the subscription; pending deliveries are abandoned.
- [Update webhook subscription](https://docs.maple.inc/api-reference/webhooks/update-webhook-subscription.md): Updates the notification URL, subscribed event types, or enabled/disabled status. The signing secret is unchanged.
- [Send test webhook](https://docs.maple.inc/api-reference/webhooks/send-test-webhook.md): Delivers a synthetic `webhook.test` event to the subscription and returns the delivery result.
- [List webhook events](https://docs.maple.inc/api-reference/webhooks/list-webhook-events.md): The app's event ledger (most recent first, up to 50). Useful for reconciliation and debugging missed deliveries.
- [Get webhook event](https://docs.maple.inc/api-reference/webhooks/get-webhook-event.md): Retrieves a single event from the ledger, including its `data` payload.
- [Replay webhook event](https://docs.maple.inc/api-reference/webhooks/replay-webhook-event.md): Re-delivers the event to currently-matching subscriptions, skipping any already delivered for this event (idempotent).
- [List orders](https://docs.maple.inc/api-reference/orders/list-orders.md): Lists the most recent orders (up to 100) for the locations the app is connected to as POS receiver; `has_more` indicates additional orders exist. Money is in integer cents; line-item modifiers reflect the directly-selected (first-level) options.
- [Get order](https://docs.maple.inc/api-reference/orders/get-order.md): Returns a single order if it belongs to a location the app is connected to.
- [Accept order](https://docs.maple.inc/api-reference/orders/accept-order.md): Partner accepts the order; the order is finalized and the customer confirmed.
- [Deny order](https://docs.maple.inc/api-reference/orders/deny-order.md): Partner rejects the order; it is rejected and any payment reversed.
- [Mark order ready](https://docs.maple.inc/api-reference/orders/mark-order-ready.md): Partner marks the order ready for pickup/handoff.
- [Complete order](https://docs.maple.inc/api-reference/orders/complete-order.md): Partner marks the order fulfilled.
- [Cancel order](https://docs.maple.inc/api-reference/orders/cancel-order.md): Partner cancels the order.
- [Update order status](https://docs.maple.inc/api-reference/orders/update-order-status.md): Partner reports an order status transition (e.g. ready, in delivery, fulfilled).
- [Submit order validation result](https://docs.maple.inc/api-reference/orders/submit-order-validation-result.md): Partner reports whether an order can be accepted (item availability, pricing feasibility, POS injectability). Echo the `validation_id` from the `order.validation_requested` event so the result is bound to that attempt — a result naming an expired/older attempt is rejected (404). A valid result lets…
- [Postman collection](https://docs.maple.inc/developer-api/postman.md): A ready-to-run Postman collection for the whole Developer API, with auth and request chaining wired up.
- [Changelog](https://docs.maple.inc/developer-api/changelog.md): Notable changes to the Maple Developer API.

## OpenAPI Specs

- [developer-api](https://docs.maple.inc/openapi/developer-api.json)

## Optional

- [Support](sms:+19295430229)
- [Dashboard](https://app.maple.inc)