External Pharmacy API
The External Pharmacy API enables pharmacies to manage their orders, update stock levels, and receive real-time notifications about order changes.Base Path
Interactive API Documentation (Swagger)
A live Swagger UI is available for exploring and testing endpoints directly in your browser:Authentication
All endpoints require an API key via theX-API-Key header. See Authentication for details.
API Key Scoping
API keys can be scoped to either a single pharmacy or an entire pharmacy group:- Single-pharmacy keys are tied to one specific pharmacy. All requests are automatically scoped to that pharmacy, and no additional parameters are needed. If that pharmacy is removed, the key stops working and every request returns
401. - Group-wide keys cover all pharmacies within a pharmacy group. When using a group-wide API key, the
pharmacy_uidquery parameter is required on most endpoints to specify which pharmacy you are operating on.
Copy the pharmacy UID from the Pharmacy Portal under API Access → API Keys. A group with several pharmacies lists each pharmacy with its own UID.