Auxilia Trade API Documentation

Welcome to the Auxilia Trade API documentation.

This documentation provides high-level guidance, architectural overview, business context and human-readable descriptions of available API modules.

For interactive testing and full OpenAPI reference, use Swagger UI.

Authentication

All API requests require authentication using Bearer Token authorization.

Credentials

To access the API you need:

• ClientId
• Secret
• AppId

These credentials are used to generate an access token via the authentication endpoint.

Token configuration

• Access token lifetime: 560 minutes

Authorization

All authenticated requests must include the Bearer Token in the Authorization header:

Tokens are validated on every request and are required for all API endpoints, except explicitly public ones (e.g. documentation and token generation).

API Reference (Swagger)

Swagger UI provides a complete, machine-readable API reference generated directly from the codebase.

Use Swagger when you need to:

• test endpoints interactively
• inspect request / response schemas
• see full OpenAPI definitions
• verify required headers and parameters

👉 Open Swagger UI

API Modules

The API is divided into logical modules based on business domains. Each module has its own documentation describing services, models and endpoints.

Available modules

• Catalog
  Product catalog management, including brands, categories, products and attributes.

• Inventory
  Stock levels, warehouses and availability.

• Entities
  Customers, suppliers, and related entity data management.

• Pricing
  Prices, discounts and pricing rules.

• Sales
  Orders, customers and sales processes.

• Reference
  Reference and lookup data.
  (documentation coming soon)

Notes

• All endpoints are tenant-aware
• All state-changing operations are audited
• Internal errors are logged and not exposed to API consumers
• Swagger UI is generated automatically and reflects the current API version