Skip to main content

API lifecycle

Every operation in the generated reference has an x-lifecycle value.

StateMeaningIntegration guidance
StableActive owner contract with compatibility guarantees for this versionSafe for production after tenant activation and conformance testing
PreviewImplemented, but the owner contract is draft or rollout proof remainsPilot only; pin your integration and review release notes
DeprecatedAccepted only during a migration windowMove before the removal date

Current v1 projection:

  • stable: catalog schema/product sync, reconciliation, assistant bootstrap, public-chat runtime, signed webhook ingress;
  • preview: direct search and managed product media.

A live route is not automatically stable. Stability follows the owner contract, tests, and rollout proof.