Optimizely

Optimizely Product Related Products API

The Product Related Products API from Optimizely — 5 operation(s) for product 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/ProductRelatedProducts List related-product links · Returns the EntitySet ProductRelatedProducts #
Ask an LLM
“Which cross-sell and related-product links are set up in my catalog?”
“Can I filter related-product links to one product?”
Tell an agent
List all related-product links.
List related-product links matching {filter}.
POST /api/v1/admin/ProductRelatedProducts Link a related product to a product · Post a new entity to EntitySet ProductRelatedProducts #
Ask an LLM
“How do I mark one product as related to another?”
“Can I control the display order of a related product?”
Tell an agent
Relate product {relatedProductId} to product {productId}.
Link {relatedProductId} to {productId} as relationship type {systemListValueId} at sort order {sortOrder}.
GET /api/v1/admin/ProductRelatedProducts({id}) Get a related-product link · Returns the entity with the key from ProductRelatedProducts #
Ask an LLM
“What two products does a related-product record connect?”
“Can I fetch one related-product link by id?”
Tell an agent
Get related-product link {id}.
Fetch product relationship {id} expanding {expand}.
PUT /api/v1/admin/ProductRelatedProducts({id}) Replace a related-product link · Replace entity in EntitySet ProductRelatedProducts #
Ask an LLM
“How do I overwrite a related-product link completely?”
“Can I resend both products and the relationship type to replace a link?”
Tell an agent
Replace related-product link {id} so {productId} relates to {relatedProductId}.
Overwrite the full relationship record {id} with type {systemListValueId}.
DELETE /api/v1/admin/ProductRelatedProducts({id}) Remove a related-product link · Delete entity in EntitySet ProductRelatedProducts #
Ask an LLM
“How do I unlink a related product from a product?”
“Can a related-product delete be guarded by an If-Match ETag?”
Tell an agent destructive · confirm first
Delete related-product link {id}.
Remove product relationship {id} only if its ETag is {etag}.
PATCH /api/v1/admin/ProductRelatedProducts({id}) Reorder or retarget a related-product link · Update entity in EntitySet ProductRelatedProducts #
Ask an LLM
“Can I change just the sort order of a related product?”
“How do I swap the related product on an existing link?”
Tell an agent
Set sort order of related-product link {id} to {sortOrder}.
Point relationship {id} at related product {relatedProductId}.
GET /api/v1/admin/ProductRelatedProducts/Default.Default() Get default values for a new related-product link · Call operation Default #
Ask an LLM
“What defaults does a new related-product link start with?”
“Is there a blank product relationship template?”
Tell an agent
Get the default template for a related-product link.
Fetch an empty product relationship with default values.
DELETE /api/v1/admin/productrelatedproducts/delete Bulk delete related-product links · Product related products delete route #
Ask an LLM
“Can I remove many related-product links in one request?”
“How do I bulk-delete product relationships by id?”
Tell an agent destructive · confirm first
Bulk delete related-product links {ids}.
Permanently remove every product relationship in {ids}.
GET /api/v1/admin/productrelatedproducts({key})/customproperties({custompropertyKey}) Get a custom property on a related-product link · Product related products get custom property by key and custompropertykey #
Ask an LLM
“What custom property values are stored on a product relationship?”
“Can I read one custom attribute of a related-product link?”
Tell an agent
Get custom property {custompropertyKey} on related-product link {key}.
Read extra attribute {custompropertyKey} of product relationship {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-product-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-product-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-product-related-products-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Product Related Products API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Product Related Products
paths:
  /api/v1/admin/ProductRelatedProducts:
    get:
      tags:
      - Product Related Products
      summary: Returns the EntitySet ProductRelatedProducts
      operationId: ProductRelatedProducts_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:
      - Product Related Products
      summary: Post a new entity to EntitySet ProductRelatedProducts
      operationId: ProductRelatedProducts_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.ProductRelatedProduct'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ProductRelatedProducts({id}):
    get:
      tags:
      - Product Related Products
      summary: Returns the entity with the key from ProductRelatedProducts
      operationId: ProductRelatedProducts_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:
      - Product Related Products
      summary: Replace entity in EntitySet ProductRelatedProducts
      operationId: ProductRelatedProducts_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.ProductRelatedProduct'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Product Related Products
      summary: Delete entity in EntitySet ProductRelatedProducts
      operationId: ProductRelatedProducts_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:
      - Product Related Products
      summary: Update entity in EntitySet ProductRelatedProducts
      operationId: ProductRelatedProducts_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.ProductRelatedProduct'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ProductRelatedProducts/Default.Default():
    get:
      tags:
      - Product Related Products
      summary: Call operation Default
      operationId: ProductRelatedProducts_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/productrelatedproducts/delete:
    delete:
      tags:
      - Product Related Products
      operationId: ProductRelatedProducts_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: Product related products delete route
      x-summary-source: derived
  /api/v1/admin/productrelatedproducts({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Product Related Products
      operationId: ProductRelatedProducts_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: Product related products get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.ProductRelatedProduct:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        productId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        relatedProductId:
          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