Skip to main content
The Merchant API is the stable, organization-scoped commerce API for merchant backends. Its endpoint pages are rendered from the published OpenAPI contract, so request parameters and response schemas stay aligned with the running service.
Use the generated endpoint pages as the source of truth for paths, parameters, fields, and status codes. These guides explain how to use the API without duplicating the contract.

​
Explore the API

API key information

Inspect the organization and key associated with the current request.

Orders

Confirm payment status and build idempotent fulfillment.

Catalog & access

Access products, subscriptions, customers, and entitlements.

Generated schema

Inspect exact query parameters, response fields, and errors.

​
Common rules

  • The public Merchant API uses a server-side X-API-Key.
  • Every request is scoped to the organization associated with that key.
  • Successful responses use the standard response envelope; list operations return paginated data.
  • A missing or invalid key is rejected before organization data is resolved.
Never expose a Merchant API key in browser code, a mobile application, a public repository, or a customer-visible URL.