Optimizely Catalog Entries API

openapi: 3.2.0
info:
  title: Optimizely Commerce Service Catalog Entries 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: Catalog Entries
  description: Manage catalog entries including products, variants, packages, and bundles.
paths:
  /commerce/entries/{entryCode}:
    get:
      operationId: getCatalogEntry
      summary: Get a catalog entry
      description: Retrieves a specific catalog entry (product, variant, package, or bundle) by its code.
      tags:
      - Catalog Entries
      parameters:
      - $ref: '#/components/parameters/entryCode'
      responses:
        '200':
          description: Successfully retrieved the catalog entry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogEntry'
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Catalog entry not found
    put:
      operationId: updateCatalogEntry
      summary: Update a catalog entry
      description: Updates the specified catalog entry with the provided fields.
      tags:
      - Catalog Entries
      parameters:
      - $ref: '#/components/parameters/entryCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CatalogEntryInput'
      responses:
        '200':
          description: Catalog entry successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogEntry'
        '400':
          description: Invalid request body
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Catalog entry not found
    delete:
      operationId: deleteCatalogEntry
      summary: Delete a catalog entry
      description: Permanently deletes the specified catalog entry.
      tags:
      - Catalog Entries
      parameters:
      - $ref: '#/components/parameters/entryCode'
      responses:
        '204':
          description: Catalog entry successfully deleted
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Catalog entry not found
  /commerce/entries/{entryCode}/commondraft/{language}:
    put:
      operationId: updateCatalogEntryDraft
      summary: Update catalog entry common draft
      description: Updates the common draft version of a catalog entry for the specified language.
      tags:
      - Catalog Entries
      parameters:
      - $ref: '#/components/parameters/entryCode'
      - $ref: '#/components/parameters/language'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CatalogEntryInput'
      responses:
        '200':
          description: Draft successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogEntry'
        '400':
          description: Invalid request body
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Catalog entry not found
components:
  schemas:
    CatalogEntryInput:
      type: object
      description: Input for creating or updating a catalog entry
      properties:
        code:
          type: string
          description: Unique code for the catalog entry
        name:
          type: string
          description: Display name of the entry
        entry_type:
          type: string
          description: Type of catalog entry
          enum:
          - Product
          - Variation
          - Package
          - Bundle
        is_active:
          type: boolean
          description: Whether the entry is active
        properties:
          type: object
          description: Dynamic properties specific to the entry type
          additionalProperties: true
    CatalogEntry:
      type: object
      description: A catalog entry (product, variant, package, or bundle)
      properties:
        code:
          type: string
          description: Unique code for the catalog entry
        name:
          type: string
          description: Display name of the entry
        entry_type:
          type: string
          description: Type of catalog entry
          enum:
          - Product
          - Variation
          - Package
          - Bundle
        start_date:
          type: string
          format: date-time
          description: Availability start date
        end_date:
          type: string
          format: date-time
          description: Availability end date
        is_active:
          type: boolean
          description: Whether the entry is active
        properties:
          type: object
          description: Dynamic properties specific to the entry type
          additionalProperties: true
        prices:
          type: array
          description: Price information for the entry
          items:
            type: object
            properties:
              currency:
                type: string
                description: Currency code
              amount:
                type: number
                description: Price amount
              market_id:
                type: string
                description: Market identifier
  parameters:
    language:
      name: language
      in: path
      required: true
      description: The language code for the content version
      schema:
        type: string
    entryCode:
      name: entryCode
      in: path
      required: true
      description: The unique code of the catalog entry
      schema:
        type: string
  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