POST/api/v1/s2s/partners/pharmacies/{partnerOrgId}/offboarding-requests
Request partner pharmacy offboarding
Freigegebener Partner-Endpunkt aus dem stabilen OpenAPI-1.0.0-Vertrag.
Übersicht
Nutzen Sie den Endpunkt ausschließlich mit einem Partner-API-Schlüssel. Die Codebeispiele verwenden Platzhalter und die öffentliche Sandbox-Adresse.
- Methode
- POST
- Endpunkt
- /api/v1/s2s/partners/pharmacies/{partnerOrgId}/offboarding-requests
- Authentifizierung
- X-API-Key
Anfrage
Parameter
- partnerOrgIdstring (uuid)pathErforderlich
- Partner-controlled pharmacy identifier from the registration call.
- Beispiel: pharmacy-4711
- X-Correlation-IDstringheader
- Optional opaque request correlation ID for tracing API calls across systems. Billing audit paths persist only UUIDv4-shaped values and drop free-form values.
- Beispiel: 33333333-3333-4333-8333-333333333333
Request-Body
Erforderlich- effectiveAtstring (date-time)
- Optional requested effective date.
- Beispiel: 2026-08-01T00:00:00.000Z
- reasonstring
- Optional PHI-free termination reason from the partner system.
- Beispiel: Vertrag beendet
Vertrag
Der versionierte OpenAPI-Vertrag ist die verbindliche Quelle für Parameter, Request-Body und Response-Schemas.
Version
1.0.0
Erwartete Antwort
201 Created