Skip to main content

Partner OpenAPI + Postman

Published Partner artifacts (Vendor Management subset):

ArtifactLink
OpenAPI YAML/artifacts/openapi/partner.management.v1.yaml
OpenAPI JSON/artifacts/openapi/partner.management.v1.json
Postman/artifacts/postman/partner.management.v1.postman_collection.json

Included​

  • /api/v1/service-accounts
  • /api/v1/licenses
  • /api/v1/devices
  • /api/v1/customers
  • Vendor Commerce: offers, price-books, orders, checkout-sessions (and coupons when present)

License read identity​

License list/detail responses preserve assignedCustomerId and add the canonical alias customerOrganizationId; both always contain the same value. They also expose nullable productId, customerSubscriptionId, offerVersionId, and notes, plus string issueMode and migrationState. Legacy rows may return null identity references and are not silently assigned a product by the API.

License create identity​

POST /api/v1/licenses/ additively accepts productId, customerOrganizationId, customerSubscriptionId, offerVersionId, issueMode, and notes. The historical assignedCustomerId input remains an alias; if both customer names are sent, their values must match.

  • Subscription requires Product, Customer, CustomerSubscription, OfferVersion, and policyId.
  • IndividualGrant requires Product, Customer, policyId, an authenticated actor, and a working audit sink.
  • Omitting issueMode selects the temporary LegacyCompatibility path only while that server-side compatibility switch is enabled.

These guards validate required identity presence. Exact commercial-chain relationship validation is performed by the later issue orchestration, not by cross-schema reads in this endpoint.

Excluded​

  • /api/v1/platform/* (Platform Owner)
  • /api/v1/billing/* (Platform Billing / PBL — Vendor→MyHoreca SaaS)
  • Inbound PSP webhook routes
  • Full Management admin dump / Relay Host OpenAPI

Auth​

Set Postman / client variable serviceAccountToken to your once-revealed Bearer secret. Host: https://management-api.<domain> (replace the example host in the artifact).

PBL ≠ VCM​

Partner automation is about Vendor Commerce (customer pays the Vendor). Platform Billing invoices are a different product surface and stay out of this OpenAPI.

Related​