Optimizely

Optimizely Category Products API

The Category Products API from Optimizely — 5 operation(s) for category 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/CategoryProducts List product-to-category assignments · Returns the EntitySet CategoryProducts #
Ask an LLM
“Which products are assigned to which categories in my catalog?”
“Can I filter category assignments down to one category's products?”
Tell an agent
List all product-to-category assignments.
Find category product links matching {filter}.
POST /api/v1/admin/CategoryProducts Assign a product to a category · Post a new entity to EntitySet CategoryProducts #
Ask an LLM
“How do I put a product into a catalog category?”
“Can I mark a category as the product's primary one when I assign it?”
Tell an agent
Assign product {productId} to category {categoryId}.
Add product {productId} to category {categoryId} with primary flag {isPrimaryCategory}.
GET /api/v1/admin/CategoryProducts({id}) Get a product-to-category assignment · Returns the entity with the key from CategoryProducts #
Ask an LLM
“What product and category does a given assignment record link?”
“Is a specific category assignment the product's primary category?”
Tell an agent
Get category product assignment {id}.
Show which product and category link record {id} connects.
PUT /api/v1/admin/CategoryProducts({id}) Replace a product-to-category assignment · Replace entity in EntitySet CategoryProducts #
Ask an LLM
“How do I overwrite a whole category assignment record?”
“Does replacing a category product link reset its primary flag if I omit it?”
Tell an agent
Replace category assignment {id} so it links product {productId} to category {categoryId}.
Overwrite category product record {id} in full with category {categoryId}.
DELETE /api/v1/admin/CategoryProducts({id}) Remove a product from a category · Delete entity in EntitySet CategoryProducts #
Ask an LLM
“How do I take a product out of a category using its assignment ID?”
“Can I guard removing a category assignment with an ETag?”
Tell an agent destructive · confirm first
Delete category product assignment {id}.
Remove category link {id} only if its ETag is {etag}.
PATCH /api/v1/admin/CategoryProducts({id}) Update a product-to-category assignment · Update entity in EntitySet CategoryProducts #
Ask an LLM
“Can I make an existing category assignment the product's primary category?”
“How do I move an existing assignment to a different category?”
Tell an agent
Set the primary-category flag on assignment {id} to {isPrimaryCategory}.
Move category assignment {id} to category {categoryId}.
GET /api/v1/admin/CategoryProducts/Default.Default() Get a blank category assignment template · Call operation Default #
Ask an LLM
“What default values does a new category product link start with?”
“Is there a template record for a product-to-category assignment?”
Tell an agent
Fetch the default category product template.
Show default values for a new product-to-category assignment.
DELETE /api/v1/admin/categoryproducts/delete Bulk remove products from categories · Category products delete route #
Ask an LLM
“How do I remove many category assignments in one call?”
“Can I delete a list of product-to-category links by ID?”
Tell an agent destructive · confirm first
Bulk delete category product assignments {ids}.
Remove these product-to-category links together: {ids}.
GET /api/v1/admin/categoryproducts({key})/customproperties({custompropertyKey}) Get a custom property on a category assignment · Category products get custom property by key and custompropertykey #
Ask an LLM
“What value is stored in a custom property on a category product link?”
“Can I read one custom property of a product-to-category assignment?”
Tell an agent
Get custom property {custompropertyKey} on category product {key}.
Show category assignment {key}'s custom property {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-category-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-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-products-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Category Products API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Category Products
paths:
  /api/v1/admin/CategoryProducts:
    get:
      tags:
      - Category Products
      summary: Returns the EntitySet CategoryProducts
      operationId: CategoryProducts_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 Products
      summary: Post a new entity to EntitySet CategoryProducts
      operationId: CategoryProducts_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CategoryProduct'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CategoryProducts({id}):
    get:
      tags:
      - Category Products
      summary: Returns the entity with the key from CategoryProducts
      operationId: CategoryProducts_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 Products
      summary: Replace entity in EntitySet CategoryProducts
      operationId: CategoryProducts_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.CategoryProduct'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Category Products
      summary: Delete entity in EntitySet CategoryProducts
      operationId: CategoryProducts_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 Products
      summary: Update entity in EntitySet CategoryProducts
      operationId: CategoryProducts_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.CategoryProduct'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CategoryProducts/Default.Default():
    get:
      tags:
      - Category Products
      summary: Call operation Default
      operationId: CategoryProducts_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/categoryproducts/delete:
    delete:
      tags:
      - Category Products
      operationId: CategoryProducts_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 products delete route
      x-summary-source: derived
  /api/v1/admin/categoryproducts({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Category Products
      operationId: CategoryProducts_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 products get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.CategoryProduct:
      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
        isPrimaryCategory:
          type: boolean
        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