Optimizely Catalog Nodes API

openapi: 3.2.0
info:
  title: Optimizely Commerce Service Catalog Nodes 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 Nodes
  description: Manage catalog nodes (categories) for organizing entries.
paths:
  /commerce/nodes/{nodeCode}:
    get:
      operationId: getCatalogNode
      summary: Get a catalog node
      description: Retrieves a specific catalog node (category) by its code.
      tags:
      - Catalog Nodes
      parameters:
      - $ref: '#/components/parameters/nodeCode'
      responses:
        '200':
          description: Successfully retrieved the catalog node
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogNode'
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Catalog node not found
    put:
      operationId: updateCatalogNode
      summary: Update a catalog node
      description: Updates the specified catalog node with the provided fields.
      tags:
      - Catalog Nodes
      parameters:
      - $ref: '#/components/parameters/nodeCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CatalogNodeInput'
      responses:
        '200':
          description: Catalog node successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogNode'
        '400':
          description: Invalid request body
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Catalog node not found
    delete:
      operationId: deleteCatalogNode
      summary: Delete a catalog node
      description: Permanently deletes the specified catalog node.
      tags:
      - Catalog Nodes
      parameters:
      - $ref: '#/components/parameters/nodeCode'
      responses:
        '204':
          description: Catalog node successfully deleted
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Catalog node not found
components:
  parameters:
    nodeCode:
      name: nodeCode
      in: path
      required: true
      description: The unique code of the catalog node
      schema:
        type: string
  schemas:
    CatalogNode:
      type: object
      description: A catalog node (category)
      properties:
        code:
          type: string
          description: Unique code for the node
        name:
          type: string
          description: Display name of the node
        parent_node_code:
          type: string
          description: Code of the parent node
        catalog_name:
          type: string
          description: Name of the catalog this node belongs to
        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 node is active
        sort_order:
          type: integer
          description: Sort order for display
    CatalogNodeInput:
      type: object
      description: Input for creating or updating a catalog node
      properties:
        code:
          type: string
          description: Unique code for the node
        name:
          type: string
          description: Display name of the node
        parent_node_code:
          type: string
          description: Code of the parent node
        is_active:
          type: boolean
          description: Whether the node is active
        sort_order:
          type: integer
          description: Sort order for display
  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