Skip to main content
Version: 2.4.4

Product Management API

Comprehensive REST API for managing the product catalogue: products, clusters, categories, cluster configurations, cluster options, and their relationships.

Core capabilities​

  • Lifecycle management for products, clusters, categories, cluster configurations and cluster options, with create, read, update and delete operations.
  • Advanced search and filtering with pagination, sorting and date-range filters across every searchable surface.
  • Bulk operations that create, update, skip or remove large numbers of records in a single request while reporting per-item outcomes.
  • Hierarchical category management with multi-level category trees and per-product / per-cluster category assignments.
  • Cluster configuration describing the configurable options exposed to customers and the products selectable for each option.
  • Localized content for names, descriptions, slugs and search-engine metadata across every catalogue language.
  • External source integration linking each record to one or more upstream systems through stable source / source identifier pairs.

Authentication and security​

  • OAuth2 client credentials with bearer tokens for service-to-service integrations.
  • Scoped permissions granting fine-grained access to read and write operations per entity.
  • Schema and payload validation that surfaces business-rule violations with structured error responses.

Response standards​

  • Consistent envelope for successful responses: data plus optional informational messages and pagination metadata.
  • Structured error envelope with HTTP status, internal error code, error type and human-readable messages.
  • Per-item outcomes for bulk requests, allowing callers to detect partial successes and retry only the failing items.

Integration support​

  • Stable external identifiers allow upstream systems to reference catalogue records without knowing internal identifiers.
  • Lookup methods per endpoint accept either internal identifiers or external source / source identifier pairs.
  • Translation maintenance endpoints allow callers to remove obsolete localized variants without touching the rest of the record.

Authentication​

OAuth2 client credentials flow. Obtain an access token from the token endpoint and supply it as a bearer token on every request.

Security Scheme Type:

oauth2

OAuth Flow (clientCredentials):

Scopes:

  • products:read: Read access to products and their related data.

  • products:write: Create, update and delete products.

  • clusters:read: Read access to clusters and their related data.

  • clusters:write: Create, update and delete clusters and their products.

  • categories:read: Read access to categories and their hierarchy.

  • categories:write: Create, update and delete categories.

  • cluster-configs:read: Read access to cluster configuration templates.

  • cluster-configs:write: Create, update and delete cluster configuration templates and their settings.

  • cluster-options:read: Read access to cluster options and their selectable products.

  • cluster-options:write: Create, update and delete cluster options and manage their products.

  • relationships:read: Read access to category-to-product and category-to-cluster relationships.

  • relationships:write: Attach and detach products and clusters to categories.

  • bulk:write: Execute bulk operations across catalogue records.

  • search:read: Search and resolve identifiers across catalogue records.