# RM Ecommerce API

> REST API v1 of RM, a multi-tenant ecommerce platform. Each API key (`Authorization: Bearer rk_...`) belongs to one store and
> only sees that store's data. Per-area permissions (`read_`/`write_` for products, inventory, prices, customers, orders, integrations), cursor
> pagination, `Idempotency-Key` on orders and payments, 600 requests per minute per key and outgoing webhooks signed with HMAC-SHA256.
> Error message texts are returned in Spanish: rely on status codes and field names.

## Documentation

- [Online documentation](https://retail-s.online/docs/?lang=en): introduction, authentication, resources with curl examples, webhooks, errors and connector guide.
- [AI context and prompts](https://retail-s.online/docs/api-ia.en.md): compact API context and ready-to-use prompts for implementing connectors.
- [Full reference](https://retail-s.online/docs/api.en.md): business rules of each resource, in Markdown.

## Contract

- [OpenAPI 3.1](https://retail-s.online/docs/openapi.en.json): all paths, parameters, bodies, permissions and errors.
- [Postman collection](https://retail-s.online/docs/rm-api.postman_collection.en.json) and [environment](https://retail-s.online/docs/rm-api.postman_environment.json): variables `base_url` and `api_key`.

## Optional

- API base: `https://retail-s.online/api/v1` (each operation's path is appended to that base).
- [Spanish version](https://retail-s.online/llms.txt).