SAP Commerce Cloud Addresses API

openapi: 3.1.0
info:
  title: SAP Commerce Cloud Admin Addresses 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: Addresses
  description: User address management
paths:
  /users/{userId}/addresses:
    get:
      operationId: getUserAddresses
      summary: SAP Commerce Cloud List user addresses
      description: Retrieve all addresses for a specific user.
      tags:
      - Addresses
      parameters:
      - $ref: '#/components/parameters/userId'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: User addresses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressList'
    post:
      operationId: createUserAddress
      summary: SAP Commerce Cloud Create a user address
      description: Add a new address to the user's address book.
      tags:
      - Addresses
      parameters:
      - $ref: '#/components/parameters/userId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Address'
      responses:
        '201':
          description: Address created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address'
        '400':
          description: Invalid address data
  /users/{userId}/addresses/{addressId}:
    get:
      operationId: getUserAddress
      summary: SAP Commerce Cloud Get user address
      description: Retrieve a specific address from the user's address book.
      tags:
      - Addresses
      parameters:
      - $ref: '#/components/parameters/userId'
      - $ref: '#/components/parameters/addressId'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Address details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address'
        '404':
          description: Address not found
    patch:
      operationId: updateUserAddress
      summary: SAP Commerce Cloud Update user address
      description: Update a specific address in the user's address book.
      tags:
      - Addresses
      parameters:
      - $ref: '#/components/parameters/userId'
      - $ref: '#/components/parameters/addressId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Address'
      responses:
        '200':
          description: Address updated
        '400':
          description: Invalid address data
    delete:
      operationId: deleteUserAddress
      summary: SAP Commerce Cloud Delete user address
      description: Remove an address from the user's address book.
      tags:
      - Addresses
      parameters:
      - $ref: '#/components/parameters/userId'
      - $ref: '#/components/parameters/addressId'
      responses:
        '200':
          description: Address deleted
        '404':
          description: Address not found
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
    userId:
      name: userId
      in: path
      required: true
      description: User identifier. Use 'current' for the authenticated user or 'anonymous' for guest users.
      schema:
        type: string
    addressId:
      name: addressId
      in: path
      required: true
      description: Address identifier
      schema:
        type: string
  schemas:
    Country:
      type: object
      properties:
        isocode:
          type: string
          description: ISO 3166-1 alpha-2 country code
        name:
          type: string
          description: Country name
    Address:
      type: object
      properties:
        id:
          type: string
          description: Address identifier
        firstName:
          type: string
          description: First name
        lastName:
          type: string
          description: Last name
        titleCode:
          type: string
          description: Title code
        line1:
          type: string
          description: Address line 1
        line2:
          type: string
          description: Address line 2
        town:
          type: string
          description: City or town
        region:
          $ref: '#/components/schemas/Region'
        district:
          type: string
          description: District
        postalCode:
          type: string
          description: Postal or ZIP code
        country:
          $ref: '#/components/schemas/Country'
        phone:
          type: string
          description: Phone number
        email:
          type: string
          description: Email address
        defaultAddress:
          type: boolean
          description: Whether this is the default address
    AddressList:
      type: object
      properties:
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/Address'
    Region:
      type: object
      properties:
        isocode:
          type: string
          description: Region ISO code
        name:
          type: string
          description: Region name
  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/