Optimizely

Optimizely Vmi Notes API

The Vmi Notes API from Optimizely — 5 operation(s) for vmi notes.

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/VmiNotes List vendor-managed inventory notes · Returns the EntitySet VmiNotes #
Ask an LLM
“Which notes have been left on my vendor-managed inventory bins?”
“Can I filter VMI notes to one bin?”
Tell an agent
List all VMI notes.
List VMI notes matching {filter}.
POST /api/v1/admin/VmiNotes Add a note to a VMI bin · Post a new entity to EntitySet VmiNotes #
Ask an LLM
“How do I leave a note on a vendor-managed inventory bin?”
“Can a VMI note be set to print on the replenishment order?”
Tell an agent
Add note {note} to VMI bin {vmiBinId}.
Create a VMI note {note} and include it on the order: {includeOnOrder}.
GET /api/v1/admin/VmiNotes({id}) Get a VMI note · Returns the entity with the key from VmiNotes #
Ask an LLM
“What does a particular vendor-managed inventory note say?”
“Can I fetch one VMI note by id?”
Tell an agent
Get VMI note {id}.
Fetch bin note {id} expanding {expand}.
PUT /api/v1/admin/VmiNotes({id}) Replace a VMI note · Replace entity in EntitySet VmiNotes #
Ask an LLM
“How do I overwrite a VMI note record entirely?”
“Can I resend the bin and text to replace a VMI note?”
Tell an agent
Replace VMI note {id} with text {note}.
Overwrite the full bin note record {id} for bin {vmiBinId}.
DELETE /api/v1/admin/VmiNotes({id}) Delete one VMI note · Delete entity in EntitySet VmiNotes #
Ask an LLM
“How do I remove a note from a VMI bin?”
“Can deleting a VMI note be tied to an If-Match ETag?”
Tell an agent destructive · confirm first
Delete VMI note {id}.
Delete bin note {id} only if its ETag still matches {etag}.
PATCH /api/v1/admin/VmiNotes({id}) Edit a VMI note · Update entity in EntitySet VmiNotes #
Ask an LLM
“Can I change only the text of a VMI note?”
“How do I stop a VMI note from appearing on orders?”
Tell an agent
Change the text of VMI note {id} to {note}.
Set include-on-order for VMI note {id} to {includeOnOrder}.
GET /api/v1/admin/VmiNotes/Default.Default() Get default values for a new VMI note · Call operation Default #
Ask an LLM
“What defaults does a new VMI note start with?”
“Is there a blank bin note template?”
Tell an agent
Get the default template for a VMI note.
Fetch an empty bin note with default values.
DELETE /api/v1/admin/vminotes/delete Bulk delete VMI notes · Vmi notes delete route #
Ask an LLM
“Can I remove many VMI notes in one request?”
“How do I bulk-delete bin notes by id?”
Tell an agent destructive · confirm first
Bulk delete VMI notes {ids}.
Permanently remove every bin note in {ids}.
GET /api/v1/admin/vminotes({key})/customproperties({custompropertyKey}) Get a custom property on a VMI note · Vmi notes get custom property by key and custompropertykey #
Ask an LLM
“What custom property values are stored on a VMI note?”
“Can I read one custom attribute of a bin note?”
Tell an agent
Get custom property {custompropertyKey} on VMI note {key}.
Read extra attribute {custompropertyKey} of bin note {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-vmi-notes-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-vmi-notes-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-vmi-notes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Vmi Notes API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Vmi Notes
paths:
  /api/v1/admin/VmiNotes:
    get:
      tags:
      - Vmi Notes
      summary: Returns the EntitySet VmiNotes
      operationId: VmiNotes_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:
      - Vmi Notes
      summary: Post a new entity to EntitySet VmiNotes
      operationId: VmiNotes_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.VmiNote'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/VmiNotes({id}):
    get:
      tags:
      - Vmi Notes
      summary: Returns the entity with the key from VmiNotes
      operationId: VmiNotes_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:
      - Vmi Notes
      summary: Replace entity in EntitySet VmiNotes
      operationId: VmiNotes_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.VmiNote'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Vmi Notes
      summary: Delete entity in EntitySet VmiNotes
      operationId: VmiNotes_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:
      - Vmi Notes
      summary: Update entity in EntitySet VmiNotes
      operationId: VmiNotes_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.VmiNote'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/VmiNotes/Default.Default():
    get:
      tags:
      - Vmi Notes
      summary: Call operation Default
      operationId: VmiNotes_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/vminotes/delete:
    delete:
      tags:
      - Vmi Notes
      operationId: VmiNotes_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: Vmi notes delete route
      x-summary-source: derived
  /api/v1/admin/vminotes({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Vmi Notes
      operationId: VmiNotes_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: Vmi notes get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.VmiNote:
      required:
      - note
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        createdOn:
          format: date-time
          type: string
        vmiBinId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        note:
          type: string
        includeOnOrder:
          type: boolean
        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