Oquira BusinessGérez les services que vous proposez dans vos établissements.
Les services représentent les prestations réelles proposées dans vos établissements (ex: "Consultation Générale", "Support Client", "Retrait de Colis"). Chaque service peut disposer de plusieurs files d'attente.
Créez un nouveau service pour votre organisation. Les services sont liés à un emplacement physique spécifique.
POST /v1/services
X-API-Key: votre_cle_api
Content-Type: application/json
{
"name": "Consultation Générale",
"description": "Examen médical général et consultation",
"serviceTypeId": "type_123...",
"locationIds": ["loc_abc..."],
"isVirtual": false,
"maxRemoteJoinRadiusKm": 5
}| Propriété | Type | Requis | Description |
|---|---|---|---|
name | string | Oui | Nom du service. |
locationIds | string[] | Oui | Tableau des IDs des emplacements physiques. |
serviceTypeId | string | Oui | ID de la catégorie de service prédéfinie. |
isVirtual | boolean | Non | Si vrai, le service est fourni en ligne/à distance. |
maxRemoteJoinRadiusKm | number | Non | Distance max pour rejoindre à distance. |
Récupérez tous les services appartenant à votre organisation, y compris leurs files d'attente associées et leurs statistiques.
GET /v1/business/services
X-API-Key: votre_cle_apiRécupérez les détails complets d'un service spécifique.
GET /v1/services/{serviceId}
X-API-Key: votre_cle_apiModifiez la configuration ou les détails d'un service.
PATCH /v1/services/{serviceId}
X-API-Key: votre_cle_api
Content-Type: application/json
{
"name": "Consultation Urgente",
"maxRemoteJoinRadiusKm": 10
}Supprimez un service et ses files d'attente associées.
DELETE /v1/services/{serviceId}
X-API-Key: votre_cle_apiRecherchez les services au sein de votre organisation. Par défaut, seuls les services actifs sont retournés. Passez activeOnly=false pour inclure tous les services quel que soit leur statut (utile pour les tableaux de bord de gestion).
GET /v1/services/organization/search?organizationId={orgId}&activeOnly=false
X-API-Key: votre_cle_api| Paramètre | Type | Requis | Description |
|---|---|---|---|
organizationId | string | Oui | ID de l'organisation dans laquelle rechercher. |
q | string | Non | Requête de recherche pour filtrer par nom de service. |
activeOnly | boolean | Non | Si false, retourne tous les services (actifs, inactifs, en attente, rejetés). Par défaut true. |
Note : Cet endpoint nécessite la permission d'organisation
SERVICE_VIEW. Les opérateurs, managers et propriétaires peuvent tous y accéder pour voir tous les services de l'organisation — pas uniquement ceux qu'ils possèdent.
Obtenez la liste des catégories de services disponibles pour votre type d'organisation.
GET /v1/services/types?organizationType=retail
X-API-Key: votre_cle_api