Documentation
Build on top ofyour own store
A REST API over the same data the dashboard uses: products, stock, orders, customers and payments, with webhooks when something changes.
Preview
The full reference is not public yet. What is below is accurate about the API that exists today; access is granted per store on request.
Getting started
Three things before your first request
Create a store
The API is scoped to a store. Open one on the free plan if you do not have one yet.
Create a storeRequest access
API access is enabled per store. Tell us the store and what you are building.
Request accessIssue a key
Create a scoped key from the dashboard, then send it as a bearer token.
See the auth modelYour first request
Every call is a bearer token and a store-scoped path. Responses are JSON, and list endpoints are paginated.
See keys, scopes and limitscurl https://api.securemarts.com/v1/products \
-H "Authorization: Bearer $SECUREMARTS_API_KEY" \
-H "Content-Type: application/json"Coverage
What the API reaches
The same records the dashboard reads and writes. Nothing here is a separate reporting copy of your data.
Catalog & inventory
Read and write products, variants, collections and per-outlet stock levels.
Orders & fulfilment
List orders, advance their state, attach deliveries and record returns.
Customers
Customer records, addresses, order history and segment membership.
Payments & invoices
Payment records, invoices, refunds and the documents that accompany them.
Webhooks
Subscribe to order, stock, payment and customer events with signed payloads.
Storefront data
Read-only catalog and theme data for building a custom storefront.
Developer questions
No. API access is a plan feature and is enabled per store. If your plan includes it, you can issue keys from the dashboard; if it does not, the upgrade path is on the pricing page.