SAP Commerce Cloud

opencollection: 1.0.0
info:
  name: SAP Commerce Cloud Product Content Management API
  version: '2.0'
request:
  auth:
    type: oauth2
    flow: client_credentials
    accessTokenUrl: https://{tenant}.{region}.commercecloud.sap/authorizationserver/oauth/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Products
    type: folder
  items:
  - info:
      name: SAP Commerce Cloud Get product content
      type: http
    http:
      method: GET
      url: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}/products/:productCode
      params:
      - name: productCode
        value: ''
        type: path
        description: Product code
      - name: fields
        value: ''
        type: query
        description: Response field configuration level. Use BASIC, DEFAULT, or FULL to control the amount of data returned.
    docs: Retrieve full product content including descriptions, images, classifications, and attributes.
  - info:
      name: SAP Commerce Cloud Get product references
      type: http
    http:
      method: GET
      url: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}/products/:productCode/references
      params:
      - name: productCode
        value: ''
        type: path
        description: Product code
      - name: referenceType
        value: ''
        type: query
        description: Type of reference to filter by
      - name: fields
        value: ''
        type: query
        description: Response field configuration level. Use BASIC, DEFAULT, or FULL to control the amount of data returned.
    docs: Retrieve product references such as similar products, accessories, cross-sells, and up-sells.
  - info:
      name: SAP Commerce Cloud Get product search suggestions
      type: http
    http:
      method: GET
      url: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}/products/suggestions
      params:
      - name: term
        value: ''
        type: query
        description: Partial search term
      - name: max
        value: ''
        type: query
        description: Maximum number of suggestions
      - name: fields
        value: ''
        type: query
        description: Response field configuration level. Use BASIC, DEFAULT, or FULL to control the amount of data returned.
    docs: Retrieve autocomplete suggestions based on a partial search term.
  - info:
      name: SAP Commerce Cloud Get recently updated products
      type: http
    http:
      method: GET
      url: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}/products/expressupdate
      params:
      - name: timestamp
        value: ''
        type: query
        description: ISO 8601 timestamp for change detection
      - name: catalog
        value: ''
        type: query
        description: Catalog identifier to filter by
      - name: fields
        value: ''
        type: query
        description: Response field configuration level. Use BASIC, DEFAULT, or FULL to control the amount of data returned.
    docs: Retrieve a list of products that have been modified since a given timestamp, useful for content synchronization.
- info:
    name: Media
    type: folder
  items:
  - info:
      name: SAP Commerce Cloud Get product images
      type: http
    http:
      method: GET
      url: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}/products/:productCode/images
      params:
      - name: productCode
        value: ''
        type: path
        description: Product code
      - name: fields
        value: ''
        type: query
        description: Response field configuration level. Use BASIC, DEFAULT, or FULL to control the amount of data returned.
    docs: Retrieve all images associated with a product, including primary, gallery, and zoom images.
- info:
    name: Catalogs
    type: folder
  items:
  - info:
      name: SAP Commerce Cloud Get catalog version details
      type: http
    http:
      method: GET
      url: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}/catalogs/:catalogId/:catalogVersionId
      params:
      - name: catalogId
        value: ''
        type: path
        description: Catalog identifier
      - name: catalogVersionId
        value: ''
        type: path
        description: Catalog version (e.g., Online, Staged)
      - name: fields
        value: ''
        type: query
        description: Response field configuration level. Use BASIC, DEFAULT, or FULL to control the amount of data returned.
    docs: Retrieve details of a specific catalog version including categories and their content.
- info:
    name: Categories
    type: folder
  items:
  - info:
      name: SAP Commerce Cloud Get category content
      type: http
    http:
      method: GET
      url: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}/catalogs/:catalogId/:catalogVersionId/categories/:categoryId
      params:
      - name: catalogId
        value: ''
        type: path
        description: Catalog identifier
      - name: catalogVersionId
        value: ''
        type: path
        description: Catalog version identifier
      - name: categoryId
        value: ''
        type: path
        description: Category identifier
      - name: fields
        value: ''
        type: query
        description: Response field configuration level. Use BASIC, DEFAULT, or FULL to control the amount of data returned.
    docs: Retrieve content for a specific category including images, descriptions, and subcategories.
- info:
    name: Classifications
    type: folder
  items:
  - info:
      name: SAP Commerce Cloud Get product classifications
      type: http
    http:
      method: GET
      url: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}/products/:productCode/classifications
      params:
      - name: productCode
        value: ''
        type: path
        description: Product code
      - name: fields
        value: ''
        type: query
        description: Response field configuration level. Use BASIC, DEFAULT, or FULL to control the amount of data returned.
    docs: Retrieve classification attributes and feature values for a product across classification categories.
bundled: true