Introduction
Sell from your own website or app, with Cashiar running the shop behind it.
Cashiar runs a shop's selling: its products and prices, stock at every branch, orders, deliveries, bookings and payments. Every shop with the Online store add-on gets a store at <shop>.cashiar.shop.
The Storefront API lets you build that store yourself. Your website, your mobile app or your kiosk reads the shop's catalogue and services straight from Cashiar and places orders and bookings that land in the shop like any other: on the Sales screen, in the kitchen, on the rider's list and in the reports.
Quickstart
Your first products on screen in five minutes.
Cart and checkout
Turn a cart into an order, for pickup or delivery, paid now or later.
Bookings
Let customers book a salon chair, a fitting or a table.
API reference
Every endpoint, field and error, with a playground.
What you can build
- A store on your own domain, designed exactly as you like, in React, Next.js, Vue, Svelte or plain HTML.
- A mobile app in Flutter, React Native or Swift that customers order from.
- A kiosk or a QR menu that sends orders straight to the shop.
- Bookings inside your own site, with live free times.
How it works
The shop turns on the API
In Cashiar, the owner opens Settings › Developers and creates a publishable key (pk_live_…). It belongs to that shop only.
Your code sends the key
Every request carries it: Authorization: Bearer pk_live_…. The key is safe in a browser or an app. It can only read what the shop's online store shows and place orders and bookings.
Cashiar does the rest
Prices, taxes, stock, opening hours, delivery fees, payment links and the shop's own rules are applied for you, exactly as on the Cashiar store.
One API, the same rules as the Cashiar store
The Storefront API answers from the same code as the shop's Cashiar store. A product the store hides, a price list it doesn't offer, or an order it would refuse while closed is the same through the API.
Base URL
https://api.cashiar.app/v1/storefrontAll requests use HTTPS and JSON. Amounts are whole numbers in the currency's smallest unit (pesewas for cedis): see Money and prices.