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-customers-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Sap Commerce Cloud Customers API
  contact:
    name: SAP Support
    url: https://support.sap.com/
  termsOfService: https://www.sap.com/about/legal/terms-of-use.html
  version: '1.0'
  description: 'Operations tagged Customers across 2 of this provider''s published API definitions: sap-commerce-cloud-assisted-service-openapi.yml, sap-commerce-cloud-integration-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{tenant}.{region}.commercecloud.sap/assistedservicewebservices
  description: SAP Commerce Cloud Production
  variables:
    tenant:
      description: Tenant identifier
      default: my-tenant
    region:
      description: Deployment region
      default: us
- url: https://{tenant}.{region}.commercecloud.sap/odata2webservices
  description: SAP Commerce Cloud Production
  variables:
    tenant:
      description: Tenant identifier
      default: my-tenant
    region:
      description: Deployment region
      default: us
security:
- oauth2: []
tags:
- name: Customers
  description: Customer lookup and 360 view
paths:
  /customers/search:
    get:
      operationId: searchCustomers
      summary: SAP Commerce Cloud Search customers
      description: Search for customers by name, email, or customer ID. Used by customer service agents to find customer accounts.
      tags:
      - Customers
      parameters:
      - name: query
        in: query
        required: true
        description: Search query (name, email, or customer ID)
        schema:
          type: string
      - name: baseSite
        in: query
        required: true
        description: Base site identifier
        schema:
          type: string
      - $ref: '#/components/parameters/currentPage'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Customer search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerSearchPage'
        '401':
          description: Unauthorized
        '403':
          description: Agent does not have required permissions
    servers:
    - url: https://{tenant}.{region}.commercecloud.sap/assistedservicewebservices
      description: SAP Commerce Cloud Production
      variables:
        tenant:
          description: Tenant identifier
          default: my-tenant
        region:
          description: Deployment region
          default: us
  /customers/{customerId}:
    get:
      operationId: getCustomer360
      summary: SAP Commerce Cloud Get customer 360 view
      description: Retrieve a comprehensive 360-degree view of a customer including profile information, recent orders, active carts, and support tickets.
      tags:
      - Customers
      parameters:
      - $ref: '#/components/parameters/customerId'
      - name: baseSite
        in: query
        required: true
        description: Base site identifier
        schema:
          type: string
      responses:
        '200':
          description: Customer 360 data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer360Data'
        '404':
          description: Customer not found
    servers:
    - url: https://{tenant}.{region}.commercecloud.sap/assistedservicewebservices
      description: SAP Commerce Cloud Production
      variables:
        tenant:
          description: Tenant identifier
          default: my-tenant
        region:
          description: Deployment region
          default: us
  /InboundCustomer/Customers:
    get:
      operationId: listCustomers
      summary: SAP Commerce Cloud List customers
      description: Retrieve customer data through the inbound customer integration object.
      tags:
      - Customers
      parameters:
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      responses:
        '200':
          description: Customer list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ODataCustomerCollection'
    post:
      operationId: createCustomer
      summary: SAP Commerce Cloud Create or update a customer
      description: Create or update customer data through the inbound integration layer.
      tags:
      - Customers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntegrationCustomer'
      responses:
        '201':
          description: Customer created
        '400':
          description: Invalid customer data
    servers:
    - url: https://{tenant}.{region}.commercecloud.sap/odata2webservices
      description: SAP Commerce Cloud Production
      variables:
        tenant:
          description: Tenant identifier
          default: my-tenant
        region:
          description: Deployment region
          default: us
components:
  schemas:
    TicketSummary:
      type: object
      properties:
        id:
          type: string
          description: Ticket identifier
        subject:
          type: string
          description: Ticket subject
        status:
          type: string
          description: Ticket status
        created:
          type: string
          format: date-time
          description: Ticket creation date
    Customer360Data:
      type: object
      properties:
        overview:
          type: object
          properties:
            name:
              type: string
              description: Customer name
            email:
              type: string
              description: Customer email
            signedUpDate:
              type: string
              format: date-time
              description: Registration date
            address:
              type: object
              properties:
                town:
                  type: string
                country:
                  type: string
        latestActivity:
          type: object
          properties:
            type:
              type: string
              description: Activity type
            description:
              type: string
              description: Activity description
            date:
              type: string
              format: date-time
        recentOrders:
          type: array
          items:
            $ref: '#/components/schemas/OrderSummary'
        activeCarts:
          type: array
          items:
            $ref: '#/components/schemas/CartSummary'
        supportTickets:
          type: array
          items:
            $ref: '#/components/schemas/TicketSummary'
    CartSummary:
      type: object
      properties:
        code:
          type: string
          description: Cart code
        totalItems:
          type: integer
          description: Number of items
        total:
          type: string
          description: Formatted cart total
        modified:
          type: string
          format: date-time
          description: Last modification time
    OrderSummary:
      type: object
      properties:
        code:
          type: string
          description: Order code
        status:
          type: string
          description: Order status
        total:
          type: string
          description: Formatted order total
        placed:
          type: string
          format: date-time
          description: Order placement date
    CustomerSearchPage:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/CustomerSearchEntry'
        pagination:
          $ref: '#/components/schemas/Pagination'
    CustomerSearchEntry:
      type: object
      properties:
        uid:
          type: string
          description: Customer email or UID
        name:
          type: string
          description: Customer full name
        customerId:
          type: string
          description: Customer ID
        lastCartId:
          type: string
          description: ID of the customer's most recent cart
        hasOrder:
          type: boolean
          description: Whether the customer has placed orders
    Pagination:
      type: object
      properties:
        currentPage:
          type: integer
          description: Current page number
        pageSize:
          type: integer
          description: Number of results per page
        totalPages:
          type: integer
          description: Total number of pages
        totalResults:
          type: integer
          description: Total number of results
    ODataCustomerCollection:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/IntegrationCustomer'
    IntegrationCustomer:
      type: object
      properties:
        uid:
          type: string
          description: Customer unique identifier
        name:
          type: string
          description: Customer full name
        customerID:
          type: string
          description: Customer ID
        addresses:
          type: array
          items:
            type: object
            properties:
              streetname:
                type: string
              streetnumber:
                type: string
              postalcode:
                type: string
              town:
                type: string
              country:
                type: string
          description: Customer addresses
        integrationKey:
          type: string
          description: Unique integration key
  parameters:
    pageSize:
      name: pageSize
      in: query
      description: Number of results per page
      schema:
        type: integer
        default: 20
    currentPage:
      name: currentPage
      in: query
      description: Current page number (zero-based)
      schema:
        type: integer
        default: 0
    customerId:
      name: customerId
      in: path
      required: true
      description: Customer unique identifier
      schema:
        type: string
    select:
      name: $select
      in: query
      description: Comma-separated list of properties to return
      schema:
        type: string
    top:
      name: $top
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
    filter:
      name: $filter
      in: query
      description: OData filter expression
      schema:
        type: string
    skip:
      name: $skip
      in: query
      description: Number of results to skip
      schema:
        type: integer
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication for SAP Commerce Cloud
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.{region}.commercecloud.sap/authorizationserver/oauth/token
          scopes:
            basic: Basic access
            assistedservicegroup: Assisted service agent access
x-refined-from:
- sap-commerce-cloud-assisted-service-openapi.yml
- sap-commerce-cloud-integration-openapi.yml