Back-office and merchant operations
The Admin API is how you operate Fire spark from the merchant side. Use it to build internal tools, sync customer data in bulk, query orders across every channel, and migrate records from legacy systems — without touching customer-facing flows or POS integrations directly. If the Storefront API powers the channels your customers use (app, web, kiosk), and the Integrations API connects your POS and RMS to those channels, the Admin API is the layer for back-office and operations: dashboards, CRM bridges, data pipelines, and onboarding scripts.New to Fire spark?
Connect a merchant in the dashboard before calling the Admin API.
What you can build
The Admin API is server-to-server only. It is not for mobile apps, websites, or kiosks where end customers sign in.
How it works
1
Authenticate your server
Your backend obtains an access token using OAuth 2.0 client credentials.
Store your
client_id and client_secret securely — never expose them in
client-side code.2
Operate on merchant-wide data
Call endpoints to list and manage customers in bulk, query orders across all
channels, or run migration jobs for onboarding.
3
Changes propagate through Fire spark
Customer updates and migrated records flow into the same omnichannel layer
that powers your Storefront and Integrations APIs. A customer created
through the Admin API is available to every connected channel.
API areas
Authentication
OAuth 2.0 client credentials secure access to every Admin API endpoint. Authenticate from your server before making bulk or migration calls.Token
Obtain an access token with client credentials.
Stores
Create merchant locations used by menus, fulfillment, and orders.Create store
Create a store for the authenticated merchant.
Update store
Update a store by external id.
Customers (bulk)
Create, read, update, and delete customer records in bulk. Use these endpoints to sync a CRM, import a contact list, or reconcile customer data across systems.Orders
Query orders across all channels and stores for a merchant, or cancel an order before it is fulfilled. Use this to power operational dashboards, support tools, or reporting pipelines.List orders
Retrieve orders across channels.
Cancel order
Void an unpaid order or reverse a paid one.
Migrate
Import customers and historical terminal orders from a legacy platform. Each request validates the batch and enqueues a job. Track progress in the dashboard under Customers or Orders → Migrations.Migrate customers
Upsert customers from a legacy system
Migrate orders
Upsert historical terminal orders
Admin API vs Storefront API vs Integrations API
Use the API that matches the actor: customers interact through Storefront, kitchen systems through Integrations, and your operations team through Admin.
Base URL
Postman collection
Download all Admin API endpoints. Set
client_id and client_secret, then
run the Token request to populate bearerToken.Next steps
Token
Get an access token
Developers guide
Set up your server integration
Bulk customers
Read and manage customers in bulk
Rate limits
Review rate limits and quotas