Storefront API
Every Storefront API operation, with its scopes, parameters, responses and request samples.
Act as one store towards its shoppers, from any site built outside ShopEazy.
- Base URL
https://api.shopeazy.co- Version
1.7.0- Authentication
- Store key: A per-store key from the console.
- Shopper session: A 14-day shopper session from POST /v1/store/shopper/session.
- Shopper ID token: A one-hour Firebase ID token from the store's sign-in tenant.
- Order access token: The accessToken from POST /v1/store/orders.
- Operations
- 25
The Storefront API lets a site built outside ShopEazy's own apps act as one store towards its shoppers. It reads the catalogue, quotes and places orders, takes payment, runs the membership flow and files enquiries.
A request carries a per-store key from the console. The key decides which store it acts for and which scopes it has. Each operation page lists the scopes it needs.
Use the typed client, @shopeazy/storefront-client, or call the API over plain HTTPS. Every operation shows a cURL sample. It also shows a client sample where the client has a method for the operation, and a fetch sample where it does not.
Money is an { amount, currency } pair in integer minor units. Lists page with limit and cursor. Errors share one envelope and one code catalogue, which Errors explains.
Read next
All operations
Store
Catalogue
Policies
Checkout
- postServer-derived totals for a cart
/v1/store/checkout/quote - postPlace an order
/v1/store/orders - getAn order and its payment status
/v1/store/orders/{id} - postOpen a hosted checkout for the order's balance
/v1/store/orders/{id}/pay - postAsk the provider whether the order is paid, and settle it if so
/v1/store/orders/{id}/confirm
Enquiries
Shopper
- postExchange a Firebase ID token for a 14-day shopper session
/v1/store/shopper/session - deleteSign the shopper out
/v1/store/shopper/session - getThe signed-in shopper and their membership of this store
/v1/store/me - getThe signed-in shopper's orders at this store
/v1/store/me/orders - getThe signed-in shopper's upcoming bookings at this store
/v1/store/me/bookings
Membership
Member review
- getList the store's members
/v1/store/members - getOne member, with KYC details and short-lived document URLs
/v1/store/members/{uid} - postApprove a membership
/v1/store/members/{uid}/approve - postDecline a membership application
/v1/store/members/{uid}/decline - postRevoke an active member's access
/v1/store/members/{uid}/revoke
Take bookings
Show open slots for a service, book one on an order, and take enquiries for the rest.
The store's public profile GET
Public profile, brand, storefront config, shipping settings, the membership gate, the shopper sign-in tenant (`auth.tenantId`) and whether a card checkout can be opened (`payments.canCharge`). No credentials or billing fields are ever returned. If the payment-provider lookup fails the store still loads, with `payments.canCharge: false`.