POST/api/v1/s2s/partners/pharmacies/{consumerId}/claim

Claim a console-created pharmacy

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/pharmacies/{consumerId}/claim
Authentication
X-API-Key

Request

Parameters

consumerIdstring (uuid)pathRequired
Consumer tenant identifier.
Example: 54eab075-ceac-40e1-9ea7-f83a4cf89d06
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
partnerOrgIdstringRequired
Partner-controlled pharmacy identifier assigned to the console-created consumer.
Example: pharmacy-4711

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