Optimizely Catalogs API

openapi: 3.2.0
info:
  title: Optimizely Commerce Service Catalogs API
  description: The Optimizely Commerce Service API provides RESTful access to Optimizely's e-commerce platform capabilities. It enables developers to manage product catalogs, catalog entries, catalog nodes, orders, customers, and inventory programmatically. The API supports integration with external commerce systems and enables building custom storefronts and order management workflows on top of the Optimizely Commerce platform.
  version: '1.0'
  contact:
    name: Optimizely Support
    url: https://support.optimizely.com
  termsOfService: https://www.optimizely.com/legal/terms/
servers:
- url: '{siteUrl}/episerverapi'
  description: Optimizely Commerce Service API endpoint
  variables:
    siteUrl:
      default: https://www.example.com
      description: The base URL of the Optimizely Commerce site
security:
- bearerAuth: []
tags:
- name: Catalogs
  description: Manage product catalogs that organize commerce content.
paths:
  /commerce/catalogs:
    get:
      operationId: listCatalogs
      summary: List catalogs
      description: Returns a list of all product catalogs in the commerce system.
      tags:
      - Catalogs
      responses:
        '200':
          description: Successfully retrieved catalogs
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Catalog'
        '401':
          description: Authentication credentials are missing or invalid
    post:
      operationId: createCatalog
      summary: Create a catalog
      description: Creates a new product catalog.
      tags:
      - Catalogs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CatalogInput'
      responses:
        '201':
          description: Catalog successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Catalog'
        '400':
          description: Invalid request body
        '401':
          description: Authentication credentials are missing or invalid
  /commerce/catalogs/{catalogName}:
    get:
      operationId: getCatalog
      summary: Get a catalog
      description: Retrieves the details of a specific catalog by its name.
      tags:
      - Catalogs
      parameters:
      - $ref: '#/components/parameters/catalogName'
      responses:
        '200':
          description: Successfully retrieved the catalog
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Catalog'
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Catalog not found
    put:
      operationId: updateCatalog
      summary: Update a catalog
      description: Updates the specified catalog with the provided fields.
      tags:
      - Catalogs
      parameters:
      - $ref: '#/components/parameters/catalogName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CatalogInput'
      responses:
        '200':
          description: Catalog successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Catalog'
        '400':
          description: Invalid request body
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Catalog not found
    delete:
      operationId: deleteCatalog
      summary: Delete a catalog
      description: Permanently deletes the specified catalog and its contents.
      tags:
      - Catalogs
      parameters:
      - $ref: '#/components/parameters/catalogName'
      responses:
        '204':
          description: Catalog successfully deleted
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Catalog not found
components:
  parameters:
    catalogName:
      name: catalogName
      in: path
      required: true
      description: The name of the catalog
      schema:
        type: string
  schemas:
    Catalog:
      type: object
      description: A product catalog
      properties:
        name:
          type: string
          description: Name of the catalog
        default_currency:
          type: string
          description: Default currency code
        default_language:
          type: string
          description: Default language code
        is_active:
          type: boolean
          description: Whether the catalog is active
        start_date:
          type: string
          format: date-time
          description: Catalog availability start date
        end_date:
          type: string
          format: date-time
          description: Catalog availability end date
    CatalogInput:
      type: object
      description: Input for creating or updating a catalog
      properties:
        name:
          type: string
          description: Name of the catalog
        default_currency:
          type: string
          description: Default currency code
        default_language:
          type: string
          description: Default language code
        is_active:
          type: boolean
          description: Whether the catalog is active
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token for authenticated Commerce Service API access.
externalDocs:
  description: Optimizely Commerce Service API Documentation
  url: https://docs.developers.optimizely.com/commerce-connect/v1.3.0-service-api-developer-guide/docs/optimizely-service-api