# Fire spark

## Docs

- [Authorize](https://firespark.cloud/docs/admin-api/auth/authorize/get.md): Get an Access token to be able to call the api. This token should be kept secret and not exposed to the client.
- [Delete customers (bulk)](https://firespark.cloud/docs/admin-api/customers/bulk/delete.md)
- [Get customers (bulk)](https://firespark.cloud/docs/admin-api/customers/bulk/get.md)
- [Update customers (bulk)](https://firespark.cloud/docs/admin-api/customers/bulk/patch.md)
- [Create customers (bulk)](https://firespark.cloud/docs/admin-api/customers/bulk/post.md)
- [Developers](https://firespark.cloud/docs/admin-api/guides/developers.md)
- [Introduction](https://firespark.cloud/docs/admin-api/introduction.md): Manage merchant operations, bulk customer data, and order visibility through Fire spark's Admin API.
- [List orders](https://firespark.cloud/docs/admin-api/orders/get.md)
- [Rate limit](https://firespark.cloud/docs/admin-api/resources/rate-limit.md)
- [Consolidated analytics](https://firespark.cloud/docs/case/consolidated-analytics.md): Compare sales, mix, and channel performance in one view — not three platform exports.
- [Menus A/B testing](https://firespark.cloud/docs/case/menus-ab-testing.md): Test what customers see per channel and measure impact before you roll out broadly.
- [Omnichannel strategy](https://firespark.cloud/docs/case/omnichannel-strategy.md): Plan reach, channel mix, and brand consistency without multiplying integration projects.
- [Real-time monitoring](https://firespark.cloud/docs/case/realtime-monitoring.md): See orders and operational signals as they happen across every connected channel.
- [Comparison](https://firespark.cloud/docs/comparison.md): How Fire spark compares to single-aggregator APIs, fragmented integrations, and in-house omnichannel builds.
- [Brands](https://firespark.cloud/docs/concepts/brands.md): Run more than one brand name under a single merchant account.
- [Categories](https://firespark.cloud/docs/concepts/categories.md): How products are grouped so customers can browse your menu.
- [Channels](https://firespark.cloud/docs/concepts/channels.md): Every surface where customers discover your brand and place orders.
- [CMS](https://firespark.cloud/docs/concepts/cms.md): Structured content templates you attach to brands, stores, menus, and catalog items.
- [Fulfillment](https://firespark.cloud/docs/concepts/fulfillment.md): How orders are completed — standard modes, custom types, and rules per store and channel.
- [Concepts](https://firespark.cloud/docs/concepts/index.md): Core ideas behind Fire spark — how merchants, stores, channels, menus, and orders fit together.
- [Menus](https://firespark.cloud/docs/concepts/menus.md): Catalogs customers browse on each channel — rooted in your operation, composed per context.
- [Orders](https://firespark.cloud/docs/concepts/orders.md): A customer purchase from any channel, routed into your operation.
- [Products](https://firespark.cloud/docs/concepts/products.md): Individual menu items — what customers add to their order.
- [Stores](https://firespark.cloud/docs/concepts/stores.md): Physical locations where your operation runs and orders are fulfilled.
- [Connecting a merchant](https://firespark.cloud/docs/guides/connecting-a-merchant.md)
- [Authorize](https://firespark.cloud/docs/integrations-api/auth/authorize/get.md): Authenticate with the Integrations API using OAuth 2.0.
- [List channels](https://firespark.cloud/docs/integrations-api/channels/get.md): Read sales channel definitions for POS and RMS mapping.
- [Upsert channels](https://firespark.cloud/docs/integrations-api/channels/put.md): Create or update channel definitions from your POS or RMS in Fire spark.
- [Get fulfillment option](https://firespark.cloud/docs/integrations-api/fulfillment/[id]/get.md): Read one fulfillment type definition by external id.
- [List fulfillment options](https://firespark.cloud/docs/integrations-api/fulfillment/get.md): Read fulfillment type definitions for POS and RMS mapping.
- [Upsert fulfillment options](https://firespark.cloud/docs/integrations-api/fulfillment/put.md): Create or update fulfillment type definitions from your POS or RMS in Fire spark.
- [Menu sync](https://firespark.cloud/docs/integrations-api/guides/menu-sync.md)
- [Order injection](https://firespark.cloud/docs/integrations-api/guides/order-injection.md)
- [Introduction](https://firespark.cloud/docs/integrations-api/introduction.md): Connect your POS and RMS to every sales channel through Fire spark's Integrations API.
- [List menus](https://firespark.cloud/docs/integrations-api/menus/get.md): Read composed menu definitions for POS and RMS mapping.
- [Update product](https://firespark.cloud/docs/integrations-api/menus/products/[id]/put.md): Update a product inside a composed menu from your POS or RMS.
- [Upsert menus](https://firespark.cloud/docs/integrations-api/menus/put.md): Create or update composed menus from your POS or RMS in Fire spark.
- [Get order](https://firespark.cloud/docs/integrations-api/orders/[id]/get.md)
- [Inject order](https://firespark.cloud/docs/integrations-api/orders/[id]/post.md)
- [Update order status](https://firespark.cloud/docs/integrations-api/orders/[id]/status/patch.md)
- [Order webhooks](https://firespark.cloud/docs/integrations-api/orders/webhooks.md)
- [Resource limits](https://firespark.cloud/docs/integrations-api/resources/resource-limits.md)
- [List stores](https://firespark.cloud/docs/integrations-api/stores/get.md): Read store configuration for POS and RMS location mapping.
- [Upsert stores](https://firespark.cloud/docs/integrations-api/stores/put.md): Create or update store configuration from your POS or RMS in Fire spark.
- [PedidosYa](https://firespark.cloud/docs/integrations/aggregators/pedidosya.md): Operate on PedidosYa with menus synced from your POS automatically.
- [Rappi](https://firespark.cloud/docs/integrations/aggregators/rappi.md): Stay live on Rappi with automatic menu sync from your operation.
- [Uber Eats](https://firespark.cloud/docs/integrations/aggregators/uber-eats.md): List on Uber Eats with menus synced automatically from your POS.
- [App](https://firespark.cloud/docs/integrations/channels/app.md): Your branded mobile app powered by the Storefront API.
- [Call center](https://firespark.cloud/docs/integrations/channels/call-center.md): Phone orders with live menus and fulfillment rules from Fire spark.
- [Kiosk](https://firespark.cloud/docs/integrations/channels/kiosk.md): In-store self-service ordering with the same menu engine as digital channels.
- [POS](https://firespark.cloud/docs/integrations/channels/pos.md): In-store POS as a sales channel unified with digital ordering.
- [Web](https://firespark.cloud/docs/integrations/channels/web.md): Branded web ordering with menus synced from your operation.
- [WhatsApp](https://firespark.cloud/docs/integrations/channels/whatsapp.md): Meet customers on WhatsApp with ordering backed by Fire spark.
- [Integrations](https://firespark.cloud/docs/integrations/index.md): How Fire spark connects your operation to POS systems, aggregators, and owned channels.
- [Aloha](https://firespark.cloud/docs/integrations/pos-rms/aloha.md): Connect NCR Aloha to Fire spark without rebuilding your omnichannel stack.
- [Fire POS](https://firespark.cloud/docs/integrations/pos-rms/fire-pos.md): Fire spark's RMS — inventory, kitchen, and operations built for omnichannel.
- [PixelPoint](https://firespark.cloud/docs/integrations/pos-rms/pixel-point.md): Connect PixelPoint to Fire spark for automatic menu sync and order injection.
- [Symphony](https://firespark.cloud/docs/integrations/pos-rms/symphony.md): Connect Symphony to Fire spark with simple credentials and unified menu sync.
- [Toast](https://firespark.cloud/docs/integrations/pos-rms/toast.md): Connect Toast to Fire spark with dashboard credentials and automatic menu sync.
- [Overview](https://firespark.cloud/docs/overview.md): Sell on every channel from one place — menus, orders, and intelligence unified across your operation.
- [Quickstart](https://firespark.cloud/docs/quickstart.md): Connect your operation to Fire spark and activate your first sales channels.
- [Exchange token](https://firespark.cloud/docs/storefront-api/auth/exchange/get.md): Exchange an OIDC ID token from your identity provider for a Fire spark access token for the authenticated customer.
- [Get brand](https://firespark.cloud/docs/storefront-api/brands/[id]/get.md): Retrieve a single brand by its external identifier.
- [List brands](https://firespark.cloud/docs/storefront-api/brands/get.md): List all customer-facing brands for the merchant.
- [Get channel](https://firespark.cloud/docs/storefront-api/channels/[id]/get.md): Retrieve a single channel by its external identifier.
- [List channels](https://firespark.cloud/docs/storefront-api/channels/get.md): List all customer-facing sales channels for the merchant.
- [Get customer consent](https://firespark.cloud/docs/storefront-api/customers/[id]/consent/get.md): Get customer consent preferences. If consent is null or empty, the API returns default consent values with all purposes set to true.
- [Update customer consent](https://firespark.cloud/docs/storefront-api/customers/[id]/consent/patch.md): Update customer consent preferences according to IAB TCF (Transparency and Consent Framework) standards.
- [Unregister customer](https://firespark.cloud/docs/storefront-api/customers/[id]/delete.md): Delete a customer by id
- [Customer device token](https://firespark.cloud/docs/storefront-api/customers/[id]/devices/delete.md): Unregister customer's device token.
- [Customer device token](https://firespark.cloud/docs/storefront-api/customers/[id]/devices/patch.md): Update customer's device token.
- [Get customer](https://firespark.cloud/docs/storefront-api/customers/[id]/get.md): Get a customer by id
- [Identify anonymous customers](https://firespark.cloud/docs/storefront-api/customers/[id]/identify/anonymous/patch.md): Identify an anonymous customer by providing their real information. This endpoint converts an anonymous customer to a regular customer. The customer must have been created with `is_anonymous: true`. Optionally, you can provide a `new_id` to change the customer's ID during identification.
- [Delete order](https://firespark.cloud/docs/storefront-api/customers/[id]/orders/[id]/delete.md)
- [Get order](https://firespark.cloud/docs/storefront-api/customers/[id]/orders/[id]/get.md)
- [Update order](https://firespark.cloud/docs/storefront-api/customers/[id]/orders/[id]/patch.md)
- [List orders](https://firespark.cloud/docs/storefront-api/customers/[id]/orders/get.md)
- [Create order](https://firespark.cloud/docs/storefront-api/customers/[id]/orders/post.md)
- [Update customer](https://firespark.cloud/docs/storefront-api/customers/[id]/patch.md): Update a customer by id. Only some fields can be updated using these API.
- [Migrate orders](https://firespark.cloud/docs/storefront-api/customers/migrate/orders/post.md)
- [Migrate customers](https://firespark.cloud/docs/storefront-api/customers/migrate/post.md): Migrate a customer from an old system to Fire spark
- [Revert migration](https://firespark.cloud/docs/storefront-api/customers/migrate/revert/delete.md): Revert all customers migration that don't have new transactions
- [Register customer](https://firespark.cloud/docs/storefront-api/customers/post.md): Register a customer. For anonymous customers, only the `id` and `is_anonymous: true` are required. Anonymous customers can later be identified using the `/customers/{id}/identify/anonymous` endpoint.
- [Get fulfillment option](https://firespark.cloud/docs/storefront-api/fulfillment/[id]/get.md): Retrieve a single fulfillment mode by its external identifier.
- [List fulfillment options](https://firespark.cloud/docs/storefront-api/fulfillment/get.md): List all customer-facing fulfillment modes for the merchant.
- [Displaying menus](https://firespark.cloud/docs/storefront-api/guides/displaying-menus.md)
- [OIDC authentication](https://firespark.cloud/docs/storefront-api/guides/oidc-authentication.md)
- [Placing orders](https://firespark.cloud/docs/storefront-api/guides/placing-orders.md)
- [Register customers](https://firespark.cloud/docs/storefront-api/guides/register-customers.md)
- [Introduction](https://firespark.cloud/docs/storefront-api/introduction.md): Build custom sales channels — app, web, and kiosk — on top of Fire spark's Storefront API.
- [Get category](https://firespark.cloud/docs/storefront-api/menus/categories/[id]/get.md): Load a category from a composed menu with per-context availability.
- [List menus](https://firespark.cloud/docs/storefront-api/menus/get.md): List composed menus available to the customer for a store, channel, and fulfillment context.
- [Get product](https://firespark.cloud/docs/storefront-api/menus/products/[id]/get.md): Load a product from a composed menu with pricing and availability.
- [Get store](https://firespark.cloud/docs/storefront-api/stores/[id]/get.md): Retrieve a single store by its external identifier.
- [List stores](https://firespark.cloud/docs/storefront-api/stores/get.md): List merchant locations available for ordering in your channel.
- [List nearby stores](https://firespark.cloud/docs/storefront-api/stores/nearby/get.md): Find the nearest merchant locations from a latitude and longitude.

## OpenAPI Specs

- [openapi](https://firespark.cloud/docs/storefront-api/openapi.json)

## Optional

- [Roadmap](https://firespark.vercel.app/docs/roadmap)
- [Changelog](https://firespark.vercel.app/docs/changelog)