Dart and Flutter Storefront SDK

crave_storefront_sdk is the official Dart client for Flutter mobile, web, and desktop storefronts. It exposes the same reviewed /api/v1/storefront contract as @craveup/storefront-sdk, with Dart-native models, cancellation, timeouts, and typed exceptions. It contains no UI, Flutter, or native runtime dependency.

Install the exact release

pubspec.yaml

dependencies:
  crave_storefront_sdk: 0.2.0

Run flutter pub get. Dart-only consumers can run dart pub get instead.

Configure one environment and merchant

import 'package:crave_storefront_sdk/crave_storefront_sdk.dart';

final client = CraveStorefrontClient(
  baseUri: Uri.parse('https://api.craveup.com'),
  merchantSlug: 'downtown-pizza',
  sessionStore: secureSessionStore,
  customerTokenProvider: () => clerkSession.getToken(
    template: 'crave-customer',
  ),
);

Use the exact sandbox API origin provided for your account in sandbox builds. Production and sandbox are separate deployments with separate environment variables, credentials, and data; do not add a runtime environment switch to a production app. The client accepts plain HTTP only for exact loopback hosts during local development. StorefrontSessionStore is application-owned. In production, implement it with encrypted platform storage and isolate records by the supplied API-origin, merchant, and location scope. The included InMemoryStorefrontSessionStore is only for tests and ephemeral demos. The customer token provider must retrieve a current short-lived token from the active Clerk session. Let Clerk own persistence, refresh, recovery, and logout; do not copy customer JWTs into the cart session store or application storage.

Check ordering readiness

Check availability before presenting an ordering action. This anonymous GET does not create a cart:

final readiness = await client.locations.getOrderingReadiness(
  locationId,
  fulfillmentMethod: FulfillmentMethod.takeout,
);

switch (readiness) {
  case OrderingReady():
    showStartOrder();
  case OrderingUnavailable(:final reason):
    showOrderingUnavailable(reason);
}

Handle typed failures

try {
  final menu = await client.menus.getForLocation(locationId, menuOnly: true);
  renderMenu(menu);
} on StorefrontApiException catch (error) {
  reportSafeFailure(error.code, error.status, error.requestId);
} on StorefrontTimeoutException {
  showRetryMessage();
} on StorefrontRequestCancelledException {
  // The owning screen was disposed or the shopper cancelled the action.
}

The exception contract excludes resolved URLs, headers, request bodies, customer data, and payment values. Cart mutations are never retried implicitly. After CART_CONFLICT, re-read the cart, reconcile the new revision, and let the shopper confirm the next mutation. Close the client when its application-level owner is disposed:

client.close();

Build a Flutter storefront

Install the package, configure secure session storage, load a menu, and start an order.

Platform

Getting Started

Quickstarts

Implementation

AI

Ordering Flow

More Guides

Integrations

Reference

Install the exact release

Configure one environment and merchant

Check ordering readiness

Handle typed failures

Build a Flutter storefront

​Install the exact release

​Configure one environment and merchant

​Check ordering readiness

​Handle typed failures

Build a Flutter storefront

Install the exact release

Configure one environment and merchant

Check ordering readiness

Handle typed failures