SAP Commerce Cloud Metadata API

openapi: 3.1.0
info:
  title: SAP Commerce Cloud Admin Addresses Metadata 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: Metadata
  description: OData service metadata
paths:
  /$metadata:
    get:
      operationId: getMetadata
      summary: SAP Commerce Cloud Get service metadata
      description: Retrieve the OData service metadata document describing all available entity types and associations.
      tags:
      - Metadata
      responses:
        '200':
          description: OData metadata document
          content:
            application/xml:
              schema:
                type: string
      security: []
components:
  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/