A
concept
An organization secret (
crv_live_... or crv_test_...) used to authenticate Storefront API requests. Generate keys from Dashboard > Developers > API Development > Step 1 - API Keys, copy the target location ID from Step 2 - Location IDs, and pass it in the request URL.concept
A tracked action in the ordering funnel:
SCAN, CART_VIEW, CHECKOUT_VIEW, or ORDER_PLACED. Fired via storefront.analyticsEvents.track(). See Analytics guide.C
model
A temporary container holding a customer’s selected items, modifiers, fulfillment method, and order timing. Created when an ordering session starts. Identified by
cartId. Carts expire after inactivity.concept
The
cartId string returned when starting an ordering session. Persist it in localStorage or a cookie so returning customers resume their cart.model
A grouping of products within a menu (e.g., “Appetizers”, “Mains”, “Drinks”). Contains an ordered list of
productIds. Displayed as tabs or sections in the storefront.service
Authentication provider used for the Admin API and Dashboard. Clerk manages user sessions, organization memberships, and JWT tokens. Not used for storefront customer-facing flows.
D
concept
The geographic area a location delivers to. Checked via
storefront.locations.getDistance() before setting a delivery address on a cart. Out-of-range addresses return a DELIVERY_OUT_OF_RANGE error.concept
A promo code (e.g.,
SAVE10) applied to a cart for a percentage or fixed discount. Applied via storefront.discounts.apply(), removed via storefront.discounts.remove().F
concept
How a customer receives their order. Four options:
takeout (counter pickup), delivery (address-based), table_side (dine-in to a table number), room_service (hotel room delivery). Set on the cart before checkout. See Fulfillment Methods guide.G
concept
An optional tip amount added during checkout. Locations configure whether tipping is enabled, suggested percentages, a default percentage, and whether custom amounts are allowed. Set via
storefront.cart.updateGratuity().L
model
A physical or virtual restaurant location within a merchant organization. Each location has its own menus, hours, fulfillment methods, and payment settings. Identified by ObjectId or slug.
M
A collection of categories and products for a location. Locations can have multiple menus (e.g., Lunch, Dinner, Weekend Brunch). The active menu depends on the current time and the location’s schedule.
model
The top-level business entity. A merchant has one or more locations. Looked up by slug via
storefront.merchant.getBySlug().model
A set of customization options for a product (e.g., Size, Toppings, Extras). Each group has
min/max selection rules. Contains modifier items.model
A single option within a modifier group (e.g., “Large”, “Extra Cheese”, “Bacon”). Has an optional price and max quantity.
O
concept
The lifecycle state of an order:
OPEN (cart active) → LOCKED (payment processing) → COMPLETED (confirmed). Admin-side statuses include confirmed, ready, dispatched, completed, cancelled.concept
The entry point for a customer interaction. Starting a session creates a cart and returns a
cartId. Created via storefront.orderingSessions.start().P
concept
A Stripe PaymentIntent created via
storefront.payments.createIntent(). Returns a clientSecret for Stripe.js and a stripeAccountId for the restaurant’s connected Stripe account. See Accept Payments guide.model
A menu item with name, description, price, images, and optional modifier groups. Added to carts with quantity and modifier selections.
R
concept
A post-order experience rating (1-5 stars) with optional comment. Submitted via
storefront.locations.submitRating().S
concept
A developer mode toggle that routes all operations through Stripe test mode. Orders are logged but not sent to the restaurant. Toggled via the Admin API’s
/developer-mode endpoint.concept
A URL-safe identifier for merchants and locations (e.g.,
downtown-pizza). Used interchangeably with ObjectIds in API paths.tool
The typed TypeScript client (
@craveup/storefront-sdk) for the Storefront API. Wraps all endpoints with type-safe methods organized into namespaces: merchant, locations, orderingSessions, cart, discounts, payments, analyticsEvents. See SDK Reference.service
Stripe’s platform for marketplace payments. Each restaurant connects their Stripe account to receive payouts. Crave handles the Connect setup; storefronts only need the publishable key for Stripe.js.
W
concept
An HTTP POST sent to your server when events occur (e.g.,
order.created, order.completed, cart.abandoned). Signed with HMAC-SHA256 for verification. See Webhooks guide.