# Crave Cloud Documentation
> Developer documentation for Crave Cloud, Crave.js, Storefront APIs, and restaurant franchise integrations.
## Docs
- [Crave Cloud Overview](https://docs.craveup.com/guides/crave-cloud-overview.md): How Crave Cloud connects franchise ordering, identity, loyalty, payments, operations, APIs, and open developer surfaces.
- [Developer Package and Crave Cloud](https://docs.craveup.com/guides/open-source-and-cloud.md): How Crave's developer-facing package fits into the managed Crave Cloud platform.
- [Build a Restaurant Ordering App in Minutes](https://docs.craveup.com/getting-started/introduction.md): Scaffold a branded storefront, connect menus, carts, checkout, fulfillment, and payments, then ship against the Crave API.
- [CLI Quickstart](https://docs.craveup.com/getting-started/cli-quickstart.md): Use the Crave CLI to scaffold, configure, and launch a storefront template.
- [Storefront SDK](https://docs.craveup.com/getting-started/storefront-sdk.md): Use the typed direct client for public catalog, cart, customer, checkout, receipt, and loyalty flows.
- [Dart and Flutter Storefront SDK](https://docs.craveup.com/getting-started/flutter-storefront-sdk.md): Build typed Flutter storefronts against the public Crave Storefront API.
- [REST API Essentials](https://docs.craveup.com/getting-started/rest-api.md): Call the public Crave Storefront API directly from web, mobile, or server applications.
- [Next.js Quickstart](https://docs.craveup.com/quickstarts/nextjs.md): Build a direct, capability-safe storefront with Next.js and the Crave Storefront SDK.
- [React Quickstart](https://docs.craveup.com/quickstarts/react.md): Build a direct-to-Crave storefront with React, Vite, and the Storefront SDK.
- [Vanilla JavaScript Quickstart](https://docs.craveup.com/quickstarts/vanilla-js.md): Use the public Crave Storefront API directly from a browser without a framework.
- [React Native / Expo Quickstart](https://docs.craveup.com/quickstarts/mobile.md): Build a mobile storefront that calls the public Crave API directly.
- [Flutter quickstart](https://docs.craveup.com/quickstarts/flutter.md): Connect a Flutter application to the Crave Storefront API with typed, capability-safe ordering.
- [Generate a Private Integration API Key](https://docs.craveup.com/guides/generate-api-key.md): Create and protect a server-only Crave credential for admin or partner integrations.
- [Build a Custom Storefront](https://docs.craveup.com/guides/build-custom-storefront.md): Scaffold and extend a direct, capability-safe Crave ordering experience.
- [Use the CraveUp MCP Server](https://docs.craveup.com/guides/ai/craveup-mcp-server.md): Connect AI agents to CraveUp tools for storefront setup, menu import, readiness checks, and go-live onboarding.
- [Prebuilt Storefront Prompt](https://docs.craveup.com/guides/ai/build-storefront-prompt.md): Give an AI coding agent the direct public Storefront API security and delivery contract.
- [Display Menu](https://docs.craveup.com/guides/display-menu.md): Fetch menus, categories, and products for a location.
- [Manage Cart](https://docs.craveup.com/guides/manage-cart.md): Create and mutate a cart with capability, revision, and idempotency protection.
- [Checkout Flow](https://docs.craveup.com/guides/checkout-flow.md): Finalize a capability-protected cart, confirm payment, and poll the authoritative order result.
- [Fulfillment Methods](https://docs.craveup.com/guides/fulfillment-methods.md): Configure delivery, table-side, and room service for your storefront orders.
- [Accept Payments](https://docs.craveup.com/guides/accept-payments.md): Use the protected Crave payment session selected for the restaurant.
- [Order Tracking](https://docs.craveup.com/guides/order-tracking.md): Poll the authoritative checkout result and display a protected receipt.
- [Theming](https://docs.craveup.com/guides/theming.md): Customize your storefront's colors, fonts, and component styles.
- [Outbound Webhooks (Planned)](https://docs.craveup.com/guides/webhooks.md): Current availability and integration guidance for outbound merchant events.
- [Testing](https://docs.craveup.com/guides/testing.md): Test storefront capability, concurrency, checkout, and secret-handling behavior.
- [Deployment](https://docs.craveup.com/guides/deployment.md): Deploy a direct Crave storefront with exact origins and no browser credentials.
- [Analytics](https://docs.craveup.com/guides/analytics.md): Track storefront events and measure ordering funnel performance.
- [Square commerce setup](https://docs.craveup.com/guides/integrations/square.md): Connect Square as the operational commerce authority for menu, checkout, orders, refunds, loyalty, and gift-card tenders.
- [Stripe Payments](https://docs.craveup.com/guides/integrations/stripe.md): Set up Stripe Connect for payment processing in your storefront.
- [Toast POS](https://docs.craveup.com/guides/integrations/toast.md): Connect Toast POS to sync menus and orders with your Crave storefront.
- [Clover POS](https://docs.craveup.com/guides/integrations/clover.md): Understand Clover connection, merchant mapping, catalog discovery, and activation gates.
- [Glossary](https://docs.craveup.com/guides/glossary.md): Key terms and concepts used across the Crave platform.
- [Troubleshooting](https://docs.craveup.com/guides/troubleshooting.md): Diagnose direct Storefront API configuration, capability, concurrency, and checkout failures.
- [Upgrade Guide](https://docs.craveup.com/guides/upgrade-guide.md): Migrate a Storefront SDK 1.x integration to the direct, capability-safe 2.0.0 contract.
- [API Overview](https://docs.craveup.com/api-reference/overview/api-overview.md): Use the direct public Storefront API with capabilities, customer JWTs, and optimistic concurrency.
- [Core Concepts](https://docs.craveup.com/api-reference/overview/core-concepts.md): Understand the data model behind merchants, locations, menus, carts, and orders.
- [Get a published merchant and its locations](https://docs.craveup.com/api-reference/merchants/get-a-published-merchant-and-its-locations.md)
- [Get a published location](https://docs.craveup.com/api-reference/locations/get-a-published-location.md)
- [Calculate distance to a location](https://docs.craveup.com/api-reference/locations/calculate-distance-to-a-location.md)
- [Get available order times](https://docs.craveup.com/api-reference/locations/get-available-order-times.md)
- [Get gratuity configuration](https://docs.craveup.com/api-reference/locations/get-gratuity-configuration.md)
- [Redirect to the hosted location storefront](https://docs.craveup.com/api-reference/locations/redirect-to-the-hosted-location-storefront.md)
- [Check ordering availability without creating a cart](https://docs.craveup.com/api-reference/ordering-sessions/check-ordering-availability-without-creating-a-cart.md)
- [Create or resume an ordering session](https://docs.craveup.com/api-reference/ordering-sessions/create-or-resume-an-ordering-session.md)
- [List the published menu bundle](https://docs.craveup.com/api-reference/menus/list-the-published-menu-bundle.md)
- [Get a published product](https://docs.craveup.com/api-reference/products/get-a-published-product.md)
- [Record an allowlisted Storefront analytics event](https://docs.craveup.com/api-reference/analytics/record-an-allowlisted-storefront-analytics-event.md)
- [Get an authorized cart](https://docs.craveup.com/api-reference/carts/get-an-authorized-cart.md)
- [Expire a cart](https://docs.craveup.com/api-reference/carts/expire-a-cart.md)
- [Update cart fields](https://docs.craveup.com/api-reference/carts/update-cart-fields.md)
- [Accept the current authoritative cart changes](https://docs.craveup.com/api-reference/carts/accept-the-current-authoritative-cart-changes.md)
- [Start a cart at another merchant location](https://docs.craveup.com/api-reference/carts/start-a-cart-at-another-merchant-location.md)
- [List cart recommendations](https://docs.craveup.com/api-reference/carts/list-cart-recommendations.md)
- [Update the DoorDash courier tip](https://docs.craveup.com/api-reference/carts/update-the-doordash-courier-tip.md)
- [Update cart gratuity](https://docs.craveup.com/api-reference/carts/update-cart-gratuity.md)
- [Set cart delivery address](https://docs.craveup.com/api-reference/carts/set-cart-delivery-address.md)
- [Set table service details](https://docs.craveup.com/api-reference/carts/set-table-service-details.md)
- [Set room service details](https://docs.craveup.com/api-reference/carts/set-room-service-details.md)
- [Update cart order time](https://docs.craveup.com/api-reference/carts/update-cart-order-time.md)
- [Claim a guest cart for the signed-in customer](https://docs.craveup.com/api-reference/carts/claim-a-guest-cart-for-the-signed-in-customer.md)
- [Validate checkout and update customer contact details](https://docs.craveup.com/api-reference/checkout/validate-checkout-and-update-customer-contact-details.md)
- [Create a one-time checkout handoff](https://docs.craveup.com/api-reference/checkout/create-a-one-time-checkout-handoff.md)
- [Exchange a one-time checkout handoff](https://docs.craveup.com/api-reference/checkout/exchange-a-one-time-checkout-handoff.md)
- [Create or recover the authoritative cart payment session](https://docs.craveup.com/api-reference/checkout/create-or-recover-the-authoritative-cart-payment-session.md)
- [Confirm an authoritative provider payment](https://docs.craveup.com/api-reference/checkout/confirm-an-authoritative-provider-payment.md)
- [Poll checkout order state](https://docs.craveup.com/api-reference/checkout/poll-checkout-order-state.md)
- [Submit a rating after successful payment](https://docs.craveup.com/api-reference/checkout/submit-a-rating-after-successful-payment.md)
- [Add an item to a cart](https://docs.craveup.com/api-reference/cart-items/add-an-item-to-a-cart.md)
- [Remove an item from a cart](https://docs.craveup.com/api-reference/cart-items/remove-an-item-from-a-cart.md)
- [Update a cart item quantity](https://docs.craveup.com/api-reference/cart-items/update-a-cart-item-quantity.md)
- [Apply a discount code](https://docs.craveup.com/api-reference/discounts/apply-a-discount-code.md)
- [Remove the applied discount](https://docs.craveup.com/api-reference/discounts/remove-the-applied-discount.md)
- [Get loyalty earning and reward options](https://docs.craveup.com/api-reference/loyalty/get-loyalty-earning-and-reward-options.md)
- [Join the checkout's authoritative loyalty program](https://docs.craveup.com/api-reference/loyalty/join-the-checkouts-authoritative-loyalty-program.md)
- [Reserve and apply a loyalty reward](https://docs.craveup.com/api-reference/loyalty/reserve-and-apply-a-loyalty-reward.md)
- [Remove the applied loyalty reward](https://docs.craveup.com/api-reference/loyalty/remove-the-applied-loyalty-reward.md)
- [Get customer loyalty balances and ledger](https://docs.craveup.com/api-reference/loyalty/get-customer-loyalty-balances-and-ledger.md)
- [List customer loyalty claims](https://docs.craveup.com/api-reference/loyalty/list-customer-loyalty-claims.md)
- [Submit a loyalty claim](https://docs.craveup.com/api-reference/loyalty/submit-a-loyalty-claim.md)
- [Start merchant-bound customer login](https://docs.craveup.com/api-reference/customer-authentication/start-merchant-bound-customer-login.md)
- [Verify customer OTP](https://docs.craveup.com/api-reference/customer-authentication/verify-customer-otp.md)
- [Revoke the customer session](https://docs.craveup.com/api-reference/customer-authentication/revoke-the-customer-session.md)
- [Get the signed-in customer profile](https://docs.craveup.com/api-reference/customers/get-the-signed-in-customer-profile.md)
- [Send a customer phone verification code](https://docs.craveup.com/api-reference/customers/send-a-customer-phone-verification-code.md)
- [Confirm a customer phone verification code](https://docs.craveup.com/api-reference/customers/confirm-a-customer-phone-verification-code.md)
- [List customer addresses](https://docs.craveup.com/api-reference/customers/list-customer-addresses.md)
- [Create a customer address](https://docs.craveup.com/api-reference/customers/create-a-customer-address.md)
- [Delete a customer address](https://docs.craveup.com/api-reference/customers/delete-a-customer-address.md)
- [Update a customer address](https://docs.craveup.com/api-reference/customers/update-a-customer-address.md)
- [List saved payment methods](https://docs.craveup.com/api-reference/customers/list-saved-payment-methods.md)
- [Delete a saved payment method](https://docs.craveup.com/api-reference/customers/delete-a-saved-payment-method.md)
- [Get Square digital gift-card sale settings](https://docs.craveup.com/api-reference/customers/get-square-digital-gift-card-sale-settings.md)
- [Buy and activate a Square digital gift card](https://docs.craveup.com/api-reference/customers/buy-and-activate-a-square-digital-gift-card.md)
- [List customer orders](https://docs.craveup.com/api-reference/orders/list-customer-orders.md)
- [Get customer order details](https://docs.craveup.com/api-reference/orders/get-customer-order-details.md)
- [Get an authorized public receipt](https://docs.craveup.com/api-reference/orders/get-an-authorized-public-receipt.md)
- [Error Codes](https://docs.craveup.com/guides/error-codes.md): Handle public Storefront API errors without leaking credentials or replaying unsafe writes.
- [Components](https://docs.craveup.com/components/overview.md): Pre-built React components for menu browsing, cart management, checkout, and fulfillment.
- [Installation](https://docs.craveup.com/components/installation.md): Install dependencies and structure your app for Crave UI components.
- [](https://docs.craveup.com/components/menu/category-tabs.md): Sticky tab navigation for browsing menu categories.
- [](https://docs.craveup.com/components/menu/menu-switcher.md): Dropdown to switch between multiple menus with availability status.
- [ ](https://docs.craveup.com/components/menu/item.md): Unified product card that renders vertical or horizontal layouts.
- [](https://docs.craveup.com/components/menu/item-carousel.md): Horizontal carousel for featured or recommended menu items.
- [](https://docs.craveup.com/components/modifiers/modifier-group.md): Renders a group of modifier options (radio, checkbox, or counter) for product customization.
- [](https://docs.craveup.com/components/modifiers/product-description-screen.md): Full-screen product detail view with modifiers, quantity, and add-to-cart action.
- [](https://docs.craveup.com/components/modifiers/special-instructions.md): Text input for customer notes and special requests on a menu item.
- [](https://docs.craveup.com/components/modifiers/item-counter-button.md): Increment/decrement stepper for adjusting item or modifier quantities.
- [](https://docs.craveup.com/components/cart/cart-panel.md): Slide-out panel displaying the current cart contents and order summary.
- [](https://docs.craveup.com/components/cart/cart-nav-button.md): Floating or header-mounted button showing cart item count and total.
- [](https://docs.craveup.com/components/cart/cart-item-row.md): Individual cart line item with modifiers, quantity control, and price.
- [](https://docs.craveup.com/components/cart/cart-related-items.md): Upsell carousel shown in the cart suggesting complementary items.
- [](https://docs.craveup.com/components/checkout/checkout-component.md): Top-level checkout orchestrator that manages the multi-step checkout flow.
- [](https://docs.craveup.com/components/checkout/customer-details-form.md): Form for collecting customer name, email, and phone number during checkout.
- [](https://docs.craveup.com/components/checkout/payment-form.md): Provider-selected secure payment input for Crave checkout.
- [](https://docs.craveup.com/components/checkout/tip-selector.md): Preset and custom tip amount picker for the checkout flow.
- [](https://docs.craveup.com/components/checkout/order-time-picker.md): Date and time selector for scheduling pickup or delivery orders.
- [](https://docs.craveup.com/components/checkout/apply-promo-code.md): Input field for applying discount codes to an order.
- [](https://docs.craveup.com/components/fulfillment/fulfilment-method-handler.md): Route-level handler that renders the appropriate fulfillment flow based on order type.
- [](https://docs.craveup.com/components/fulfillment/delivery.md): Delivery address form with validation and delivery zone checking.
- [](https://docs.craveup.com/components/fulfillment/table-side.md): Table number input for dine-in table-side ordering.
- [](https://docs.craveup.com/components/fulfillment/room-service.md): Room number and guest name input for hotel room service ordering.
- [](https://docs.craveup.com/components/post-order/order-confirmation.md): Post-checkout screen showing order details, status, and estimated ready time.
- [](https://docs.craveup.com/components/post-order/experience-rating.md): Post-order feedback widget for rating the ordering experience.
- [Changelog](https://docs.craveup.com/changelog.md): Track improvements to the Crave storefront documentation and OpenAPI reference.
## OpenAPI Specs
- [storefront.openapi](https://docs.craveup.com/generated/storefront.openapi.json)
- [openapi](https://docs.craveup.com/api-reference/openapi.json)