OpenAPI reference
Start from the canonical API contract when you need typed clients or a conventional integration.
Human overview for the OpenAPI 3.1 surface, with links to the canonical JSON spec and client-generation guide.
The API reference is the human entry point for Aly's OpenAPI surface. The machine-readable spec stays on aly.store so generated clients track the same production endpoint that integrations call.
Reference links
| Human reference | /api |
| OpenAPI JSON | openapi.json |
| REST overview | /rest |
| Client generation | /api/clients |
Fetch the current spec
bash
curl https://aly.store/api/storefront/v1/openapi.json -o openapi.jsonWhat it covers
- Public storefront reads for store metadata, products, collections, and search.
- Buyer-side cart and checkout endpoints.
- Bearer-gated merchant endpoints for orders, products, customers, media, analytics, and webhooks.
- Reusable request, response, and error schemas for generated clients.
Runtime endpoints stay on aly.store
docs.aly.store owns the human documentation. aly.store owns the production API, discovery documents, and OpenAPI JSON that agents and client generators consume.
Next steps
- REST API overview — understand auth, pagination, and error shape.
- Authentication — issue scoped bearer tokens.
- Generating clients — build typed clients from the spec.
Was this page helpful?