SAP Commerce Cloud Consents API

User consent management

Operations 2

GET /users/{userId}/consenttemplates SAP Commerce Cloud List consent templates #
POST /users/{userId}/consents SAP Commerce Cloud Give consent #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/sap-commerce-cloud-consents-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sap-commerce-cloud-consents-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: SAP Commerce Cloud Admin Addresses Consents 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: Consents
  description: User consent management
paths:
  /users/{userId}/consenttemplates:
    get:
      operationId: getConsentTemplates
      summary: SAP Commerce Cloud List consent templates
      description: Retrieve all consent templates available for the user.
      tags:
      - Consents
      parameters:
      - $ref: '#/components/parameters/userId'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Consent templates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsentTemplateList'
  /users/{userId}/consents:
    post:
      operationId: giveConsent
      summary: SAP Commerce Cloud Give consent
      description: Give consent for a specific consent template.
      tags:
      - Consents
      parameters:
      - $ref: '#/components/parameters/userId'
      - name: consentTemplateId
        in: query
        required: true
        description: Consent template identifier
        schema:
          type: string
      - name: consentTemplateVersion
        in: query
        required: true
        description: Consent template version
        schema:
          type: integer
      responses:
        '201':
          description: Consent given
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsentTemplate'
        '400':
          description: Invalid consent request
components:
  schemas:
    ConsentTemplateList:
      type: object
      properties:
        consentTemplates:
          type: array
          items:
            $ref: '#/components/schemas/ConsentTemplate'
    ConsentTemplate:
      type: object
      properties:
        id:
          type: string
          description: Consent template identifier
        name:
          type: string
          description: Template name
        description:
          type: string
          description: Template description
        version:
          type: integer
          description: Template version
        currentConsent:
          type: object
          properties:
            consentGivenDate:
              type: string
              format: date-time
            consentWithdrawnDate:
              type: string
              format: date-time
  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
    userId:
      name: userId
      in: path
      required: true
      description: User identifier. Use 'current' for the authenticated user or 'anonymous' for guest users.
      schema:
        type: string
  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/