POST/api/v1/s2s/partners/pharmacies

Register a partner pharmacy

Published Partner endpoint from the stable OpenAPI 1.0.0 contract.

Overview

Use this endpoint only with a Partner API key. Code samples use placeholders and the public sandbox URL.

Method
POST
Endpoint
/api/v1/s2s/partners/pharmacies
Authentication
X-API-Key

Request

Parameters

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.
Example: 33333333-3333-4333-8333-333333333333

Request body

Required
acceptedDataProcessingbooleanRequired
Must be true: the partner confirms the pharmacy accepted the data processing terms.
Example: true
partnerstringRequired
Partner channel identifier.
Example: gedisa
partnerOrgIdstringRequired
Partner-controlled pharmacy identifier in the partner namespace. Registrations are idempotent per (partner, partnerOrgId).
Example: pharmacy-4711
pharmacyobjectRequired
Pharmacy master data. All fields are required (AF-189) so the tenant is fully usable without manual follow-up.
pharmacy.addressobjectRequired
Pharmacy address.
pharmacy.address.citystringRequired
City.
Example: Hamburg
pharmacy.address.postalCodestringRequired
Postal code.
Example: 20457
pharmacy.address.streetstringRequired
Street and number.
Example: Musterstr. 1
pharmacy.desiredSlugstringRequired
Desired tenant slug.
Example: beispiel-apotheke-4711
pharmacy.organizationDisplayNamestringRequired
Pharmacy display name.
Example: Beispiel Apotheke
pharmacy.organizationLegalNamestringRequired
Legal name of the pharmacy.
Example: Beispiel Apotheke e.K.
pharmacy.primaryContactEmailstring (email)Required
Owner contact email.
Example: kontakt@example.test
pharmacy.primaryContactNamestringRequired
Owner contact of the pharmacy.
Example: Synthetischer Kontakt
pharmacy.primaryContactPhonestringRequired
Owner contact phone.
Example: +49 40 123456

Contract

The versioned OpenAPI contract is the authoritative source for parameters, request bodies, and response schemas.

Version

1.0.0

Expected response

201 Created

Download OpenAPI 1.0.0