SAP Commerce Cloud Media API

openapi: 3.1.0
info:
  title: SAP Commerce Cloud Admin Addresses Media 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: Media
  description: Media and image management
paths:
  /products/{productCode}/images:
    get:
      operationId: getProductImages
      summary: SAP Commerce Cloud Get product images
      description: Retrieve all images associated with a product, including primary, gallery, and zoom images.
      tags:
      - Media
      parameters:
      - $ref: '#/components/parameters/productCode'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Product images
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageList'
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:
    ImageList:
      type: object
      properties:
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image'
    Image:
      type: object
      properties:
        url:
          type: string
          description: Image URL
        altText:
          type: string
          description: Alternative text
        format:
          type: string
          description: Image format (thumbnail, product, zoom, cartIcon)
        imageType:
          type: string
          enum:
          - PRIMARY
          - GALLERY
          description: Image type
        galleryIndex:
          type: integer
          description: Position in gallery
  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/