Optimizely

Optimizely Category Related Products API

The Category Related Products API from Optimizely — 5 operation(s) for category related products.

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/CategoryRelatedProducts List category related products · Returns the EntitySet CategoryRelatedProducts #
Ask an LLM
“Which products are linked as related products to my catalog categories?”
“Can I filter category related products to a single category?”
Tell an agent
List all category related products.
List category related products matching {filter}.
POST /api/v1/admin/CategoryRelatedProducts Relate a product to a category · Post a new entity to EntitySet CategoryRelatedProducts #
Ask an LLM
“How do I link a related product to a category?”
“Can I set a sort order when relating a product to a category?”
Tell an agent
Relate product {productId} to category {categoryId}.
Add product {productId} to category {categoryId} at sort order {sortOrder}.
GET /api/v1/admin/CategoryRelatedProducts({id}) Get a category related product link · Returns the entity with the key from CategoryRelatedProducts #
Ask an LLM
“What category and product does one related-product record connect?”
“Can I fetch one category related product by its ID?”
Tell an agent
Get category related product {id}.
Show the category-product link {id}.
PUT /api/v1/admin/CategoryRelatedProducts({id}) Replace a category related product link · Replace entity in EntitySet CategoryRelatedProducts #
Ask an LLM
“How do I overwrite a category related product record completely?”
“Does replacing a category-product link reset fields I leave out?”
Tell an agent
Replace category related product {id} so it links product {productId} to category {categoryId}.
Overwrite all fields of category-product link {id}.
DELETE /api/v1/admin/CategoryRelatedProducts({id}) Delete a category related product link · Delete entity in EntitySet CategoryRelatedProducts #
Ask an LLM
“Can I unlink a related product from a category by the record ID?”
“Is it possible to delete a category-product link only if the ETag matches?”
Tell an agent destructive · confirm first
Delete category related product {id}.
Delete category-product link {id} if its ETag is {etag}.
PATCH /api/v1/admin/CategoryRelatedProducts({id}) Update a category related product link · Update entity in EntitySet CategoryRelatedProducts #
Ask an LLM
“How do I change the position of a related product within a category?”
“Can I change the relation type on an existing category-product link?”
Tell an agent
Set the sort order of category related product {id} to {sortOrder}.
Change the relation type of category-product link {id} to system list value {systemListValueId}.
GET /api/v1/admin/CategoryRelatedProducts/Default.Default() Get a blank category related product template · Call operation Default #
Ask an LLM
“What default values does a new category related product have?”
“Can I fetch an empty category-product link template?”
Tell an agent
Fetch the default category related product template.
Show the starting values for a new category-product link.
DELETE /api/v1/admin/categoryrelatedproducts/delete Bulk delete category related products · Category related products delete route #
Ask an LLM
“Can I remove many category-product links at once?”
“How do I bulk delete category related products by ID?”
Tell an agent destructive · confirm first
Bulk delete category related products {ids}.
Remove these category-product links together: {ids}.
GET /api/v1/admin/categoryrelatedproducts({key})/customproperties({custompropertyKey}) Get a custom property on a category product link · Category related products get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property stored on a category related product?”
“What extra custom values does a category-product link carry?”
Tell an agent
Get custom property {custompropertyKey} on category related product {key}.
Show category-product link {key}'s custom property {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-category-related-products-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optimizely:optimizely-category-related-products-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-category-related-products-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Category Related Products API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Category Related Products
paths:
  /api/v1/admin/CategoryRelatedProducts:
    get:
      tags:
      - Category Related Products
      summary: Returns the EntitySet CategoryRelatedProducts
      operationId: CategoryRelatedProducts_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Category Related Products
      summary: Post a new entity to EntitySet CategoryRelatedProducts
      operationId: CategoryRelatedProducts_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CategoryRelatedProduct'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CategoryRelatedProducts({id}):
    get:
      tags:
      - Category Related Products
      summary: Returns the entity with the key from CategoryRelatedProducts
      operationId: CategoryRelatedProducts_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Category Related Products
      summary: Replace entity in EntitySet CategoryRelatedProducts
      operationId: CategoryRelatedProducts_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CategoryRelatedProduct'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Category Related Products
      summary: Delete entity in EntitySet CategoryRelatedProducts
      operationId: CategoryRelatedProducts_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Category Related Products
      summary: Update entity in EntitySet CategoryRelatedProducts
      operationId: CategoryRelatedProducts_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CategoryRelatedProduct'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CategoryRelatedProducts/Default.Default():
    get:
      tags:
      - Category Related Products
      summary: Call operation Default
      operationId: CategoryRelatedProducts_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/categoryrelatedproducts/delete:
    delete:
      tags:
      - Category Related Products
      operationId: CategoryRelatedProducts_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Category related products delete route
      x-summary-source: derived
  /api/v1/admin/categoryrelatedproducts({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Category Related Products
      operationId: CategoryRelatedProducts_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Category related products get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.CategoryRelatedProduct:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        categoryId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        productId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        systemListValueId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        sortOrder:
          format: int32
          type: integer
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query