SAP Commerce Cloud Catalogs API

openapi: 3.1.0
info:
  title: SAP Commerce Cloud Admin Addresses Catalogs 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: Catalogs
  description: Catalog and category browsing
paths:
  /catalogs:
    get:
      operationId: getCatalogs
      summary: SAP Commerce Cloud List catalogs
      description: Retrieve all product catalogs available for the base site.
      tags:
      - Catalogs
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: List of catalogs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogList'
  /catalogs/{catalogId}:
    get:
      operationId: getCatalog
      summary: SAP Commerce Cloud Get catalog details
      description: Retrieve details of a specific catalog.
      tags:
      - Catalogs
      parameters:
      - name: catalogId
        in: path
        required: true
        description: Catalog identifier
        schema:
          type: string
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Catalog details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Catalog'
        '404':
          description: Catalog not found
  /catalogs/{catalogId}/{catalogVersionId}/categories/{categoryId}:
    get:
      operationId: getCatalogCategory
      summary: SAP Commerce Cloud Get category details
      description: Retrieve details of a specific category within a catalog version.
      tags:
      - Catalogs
      parameters:
      - name: catalogId
        in: path
        required: true
        description: Catalog identifier
        schema:
          type: string
      - name: catalogVersionId
        in: path
        required: true
        description: Catalog version identifier
        schema:
          type: string
      - name: categoryId
        in: path
        required: true
        description: Category identifier
        schema:
          type: string
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Category details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
        '404':
          description: Category not found
  /InboundClassification/ClassificationSystems:
    get:
      operationId: listClassificationSystems
      summary: SAP Commerce Cloud List classification systems
      description: Retrieve classification system data for product categorization.
      tags:
      - Catalogs
      parameters:
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      responses:
        '200':
          description: Classification systems
          content:
            application/json:
              schema:
                type: object
                properties:
                  d:
                    type: object
                    properties:
                      results:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
  /catalogs/{catalogId}/{catalogVersionId}:
    get:
      operationId: getCatalogVersion
      summary: SAP Commerce Cloud Get catalog version details
      description: Retrieve details of a specific catalog version including categories and their content.
      tags:
      - Catalogs
      parameters:
      - name: catalogId
        in: path
        required: true
        description: Catalog identifier
        schema:
          type: string
      - name: catalogVersionId
        in: path
        required: true
        description: Catalog version (e.g., Online, Staged)
        schema:
          type: string
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Catalog version details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogVersion_2'
        '404':
          description: Catalog version not found
components:
  schemas:
    CategoryRef:
      type: object
      properties:
        code:
          type: string
          description: Category code
        name:
          type: string
          description: Category name
        url:
          type: string
          description: Category URL
    Category:
      type: object
      properties:
        code:
          type: string
          description: Category code
        name:
          type: string
          description: Category name
        url:
          type: string
          description: Category URL
        image:
          $ref: '#/components/schemas/Image'
        subcategories:
          type: array
          items:
            $ref: '#/components/schemas/Category'
    Catalog:
      type: object
      properties:
        id:
          type: string
          description: Catalog identifier
        name:
          type: string
          description: Catalog name
        catalogVersions:
          type: array
          items:
            $ref: '#/components/schemas/CatalogVersion'
    Image:
      type: object
      properties:
        url:
          type: string
          description: Image URL
        altText:
          type: string
          description: Alternative text
        format:
          type: string
          description: Image format (e.g., thumbnail, product, zoom)
        imageType:
          type: string
          enum:
          - PRIMARY
          - GALLERY
          description: Image type
    CatalogVersion:
      type: object
      properties:
        id:
          type: string
          description: Catalog version identifier
        url:
          type: string
          description: Catalog version URL
        categories:
          type: array
          items:
            $ref: '#/components/schemas/Category'
    CatalogList:
      type: object
      properties:
        catalogs:
          type: array
          items:
            $ref: '#/components/schemas/Catalog'
    CatalogVersion_2:
      type: object
      properties:
        id:
          type: string
          description: Catalog version ID (e.g., Online, Staged)
        lastModifiedTime:
          type: string
          format: date-time
          description: Last modification timestamp
        url:
          type: string
          description: Catalog version URL
        categories:
          type: array
          items:
            $ref: '#/components/schemas/CategoryRef'
  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
    skip:
      name: $skip
      in: query
      description: Number of results to skip
      schema:
        type: integer
    filter:
      name: $filter
      in: query
      description: OData filter expression
      schema:
        type: string
    top:
      name: $top
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
  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/