POST/api/v1/s2s/partners/settings-copy/preview

Preview partner pharmacy settings copy

Published Partner endpoint from the stable OpenAPI 1.10.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/settings-copy/preview
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

appointmentTypePairsarray: Explicit appointment-type pairs. Source IDs may repeat; target IDs must be unique.
appointmentTypePairs[].sourceAppointmentTypeIdstring (uuid)Required: Active appointment type in the source pharmacy.; Example: 10000000-0000-4000-8000-000000000005
appointmentTypePairs[].targetAppointmentTypeIdstring (uuid)Required: Active appointment type in the target pharmacy. Must be unique within the request.; Example: 10000000-0000-4000-8000-000000000006
sourcePartnerOrgIdstringRequired: Partner-owned source pharmacy selector.; Example: synthetic-source-01
strategystring: Conflict strategy. OVERWRITE_CONFLICTS requires a fresh Preview generated for that strategy.; Example: FAIL_ON_CONFLICT
targetPartnerOrgIdstringRequired: Partner-owned target pharmacy selector.; Example: synthetic-target-01

Contract

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

Version

1.10.0

Expected response

201 Created

Download OpenAPI 1.10.0

Simulated sandbox

Language

cURL

curl --request POST \
  --url https://sandbox.arztkonsultation.io/api/v1/s2s/partners/settings-copy/preview \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: {PARTNER_API_KEY}' \
  --data '{"appointmentTypePairs":[{"sourceAppointmentTypeId":"10000000-0000-4000-8000-000000000005","targetAppointmentTypeId":"10000000-0000-4000-8000-000000000006"}],"sourcePartnerOrgId":"synthetic-source-01","strategy":"FAIL_ON_CONFLICT","targetPartnerOrgId":"synthetic-target-01"}'

Response scenario