Optimizely Vmi Bins API

The Vmi Bins API from Optimizely — 9 operation(s) for vmi bins.

Business capability
Inventory Management BC-530

Operations 14

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/VmiBins List VMI bins · Returns the EntitySet VmiBins #
Ask an LLM
“Which vendor-managed inventory bins are set up?”
“Can I filter VMI bins by location or product?”
Tell an agent
List all VMI bins.
Find VMI bins matching {filter}.
POST /api/v1/admin/VmiBins Create a VMI bin · Post a new entity to EntitySet VmiBins #
Ask an LLM
“How do I add a new vendor-managed inventory bin at a location?”
“Can I set minimum and maximum quantities when creating a bin?”
Tell an agent
Create VMI bin {binNumber} at location {vmiLocationId} for product {productId}.
Add bin {binNumber} with a minimum of {minimumQty} and maximum of {maximumQty}.
GET /api/v1/admin/VmiBins({id}) Get a VMI bin · Returns the entity with the key from VmiBins #
Ask an LLM
“Can I see one VMI bin's last count and quantities?”
“What's stored on a specific vendor-managed inventory bin?”
Tell an agent
Show VMI bin {id}.
Get bin {id} and its last count details.
PUT /api/v1/admin/VmiBins({id}) Replace a VMI bin · Replace entity in EntitySet VmiBins #
Ask an LLM
“How do I overwrite a VMI bin record in full?”
“Does replacing a bin require resending the bin number and count user names?”
Tell an agent
Replace VMI bin {id} with a full record for bin number {binNumber}.
Overwrite all fields on bin {id}.
DELETE /api/v1/admin/VmiBins({id}) Delete a VMI bin · Delete entity in EntitySet VmiBins #
Ask an LLM
“How do I permanently delete a single VMI bin?”
“Can I guard a bin delete with an ETag?”
Tell an agent destructive · confirm first
Delete VMI bin {id}.
Delete bin {id} only if its ETag matches {etag}.
PATCH /api/v1/admin/VmiBins({id}) Update fields on a VMI bin · Update entity in EntitySet VmiBins #
Ask an LLM
“Can I change just the reorder thresholds on a VMI bin?”
“How do I record a new count quantity on a bin?”
Tell an agent
Set the minimum quantity on VMI bin {id} to {minimumQty}.
Record a last count of {lastCountQty} on bin {id}.
GET /api/v1/admin/VmiBins/Default.Default() Get default values for a new VMI bin · Call operation Default #
Ask an LLM
“What defaults does a new VMI bin start with?”
“Is there an empty VMI bin template?”
Tell an agent
Get the default VMI bin template.
Show prefilled defaults for a new bin.
POST /api/v1/admin/VmiBins/Default.archive Archive VMI bins via OData action · Call operation archive #
Ask an LLM
“Can I archive VMI bins using the OData archive action?”
“How do I retire bins with a POST instead of deleting them?”
Tell an agent
Archive VMI bins {ids} using the Default.archive action.
Run the archive action for bins {ids}.
DELETE /api/v1/admin/vmibins/archive Archive VMI bins via route · Vmi bins archive route #
Ask an LLM
“Which endpoint archives bins with a DELETE to the archive path?”
“Can I archive several VMI bins through the archive route?”
Tell an agent destructive · confirm first
Archive VMI bins {ids} through the /archive route.
Send bins {ids} to archive using the DELETE archive endpoint.
DELETE /api/v1/admin/vmibins/delete Bulk delete VMI bins · Vmi bins delete route #
Ask an LLM
“Can I permanently delete many VMI bins at once?”
“How do I bulk remove bins by ID?”
Tell an agent destructive · confirm first
Bulk delete VMI bins {ids}.
Permanently remove the bins with IDs {ids}.
GET /api/v1/admin/vmibins({key})/customproperties({custompropertyKey}) Get a custom property on a VMI bin · Vmi bins get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property stored on a VMI bin?”
“Where are extra custom fields on a bin kept?”
Tell an agent
Show custom property {property} on VMI bin {key}.
Get bin {key}'s custom field {property}.
GET /api/v1/admin/vmibins({key})/vmicounts({vmicountKey}) Get an inventory count for a VMI bin · Vmi bins get vmi count by key and vmicountkey #
Ask an LLM
“Can I look up one recorded inventory count for a bin?”
“What quantity was counted in a bin on a specific count?”
Tell an agent
Show count {count} recorded for VMI bin {key}.
Get inventory count record {count} of bin {key}.
GET /api/v1/admin/vmibins({key})/vminotes({vminoteKey}) Get a note on a VMI bin · Vmi bins get vmi note by key and vminotekey #
Ask an LLM
“Can I read a note someone left on a VMI bin?”
“Where are comments about a bin stored?”
Tell an agent
Show note {note} on VMI bin {key}.
Get bin {key}'s note {note}.
GET /api/v1/vmiBins/count Count VMI bins matching conditions · Vmi bins V1 get count async #
Ask an LLM
“How many vendor-managed inventory bins are below their minimum quantity?”
“Can I count the VMI bins at one location?”
Tell an agent
Count VMI bins at location {vmiLocationId}.
Count VMI bins where below-minimum is {isBelowMinimum}.

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-bins-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-vmi-bins-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Vmi Bins API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Vmi Bins
paths:
  /api/v1/admin/VmiBins:
    get:
      tags:
      - Vmi Bins
      summary: Returns the EntitySet VmiBins
      operationId: VmiBins_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 Bins
      summary: Post a new entity to EntitySet VmiBins
      operationId: VmiBins_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.VmiBin'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/VmiBins({id}):
    get:
      tags:
      - Vmi Bins
      summary: Returns the entity with the key from VmiBins
      operationId: VmiBins_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 Bins
      summary: Replace entity in EntitySet VmiBins
      operationId: VmiBins_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.VmiBin'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Vmi Bins
      summary: Delete entity in EntitySet VmiBins
      operationId: VmiBins_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 Bins
      summary: Update entity in EntitySet VmiBins
      operationId: VmiBins_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.VmiBin'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/VmiBins/Default.Default():
    get:
      tags:
      - Vmi Bins
      summary: Call operation Default
      operationId: VmiBins_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/VmiBins/Default.archive:
    post:
      tags:
      - Vmi Bins
      summary: Call operation archive
      operationId: VmiBins_Archive
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      requestBody:
        $ref: '#/components/requestBodies/Affiliates_ArchiveParameters'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/vmibins/archive:
    delete:
      tags:
      - Vmi Bins
      operationId: VmiBins_ArchiveRoute
      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 bins archive route
      x-summary-source: derived
  /api/v1/admin/vmibins/delete:
    delete:
      tags:
      - Vmi Bins
      operationId: VmiBins_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 bins delete route
      x-summary-source: derived
  /api/v1/admin/vmibins({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Vmi Bins
      operationId: VmiBins_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 bins get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/vmibins({key})/vmicounts({vmicountKey}):
    get:
      tags:
      - Vmi Bins
      operationId: VmiBins_GetVmiCountByKeyAndVmicountkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: vmicountKey
        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 bins get vmi count by key and vmicountkey
      x-summary-source: derived
  /api/v1/admin/vmibins({key})/vminotes({vminoteKey}):
    get:
      tags:
      - Vmi Bins
      operationId: VmiBins_GetVmiNoteByKeyAndVminotekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: vminoteKey
        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 bins get vmi note by key and vminotekey
      x-summary-source: derived
  /api/v1/vmiBins/count:
    get:
      tags:
      - Vmi Bins
      operationId: VmiBinsV1_GetCountAsync
      parameters:
      - name: parameter.isBelowMinimum
        in: query
        required: false
        schema:
          type: boolean
      - name: parameter.numberOfTimesMinQtyReached
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: parameter.numberOfPreviousOrders
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: parameter.numberOfVisits
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: parameter.vmiLocationId
        in: query
        required: false
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.VmiBinCountModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.VmiBinCountModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.VmiBinCountModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.VmiBinCountModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.VmiBinCountModel'
      security:
      - access_token: []
      summary: Vmi bins V1 get count async
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.VmiBin:
      required:
      - binNumber
      - lastCountUserName
      - previousCountUserName
      - unitOfMeasure
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        vmiLocationId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        binNumber:
          maxLength: 25
          minLength: 0
          type: string
        productId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        minimumQty:
          format: decimal
          type: number
        maximumQty:
          format: decimal
          type: number
        lastCountDate:
          format: date-time
          type: string
        lastCountQty:
          format: decimal
          type: number
        lastCountUserName:
          maxLength: 100
          minLength: 0
          type: string
        previousCountDate:
          format: date-time
          type: string
        previousCountQty:
          format: decimal
          type: number
        previousCountUserName:
          maxLength: 100
          minLength: 0
          type: string
        lastOrderDate:
          format: date-time
          type: string
        lastOrderLineId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        isActive:
          type: boolean
        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
    Insite.Catalog.WebApi.V1.ApiModels.VmiBinCountModel:
      type: object
      properties:
        uri:
          type: string
        count:
          format: int32
          type: integer
        properties:
          type: object
          additionalProperties:
            type: string
  requestBodies:
    Affiliates_ArchiveParameters:
      content:
        application/json:
          schema:
            type: object
            properties: {}
      description: archive action parameters
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query