Articles on: API & Integrations

Clinicea Inventory, Service & Address Book – Make Available API Integration Guide

Use these endpoints to make a Service, Inventory item, or Address Book contact available for one clinic — the same outcome as toggling Make Available in the Clinicea App for that clinic.


1. Overview

Make Available marks a master item as available for one clinic so it can be used there (for example in billing, stock, or address book workflows).
•  API version: v3.
•  Scope is always one clinic (organisationID). Applying to a circle or all clinics is not supported.
•  There is no Make Unavailable API. Removing availability remains an App-only action.

Environment

Base URL

Production

https://api.clinicea.com




1.1 Swagger
Interactive API docs (Swagger UI):
•  Inventory makeAvailable: https://api.clinicea.com/swagger/ui/index#!/Inventory/Inventory_makeAvailable
•  Services makeAvailable: https://api.clinicea.com/swagger/ui/index#!/Services/Services_makeAvailable
•  AddressBook makeAvailable: https://api.clinicea.com/swagger/ui/index#!/AddressBook/AddressBook_makeAvailable


2. Endpoints

Method: HTTP POST. No request body. Parameters are query string values. Success response body is boolean true.

Resource

Request path

Service

POST /api/v3/services/makeAvailable

Inventory

POST /api/v3/inventory/makeAvailable

Address Book

POST /api/v3/addressbook/makeAvailable


2.1 Query parameters

Parameter

Required

Description

organisationID

Yes

Target clinic GUID. Must belong to your organisation group.

serviceID

Yes (Services)

Service ID returned by the Services create/get APIs. Comma-separated GUIDs allowed.

inventoryID

Yes (Inventory)

Inventory ID returned by the Inventory create/get APIs. Comma-separated GUIDs allowed for batch.

addressBookID

Yes (Address Book)

Address book ID returned by the Address Book create/get APIs. Comma-separated GUIDs allowed.


For Service and Inventory, pass the master item ID from create/get — not a clinic-specific availability record id.


2.2 Example request URLs
POST /api/v3/services/makeAvailable?organisationID={clinic-guid}&serviceID={service-guid}


POST /api/v3/inventory/makeAvailable?organisationID={clinic-guid}&inventoryID={inventory-guid1},{inventory-guid2}


POST /api/v3/addressbook/makeAvailable?organisationID={clinic-guid}&addressBookID={addressbook-guid}


2.3 Success response
true


HTTP 200 with boolean true means every requested id was made available for the clinic.


3. Authentication and permissions

Auth method: pass the session token in the HTTP request header. Do not put the token on the query string.

Header

Value

token

 

Staff session token for the Clinicea login used by the integration

 


token: {your-session-token}


•  Patient logins are rejected with HTTP 401 Unauthorized ("You are not Authorized to view this content").
•  Services and Inventory require Inventory feature permission. Without it, the action returns false.
•  Address Book requires edit Address Book permission. Without it, the action returns false.
Always use HTTPS. Use a staff token for the correct environment (staging vs production) and clinic / master GUIDs for that environment.


4. Organisation preference gate

Before any item is applied, the target clinic must allow Make Available for billable items.
•  In Clinicea App: Organisation Financial preferences → enable "Show Make Available option for Billable Items".
•  If this preference is off → HTTP 400 (see Error catalogue).
Enable the preference on the target clinic before calling the API.


5. Behaviour by resource

5.1 Service
•  Makes the service available for the given clinic.
•  The service must already exist (use the ID from Services create/get).


5.2 Inventory
•  Makes the inventory item available for the given clinic.
•  The inventory item must already exist (use the ID from Inventory create/get).
•  Supports comma-separated inventoryID values in one call (processed in order; stops on first failure).


5.3 Address Book
•  Makes the address book contact available for the given clinic.
•  The contact must already exist (use the ID from Address Book create/get).


5.4 What is not supported
•  Applying to a circle or all clinics — organisationID is always a single clinic.
•  Make Unavailable / remove availability via API.


6. Processing rules

•  organisationID is mandatory and must be a GUID.
•  organisationID must belong to your organisation group.
•  The item id parameter is mandatory; each value must be a GUID (comma-separated list allowed).
•  For Service / Inventory, each id must refer to an existing master item. Missing item → error (see catalogue).
•  On first failure, processing stops and HTTP 400 is returned. Earlier ids in a batch may already have been applied.
Inventory batch tip: if you need all-or-nothing, send one inventoryID per request, or verify all items exist before calling.


7. HTTP status summary

Code

Meaning

200

Success — body true

200 + false

Missing Inventory or Address Book edit permission

400

Validation or business error — plain text body (see catalogue)

401

Patient login / not authorized


8. Error catalogue

Business errors return HTTP 400 with a plain-text message. English examples:

Situation

Example message

organisationID blank

'organisationID' is mandatory.

organisationID not a GUID

'organisationID' has to be a GUID.

Clinic not in your organisation group

Clinic was not found in this organisation group.

Make Available preference off

Make Available is not allowed for this clinic. Enable 'Show Make Available option for Billable Items' in Organisation Financial preferences.

Item id blank

Item ID is mandatory.

Item id not GUID

Item ID has to be a GUID (comma-separated GUIDs are allowed).

Service or Inventory not found

Service or Inventory was not found for the given ID.

Could not apply availability

Could not make the item available for this clinic.

Patient login

You are not Authorized to view this content (HTTP 401)


9. Integration checklist

•  Confirm the target clinic has "Show Make Available option for Billable Items" enabled.
•  Pass the staff session token in the token header (not on the URL).
•  Ensure the login has Inventory permission (or Address Book edit for addressbook).
•  Pass the clinic organisationID (clinic GUID), not the head organisation unless the clinic is the head.
•  For Service / Inventory, use the master ID from create/get APIs — not a clinic-specific availability id.
•  Call POST /api/v3/.../makeAvailable; expect true.
•  Confirm in the Clinicea App that the item is available for that clinic.

Updated on: 16/11/2026

Was this article helpful?

Share your feedback

Cancel

Thank you!