Documentation Index
Fetch the complete documentation index at: https://docs.rxscale.com/llms.txt
Use this file to discover all available pages before exploring further.
Public API
The Public API provides access to product catalogs, prescription and treatment checkout creation, and order status queries. It is designed for customer-facing integrations such as storefronts and telemedicine platforms.Base Path
Authentication
All endpoints require an API key via theX-API-Key header. See Authentication for details.
The legacy
X-RxScale-Authorization header is also supported for backward compatibility but X-API-Key is recommended for new integrations.Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /products/{shop_identifier} | List products for a shop |
GET | /orders/{shop_identifier} | Get order status by prescription UIDs |
POST | /prescriptions/{shop_identifier} | Create a prescription-based checkout |
POST | /treatments/{shop_identifier} | Create a treatment-based checkout |
Required Permissions
| Endpoint | Required Permission |
|---|---|
| List products | product:read |
| Get order status | order:read |
| Create prescription checkout | create_prescription_checkout |
| Create treatment checkout | create_treatment_checkout |
All Public API endpoints are scoped by
shop_identifier in the URL path. The shop must belong to the organisation associated with your API key.