SAP Commerce Cloud Classifications API

Product classification and attributes

OpenAPI Specification

sap-commerce-cloud-classifications-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: SAP Commerce Cloud Admin Addresses Classifications API
  description: Administrative API for SAP Commerce Cloud providing system configuration, maintenance, monitoring, and health check capabilities. Enables programmatic access to system administration functions including cache management, CronJob execution, and system health monitoring.
  version: '1.0'
  contact:
    name: SAP Support
    url: https://support.sap.com/
  termsOfService: https://www.sap.com/about/legal/terms-of-use.html
servers:
- url: https://{tenant}.{region}.commercecloud.sap
  description: SAP Commerce Cloud Production
  variables:
    tenant:
      description: Tenant identifier
      default: my-tenant
    region:
      description: Deployment region
      default: us
security:
- oauth2: []
tags:
- name: Classifications
  description: Product classification and attributes
paths:
  /products/{productCode}/classifications:
    get:
      operationId: getProductClassifications
      summary: SAP Commerce Cloud Get product classifications
      description: Retrieve classification attributes and feature values for a product across classification categories.
      tags:
      - Classifications
      parameters:
      - $ref: '#/components/parameters/productCode'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Product classifications
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassificationList'
components:
  parameters:
    fields:
      name: fields
      in: query
      description: Response field configuration level. Use BASIC, DEFAULT, or FULL to control the amount of data returned.
      schema:
        type: string
        enum:
        - BASIC
        - DEFAULT
        - FULL
        default: DEFAULT
    productCode:
      name: productCode
      in: path
      required: true
      description: Product code
      schema:
        type: string
  schemas:
    Classification:
      type: object
      properties:
        code:
          type: string
          description: Classification category code
        name:
          type: string
          description: Classification category name
        features:
          type: array
          items:
            $ref: '#/components/schemas/Feature'
    Feature:
      type: object
      properties:
        code:
          type: string
          description: Feature code
        name:
          type: string
          description: Feature name
        comparable:
          type: boolean
          description: Whether this feature supports comparison
        featureUnit:
          type: object
          properties:
            symbol:
              type: string
            name:
              type: string
        featureValues:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
    ClassificationList:
      type: object
      properties:
        classifications:
          type: array
          items:
            $ref: '#/components/schemas/Classification'
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication for SAP Commerce Cloud Admin API
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.{region}.commercecloud.sap/authorizationserver/oauth/token
          scopes:
            admin: Administrative access
externalDocs:
  description: SAP Commerce Cloud Administration Documentation
  url: https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/