Complete API Reference

Complete API Reference

Use the searchable reference below for registered customer-facing HTTP operations, including authentication, account, tenant modules and integration callbacks. The platform administrator's /admin/ API is outside this customer guide.

Download the OpenAPI JSON contract to import into a compatible client or generate a client for your own integration.

Filter by resource, method or path, then expand an operation to inspect path/query parameters, request content types, required fields, enums, defaults, constraints and response models. Nested objects can be expanded separately.

The contract is generated from registered controllers and compiled DTO/service signatures. Additional business validation still applies: permissions, company/site ownership, available stock and document status are not bypassed by a syntactically valid body. Response schemas do not guarantee that every request succeeds.

For callback endpoints with no response body, the reference explicitly describes the acknowledgement. Provider signatures or bot secrets are different from ordinary user JWT authentication. The reference does not execute live requests or accept your credentials.

Start with Authentication, Endpoint Examples and Errors and Recovery. The OpenAPI download uses placeholders/schema definitions rather than customer records or real tokens.