Download API contract
Preview documentation / simulated contract (draft). Schemas and examples reflect the planned Commerce API v1 — final values will be confirmed when the production contract is frozen.
Contract draft 2026.07.11-draft.1
Below we provide a simulated, complete OpenAPI 3.1 contract covering all endpoints from the universal Commerce API plan. Use it for review, trial codegen, and validating examples in this documentation. After freeze, checksum and version string will be set for production.
Download
- File: commerce-api-v1.yaml
- Version:
2026.07.11-draft.1 - SHA-256:
7ea492936b867ded734f80c6b7a99ab84c4ba8a48a9ab71e8241eae7123e758e
curl -fsSL https://docs.callbotagent.ai/assets/openapi/commerce-api-v1.yaml -o commerce-api-v1.yaml
echo "7ea492936b867ded734f80c6b7a99ab84c4ba8a48a9ab71e8241eae7123e758e commerce-api-v1.yaml" | shasum -a 256 -c -
What the contract includes
- Discovery:
/capabilities,/configuration/effective - Catalog: batch / list / detail / archive
- Customers: upsert / detail / anonymize
- Orders + repurchase intents + cancel
- Results + call attempts
- Sales rules CRUD
- Webhook subscription, secret rotate, test, deliveries, replay
- Problem Details, scopes (
x-required-scope), pagination
Alignment with reference
Pages in API reference are generated from the same operation set as the YAML — we do not maintain a separate, diverging endpoint list by hand.
Usage
- client codegen (your own — no official SDK),
- request/response validation in CI,
- import into OpenAPI browsing tools.