Optimizely Customer Products API

The Customer Products API from Optimizely — 5 operation(s) for customer products.

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/CustomerProducts List customer-specific product names · Returns the EntitySet CustomerProducts #
Ask an LLM
“Which customers have their own part names for my products?”
“Can I filter customer product mappings to one customer?”
Tell an agent
List all customer products.
List customer products where {filter}.
POST /api/v1/admin/CustomerProducts Map a product to a customer's own part name · Post a new entity to EntitySet CustomerProducts #
Ask an LLM
“How do I give a B2B customer their own name for one of my products?”
“Can I set the unit of measure on a customer's product alias?”
Tell an agent
Create customer product {name} for customer {customerId} and product {productId}.
Add a customer product alias {name} sold per {unitOfMeasure}.
GET /api/v1/admin/CustomerProducts({id}) Get a customer product by id · Returns the entity with the key from CustomerProducts #
Ask an LLM
“What part name does one customer product mapping use?”
“Can I look up a single customer product record by id?”
Tell an agent
Get customer product {id}.
Fetch customer product {id} with {expand} expanded.
PUT /api/v1/admin/CustomerProducts({id}) Replace a customer product mapping · Replace entity in EntitySet CustomerProducts #
Ask an LLM
“How do I overwrite a whole customer product record at once?”
“What must I send to fully replace a customer product mapping?”
Tell an agent
Replace customer product {id} with name {name} and unit {unitOfMeasure}.
Overwrite customer product {id} to point at product {productId}.
DELETE /api/v1/admin/CustomerProducts({id}) Delete a customer product mapping · Delete entity in EntitySet CustomerProducts #
Ask an LLM
“Can I remove one customer's product alias by its id?”
“Does deleting a customer product accept an If-Match ETag?”
Tell an agent destructive · confirm first
Delete customer product {id}.
Delete customer product {id} if its ETag is {etag}.
PATCH /api/v1/admin/CustomerProducts({id}) Rename a customer product mapping · Update entity in EntitySet CustomerProducts #
Ask an LLM
“How do I change just the name a customer uses for a product?”
“Can I update a customer product's unit of measure alone?”
Tell an agent
Rename customer product {id} to {name}.
Change the unit of measure on customer product {id} to {unitOfMeasure}.
GET /api/v1/admin/CustomerProducts/Default.Default() Get a blank customer product template · Call operation Default #
Ask an LLM
“What default values does a new customer product start with?”
“Is there an empty customer product template to fill in?”
Tell an agent
Get the default customer product template.
Show the defaults for a new customer product.
DELETE /api/v1/admin/customerproducts/delete Bulk delete customer products · Customer products delete route #
Ask an LLM
“Can I delete several customer product mappings at once?”
“How do I remove a batch of customer products by id?”
Tell an agent destructive · confirm first
Bulk delete customer products {ids}.
Remove the customer products with ids {ids}.
GET /api/v1/admin/customerproducts({key})/customproperties({custompropertyKey}) Get a custom property of a customer product · Customer products get custom property by key and custompropertykey #
Ask an LLM
“What custom property values are stored on a customer product?”
“Can I read one extension field from a customer product mapping?”
Tell an agent
Get custom property {custompropertyKey} of customer product {key}.
Read custom field {custompropertyKey} on customer product {key}.

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-customer-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.

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

OpenAPI Specification

optimizely-customer-products-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Customer Products API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Customer Products
paths:
  /api/v1/admin/CustomerProducts:
    get:
      tags:
      - Customer Products
      summary: Returns the EntitySet CustomerProducts
      operationId: CustomerProducts_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:
      - Customer Products
      summary: Post a new entity to EntitySet CustomerProducts
      operationId: CustomerProducts_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.CustomerProduct'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CustomerProducts({id}):
    get:
      tags:
      - Customer Products
      summary: Returns the entity with the key from CustomerProducts
      operationId: CustomerProducts_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:
      - Customer Products
      summary: Replace entity in EntitySet CustomerProducts
      operationId: CustomerProducts_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.CustomerProduct'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Customer Products
      summary: Delete entity in EntitySet CustomerProducts
      operationId: CustomerProducts_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:
      - Customer Products
      summary: Update entity in EntitySet CustomerProducts
      operationId: CustomerProducts_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.CustomerProduct'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/CustomerProducts/Default.Default():
    get:
      tags:
      - Customer Products
      summary: Call operation Default
      operationId: CustomerProducts_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/customerproducts/delete:
    delete:
      tags:
      - Customer Products
      operationId: CustomerProducts_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: Customer products delete route
      x-summary-source: derived
  /api/v1/admin/customerproducts({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Customer Products
      operationId: CustomerProducts_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: Customer products get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.CustomerProduct:
      required:
      - name
      - unitOfMeasure
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        customerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        productId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 50
          minLength: 0
          type: string
        unitOfMeasure:
          maxLength: 50
          minLength: 0
          type: string
        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