Skip to main content

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:
The Swagger UI lets you try out API calls interactively. Authenticate with your API key to test against real data.

Authentication

All endpoints require an API key via the X-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_uid query parameter is required on most endpoints to specify which pharmacy you are operating on.
If you use a group-wide API key and omit the pharmacy_uid parameter on an endpoint that requires it, the request returns 400 and names the missing parameter:
A pharmacy_uid that does not belong to the key’s pharmacy group returns 400 with the message "Pharmacy not found in the API key's pharmacy group." in the same place.
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.

Available Endpoints

Required Permissions