Optimizely Catalog Entry Relations API

openapi: 3.2.0
info:
  title: Optimizely Commerce Service Catalog Entry Relations 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 Entry Relations
  description: Manage relationships between catalog entries and nodes.
paths:
  /commerce/entries/{entryCode}/noderelations:
    get:
      operationId: getEntryNodeRelations
      summary: Get entry node relations
      description: Retrieves the node relations for a specific catalog entry.
      tags:
      - Catalog Entry Relations
      parameters:
      - $ref: '#/components/parameters/entryCode'
      responses:
        '200':
          description: Successfully retrieved entry node relations
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NodeRelation'
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Catalog entry not found
    put:
      operationId: updateEntryNodeRelations
      summary: Update entry node relations
      description: Updates the node relations for a specific catalog entry.
      tags:
      - Catalog Entry Relations
      parameters:
      - $ref: '#/components/parameters/entryCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/NodeRelationInput'
      responses:
        '200':
          description: Node relations successfully updated
        '400':
          description: Invalid request body
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Catalog entry not found
components:
  schemas:
    NodeRelationInput:
      type: object
      description: Input for creating or updating a node relation
      properties:
        node_code:
          type: string
          description: Code of the related node
        sort_order:
          type: integer
          description: Sort order within the node
    NodeRelation:
      type: object
      description: Relationship between a catalog entry and a node
      properties:
        node_code:
          type: string
          description: Code of the related node
        catalog_name:
          type: string
          description: Name of the catalog
        sort_order:
          type: integer
          description: Sort order within the node
  parameters:
    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