Getting Started
Welcome to the Acme Webshop API — the storefront API behind the Acme web shop and mobile app.
Base URL
https://api.acmewebshop.com/v2
What the API covers
flowchart LR
subgraph Clients
web[Web shop]
mobile[Mobile app]
end
api([Acme Webshop API v2])
web --> api
mobile --> api
api --> auth[Auth<br/>login & tokens]
api --> products[Products<br/>catalog & stock]
api --> orders[Orders<br/>checkout & lifecycle]
api --> customers[Customers<br/>profiles]Browsing the catalog is public; orders and customer data sit behind a bearer token — see Authentication.
Authentication in one request
curl -X POST 'https://api.acmewebshop.com/v2/auth/login' \
-H 'Content-Type: application/json' \
-d '{ "email": "you@example.com", "password": "…" }'
Use the returned token as Authorization: Bearer <token> on subsequent requests.
First request
List the catalog — no auth required:
curl 'https://api.acmewebshop.com/v2/products?category=garden-tools&pageSize=5'
Where to go next
- Authentication — the token flow, expiry, failure modes
- Order Lifecycle — states, cancellation rules
- Errors & Pagination — the two conventions every endpoint follows
- API Reference in the sidebar — every endpoint, schema and response, with a try-it console