API reference
API reference
Every Storefront API endpoint, with its fields, examples and a playground.
Base URL: https://api.cashiar.app/v1/storefront. Every request sends the shop's publishable key: Authorization: Bearer pk_live_… (Authentication).
Shop and catalogue
| Endpoint | |
|---|---|
| GET/shop | The shop, its branch and hours, pickup and delivery, and collections. |
| GET/products | Products on sale, a page at a time. |
| GET/products/{id} | One product with its versions, packs, prices and extras. |
Orders
| Endpoint | |
|---|---|
| POST/orders | Place an order for pickup or delivery. |
| GET/orders/{id} | Where an order is. |
Bookings
| Endpoint | |
|---|---|
| GET/services | Services customers can book. |
| GET/services/times | Free start times for a service on a day. |
| POST/bookings | Book one or more services. |
The whole API is also an OpenAPI document, to generate types or a client.