# Atlas Help Center

- [Welcome to Atlas](https://help.atlas.kitchen/welcome-to-atlas.md): Delightful and easy restaurant tech.
- [Onboarding process](https://help.atlas.kitchen/get-started/onboarding.md): Get started with Atlas onboarding. Learn the setup process, hardware requirements, WiFi specs, and best practices for a smooth restaurant launch.
- [Install Atlas Merchant Portal](https://help.atlas.kitchen/get-started/installing-atlas.md): Add Atlas Merchant Portal as a home screen shortcut on your tablet for faster access. Works on Chrome and Safari browsers.
- [Set up Atlas to earn more](https://help.atlas.kitchen/get-started/sell-more.md): Boost restaurant revenue with aggregator integrations, loyalty rewards, cross-selling, and menu engineering best practices in Atlas.
- [How to use POS for QSR](https://help.atlas.kitchen/stations/pos.md): Accept payments in-store and show customers their order details.
- [How tips work on POS](https://help.atlas.kitchen/stations/pos-tips.md): How tipping works at the Atlas POS terminal, which payment types support it, and where tips appear in your reports and orders.
- [Set up the customer-facing display](https://help.atlas.kitchen/stations/customer-facing-display.md): Show customers their order, let them log in for rewards, and choose how they get their receipt.
- [How to create and charge Admin orders](https://help.atlas.kitchen/merchant-portal/admin-orders.md): Create and charge Admin orders in Atlas for delivery, pickup, or dine-in using payment links, terminals, or manual entry.
- [Update order details](https://help.atlas.kitchen/merchant-portal/editing-order.md): Edit order items, customer info, delivery addresses, and fulfilment type. Make changes via Atlas POS or Orders page with automatic logistics rebooking.
- [Process refunds on Atlas](https://help.atlas.kitchen/merchant-portal/refunds.md): Issue full or partial refunds for paid orders. Cancel orders, reopen for editing, or recharge with different payment methods via POS or Orders page.
- [Manage delivery drivers](https://help.atlas.kitchen/merchant-portal/delivery-rider-management.md): How Atlas Smart Logistics books and monitors drivers, what the statuses mean, how to book or cancel a driver, and what to do when there's a problem.
- [Add or remove payment types](https://help.atlas.kitchen/merchant-portal/payment-methods.md): Configure which payment types your business accepts at the POS, kiosk, and online — and set different payment types per outlet.
- [How to use the Stocks page](https://help.atlas.kitchen/merchant-portal/stocks.md): Manage restaurant stock in Atlas by blocking items, setting quantities, and syncing availability across all channels including aggregators.
- [How to use customers' data](https://help.atlas.kitchen/merchant-portal/customers-data.md): Access and export customer data, understand registered vs guest users, and use customer information for marketing campaigns.
- [Reports overview](https://help.atlas.kitchen/reports/overview.md): Find the right report for sales, operations, marketing, and finance data.
- [Using reports](https://help.atlas.kitchen/reports/using-reports.md): How to filter, export, and set up scheduled report deliveries.
- [Daily outlet report](https://help.atlas.kitchen/reports/operations/daily-outlet-report.md): Quick overview of sales for a single day.
- [Logistics report](https://help.atlas.kitchen/reports/operations/logistics-report.md): Atlas Smart Logistics trips and costs.
- [Production efficiency report](https://help.atlas.kitchen/reports/operations/production-efficiency-report.md): Track how long kitchen tickets take to complete.
- [Sales summary report](https://help.atlas.kitchen/reports/sales/sales-summary-report.md): Detailed breakdown of sales metrics including payments, discounts, and category performance.
- [Sales trends](https://help.atlas.kitchen/reports/sales/sales-trends.md): Track sales performance over time with period comparisons and breakdowns.
- [Product mix report](https://help.atlas.kitchen/reports/product/product-mix-report.md): Analyse product sales, quantities, and performance by category.
- [Discount report](https://help.atlas.kitchen/reports/marketing/discount-report.md): Track promo code usage, discount costs, and effectiveness.
- [Customers report](https://help.atlas.kitchen/reports/marketing/customers-report.md): Track customer segments, lifetime value, and retention.
- [Loyalty report](https://help.atlas.kitchen/reports/marketing/loyalty-report.md): Track loyalty program signups, points activity, and member value.
- [Payout report](https://help.atlas.kitchen/reports/finance/payout-report.md): Reconcile sales to payouts and trace payouts back to transactions.
- [Billing report](https://help.atlas.kitchen/reports/finance/billing-report.md): View subscriptions, invoices, and manage payment methods.
- [Why your sales and payout figures don't match](https://help.atlas.kitchen/reports/finance/sales-reconciliation.md): Reconcile your Atlas sales to the payout in your bank, and understand why your sales, payout, and P&L figures differ.
- [Legacy reports](https://help.atlas.kitchen/reports/legacy/overview.md): Reports being phased out by 1 June 2026 in favor of upgraded analytics-powered versions.
- [Discounts](https://help.atlas.kitchen/merchant-portal/add-discounts.md): Create and manage discounts and promo codes in Atlas to run promotions, reward loyal customers, and drive sales across all your ordering channels.
- [Discount use cases](https://help.atlas.kitchen/merchant-portal/discount-use-cases.md): Copy-and-use discount configs for 1-for-1 deals, happy hour, first-order promos, free delivery, loyalty rewards, and staff discounts.
- [Cross-sell](https://help.atlas.kitchen/merchant-portal/cross-sell.md): Configure cross-sell prompts to suggest complementary items during checkout and increase Average Order Value.
- [Announcements](https://help.atlas.kitchen/merchant-portal/announcements.md): Show a slim message strip at the top of your storefront to broadcast pricing notes, hours, promos, or operational updates.
- [Pop-ups](https://help.atlas.kitchen/merchant-portal/pop-ups.md): Configure pop-ups to display a marketing image to diners before they start ordering.
- [Atlas Loyalty](https://help.atlas.kitchen/merchant-portal/loyalty-signup.md): How your diners join Atlas Loyalty, earn rewards, and redeem them at your outlets.
- [Website look and feel](https://help.atlas.kitchen/merchant-portal/website-look-and-feel.md): Change your website banner, logo, colours, footer, loyalty programme appearance, and the look of your digital receipts.
- [How menus work](https://help.atlas.kitchen/menu-builder/overview.md): How Atlas organises menus, sections, products, and modifiers, and which parts can be shared across them.
- [Create and configure menus](https://help.atlas.kitchen/menu-builder/create-menus.md): Build Atlas menus with sections, products, and modifiers. Configure pricing, images, and customisation options for POS, online, and kiosk ordering.
- [Update item prices](https://help.atlas.kitchen/menu-builder/draft-update-prices.md): Change a single item's price, apply a pricing rule, or update many prices at once with a CSV upload.
- [Pricing rules](https://help.atlas.kitchen/menu-builder/pricing-rules.md): Set a different price for selected products on certain channels, without editing each item by hand.
- [Availability conditions](https://help.atlas.kitchen/menu-builder/availability-conditions.md): Control when and where your menu sections and products are available across outlets, dates, times, and fulfilment types.
- [Set up item routing and printers](https://help.atlas.kitchen/menu-builder/printer-routing.md): How Atlas decides which printer prints which item, how to set up your kitchen, bar, and counter printers, and how to fine-tune each receipt type.
- [Set up POS layouts](https://help.atlas.kitchen/menu-builder/pos-layout.md): Create and customise Atlas POS layouts. Add pages, configure product and discount tiles, and assign layouts to specific outlets for efficient ordering.
- [Set up and sync aggregator menus](https://help.atlas.kitchen/menu-builder/aggregator-menus.md): Run one Atlas menu across GrabFood and Foodpanda, keep it in sync, and avoid the changes that break a sync.
- [Reporting categories](https://help.atlas.kitchen/menu-builder/reporting-categories.md): Group products into categories to organise reports and target pricing rules.
- [Add operating hours and special hours](https://help.atlas.kitchen/merchant-portal/operating-hours.md): Set up regular restaurant hours and special hours for holidays. Control when customers can order for dine-in, pickup, and delivery across Atlas channels.
- [Outlet shifts](https://help.atlas.kitchen/merchant-portal/outlet-shifts.md): Create shifts for your outlet to track sales by time period and filter reports by shift.
- [BCRS (Beverage Container Return Scheme)](https://help.atlas.kitchen/merchant-portal/bcrs.md): Set up the $0.10 beverage container deposit on Atlas for Singapore's BCRS regulation.
- [Delivery settings, fees and minimum orders](https://help.atlas.kitchen/merchant-portal/delivery-fee-minimum-order.md): Set up delivery fees, free delivery thresholds, minimum order amounts, large-order lead time, and delivery logistics for your Atlas Online store.
- [Surcharges](https://help.atlas.kitchen/merchant-portal/surcharges.md): Add a temporary fee to orders for a specific period, outlet, or fulfilment type, as a fixed amount or a percentage.
- [Change the portal language](https://help.atlas.kitchen/merchant-portal/language-switcher.md): Switch the Atlas Merchant Portal interface between English and Chinese.
- [Reset POS PIN or portal password](https://help.atlas.kitchen/merchant-portal/reset-pin.md): Change your point-of-sale login PIN or reset your Atlas merchant portal password.
- [Team members and roles](https://help.atlas.kitchen/merchant-portal/team-management.md): Add staff accounts, set roles, assign outlet access, and set up POS pin codes from Settings > Team members.
- [Connect Atlas printer to WiFi](https://help.atlas.kitchen/hardware/printers.md): Connect Atlas receipt printers to WiFi network. Choose manual browser pairing or QR pairing with WeChat for wireless printer setup.
- [Troubleshooting Atlas Pay terminals](https://help.atlas.kitchen/hardware/terminal-troubleshooting.md): Fix an Atlas Pay card terminal that is frozen, not showing the payment amount, or has lost connection to the POS.
- [Update diners' phone number](https://help.atlas.kitchen/customer-guides/diners-phone-update.md): Guide for diners to update phone numbers on Atlas Online. Log in, recover access via email, update profile details, and verify changes.
- [Using SMS with Atlas and Customer.io](https://help.atlas.kitchen/guides/sms-with-customerio.md): Connect your own Twilio sender to Customer.io to send loyalty SMS, order confirmations, and one-time passcodes to your customers.
- [Set up Revel POS integration](https://help.atlas.kitchen/integrations/revel-setup.md): Integrate Atlas with Revel POS. Configure API keys, map menus and dining options, sync orders, and test the connection for seamless operations.
- [Connect OpenTable to Atlas](https://help.atlas.kitchen/integrations/opentable.md): Link OpenTable reservations to Atlas POS. Carts open automatically when guests are seated, and OpenTable receives live order and bill data.
- [Accept ShopBack payments](https://help.atlas.kitchen/integrations/shopback.md): Let customers pay with the ShopBack app at your POS and kiosk. They scan a QR code on your Atlas Pay terminal and earn cashback.
- [Introducing Atlas Connect](https://help.atlas.kitchen/connect/overview.md)
- [Authentication](https://help.atlas.kitchen/connect/storefront-api/authentication.md)
- [Checkout flow](https://help.atlas.kitchen/connect/storefront-api/checkout-flow.md)
- [Get channel](https://help.atlas.kitchen/connect/storefront-api/channel/get-channel.md): Returns merchant config, outlets with service hours, referral program, and point program. Creates a new session if `X-Session-Id` is not provided.
- [Get menus](https://help.atlas.kitchen/connect/storefront-api/menu/get-menus.md): Returns published menus with sections, products, and modifier groups.
- [Get timeslots](https://help.atlas.kitchen/connect/storefront-api/menu/get-timeslots.md)
- [Get availabilities](https://help.atlas.kitchen/connect/storefront-api/menu/get-availabilities.md): Returns hidden/disabled state for sections and items based on timeslot and fulfilment type.
- [Get stocks](https://help.atlas.kitchen/connect/storefront-api/menu/get-stocks.md): Returns available quantity per item for the outlet on the given date. Empty items object means unlimited stock.
- [Create cart](https://help.atlas.kitchen/connect/storefront-api/cart/create-cart.md): Creates a new cart for the session or returns the existing active cart. Cart starts without outlet or items.
- [Update cart](https://help.atlas.kitchen/connect/storefront-api/cart/update-cart.md): Set outlet, fulfilment type, timeslot, contact info, delivery address, gifting details.
- [Add item](https://help.atlas.kitchen/connect/storefront-api/cart/add-item.md): Add a menu item with optional modifiers (sub_items). Validates stock and modifier group constraints.
- [Update item](https://help.atlas.kitchen/connect/storefront-api/cart/update-item.md): Update quantity or notes. Cannot set quantity to 0 — use DELETE instead.
- [Remove item](https://help.atlas.kitchen/connect/storefront-api/cart/remove-item.md)
- [Apply promo](https://help.atlas.kitchen/connect/storefront-api/cart/apply-promo.md): Validates and applies a promotion to the cart. Only one promo per cart.
- [Clear promo](https://help.atlas.kitchen/connect/storefront-api/cart/clear-promo.md)
- [Toggle points](https://help.atlas.kitchen/connect/storefront-api/cart/toggle-points.md)
- [Payment breakdown](https://help.atlas.kitchen/connect/storefront-api/cart/payment-breakdown.md): Returns itemized charges including subtotal, tax, delivery fee, discounts, service charge, and points value.
- [Validate cart](https://help.atlas.kitchen/connect/storefront-api/cart/validate-cart.md): Validates stock, timeslots, minimum order value, etc. Returns a token for duplicate payment prevention.
- [Delivery outlets](https://help.atlas.kitchen/connect/storefront-api/cart/delivery-outlets.md): Only available when cart fulfilment_type is delivery.
- [Create payment intent](https://help.atlas.kitchen/connect/storefront-api/payment/create-payment-intent.md): Validates the cart and creates a payment intent with the payment processor. Returns an `atlas_pay_url` — redirect the diner there to complete payment.
- [Create order](https://help.atlas.kitchen/connect/storefront-api/order/create-order.md): **Call this after the diner completes payment and is redirected back.**
- [Authentication](https://help.atlas.kitchen/connect/admin-api/authentication.md)
- [Menu list](https://help.atlas.kitchen/connect/admin-api/menus/menu-list.md)
- [Menu details](https://help.atlas.kitchen/connect/admin-api/menus/menu-details.md): Returns full menu hierarchy with sections, items, modifier groups, and modifiers.
- [Menu create or update](https://help.atlas.kitchen/connect/admin-api/menus/menu-create-or-update.md): Upserts a menu by `identifier`. Creates a new menu if the identifier doesn't exist, or updates the existing one. The full hierarchy (sections, items, modifiers) is synced — orphaned records are removed.
- [Create order](https://help.atlas.kitchen/connect/admin-api/orders/create-order.md): Creates a new order for the given outlet and channel. Requires a configured channel link. Supports 3-level item nesting, multiple payments, and admin overrides for payment breakdown fields.
- [Order details](https://help.atlas.kitchen/connect/admin-api/orders/order-details.md)
- [Update order](https://help.atlas.kitchen/connect/admin-api/orders/update-order.md): Update order details including state, contact info, items, and payments. Supports `order_items_update_mode` and `order_payments_update_mode` for merge/replace behavior.
- [Order details (with identifier)](https://help.atlas.kitchen/connect/admin-api/orders/order-details-identifier.md)
- [Outlet stocks](https://help.atlas.kitchen/connect/admin-api/stocks/outlet-stocks.md): Returns available quantity per item for the outlet on the given date.
- [User sync](https://help.atlas.kitchen/connect/admin-api/users/user-sync.md): Upserts a user by email or mobile number. For non-guests, creates an Account and UserAccount relationship. External user links are immutable once created.
- [Tables](https://help.atlas.kitchen/connect/admin-api/tables/tables.md): Returns active tables for the outlet.
- [Create cart](https://help.atlas.kitchen/connect/admin-api/carts/create-cart.md): Creates a dine-in cart for a table with optional upfront payment. Always uses POS platform with DINE_IN fulfilment.
- [Cash voucher list](https://help.atlas.kitchen/connect/admin-api/cash-vouchers/cash-voucher-list.md): Lists cash vouchers for the merchant. Use `status` to filter active, expired, or redeemed vouchers, and `code` to search by voucher code.
- [Create cash voucher](https://help.atlas.kitchen/connect/admin-api/cash-vouchers/create-cash-voucher.md): Creates a prepaid cash voucher that staff can redeem through the existing POS cash voucher flow.
- [Cash voucher details](https://help.atlas.kitchen/connect/admin-api/cash-vouchers/cash-voucher-details.md)
- [Set up webhooks](https://help.atlas.kitchen/connect/webhooks/setup.md): Add an Atlas Connect webhook endpoint.
- [Events](https://help.atlas.kitchen/connect/webhooks/events.md): Event payloads sent by Atlas Connect webhooks.
- [Order events](https://help.atlas.kitchen/connect/webhooks/order-events.md): Order webhook payloads.
- [Customer events](https://help.atlas.kitchen/connect/webhooks/customer-events.md): Customer webhook payloads.
- [Outlet events](https://help.atlas.kitchen/connect/webhooks/outlet-events.md): Outlet webhook payloads.
- [Stock events](https://help.atlas.kitchen/connect/webhooks/stock-events.md): Stock webhook payloads.
- [Cart events](https://help.atlas.kitchen/connect/webhooks/cart-events.md): Cart webhook payloads.
- [Menu events](https://help.atlas.kitchen/connect/webhooks/menu-events.md): Menu webhook payloads.
- [Run Atlas from your AI assistant](https://help.atlas.kitchen/connect/mcp/overview.md): Connect Atlas to Claude or ChatGPT and manage your restaurant in plain language.
- [Set up Atlas in your assistant](https://help.atlas.kitchen/connect/mcp/setup.md): Connect Atlas to Claude, ChatGPT, Claude Code or Codex in about two minutes.
- [Quickstart](https://help.atlas.kitchen/connect/mcp/recipes.md): Copy-paste prompts that put your AI assistant to work on costs, allergens, cross-sells and modifiers.
- [Atlas AI use cases](https://help.atlas.kitchen/use-cases.md): Try these on the portal, or with Claude and ChatGPT.

## OpenAPI Specs

- [admin-v1](/specs/admin-v1.yaml)
- [storefront-v1](/specs/storefront-v1.yaml)