Optimizely

Optimizely Vmi Locations API

The Vmi Locations API from Optimizely — 8 operation(s) for vmi locations.

GitHub OpenAPI

Operations 35

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/VmiLocations List vendor-managed inventory locations · Returns the EntitySet VmiLocations #
Ask an LLM
“Which VMI locations are set up in my Optimizely Configured Commerce admin?”
“Can I filter vendor-managed inventory locations to only active ones for a customer?”
Tell an agent
List all VMI locations.
Find VMI locations matching {filter}, sorted by {orderby}.
POST /api/v1/admin/VmiLocations Create a VMI location · Post a new entity to EntitySet VmiLocations #
Ask an LLM
“How do I add a new vendor-managed inventory location for a customer?”
“Can a new VMI location be marked as the customer's primary location and use bins?”
Tell an agent
Create a VMI location named {name} for customer {customerId} with note {note}.
Add a new primary VMI location {name} that uses bins, note {note}.
GET /api/v1/admin/VmiLocations({id}) Get one VMI location · Returns the entity with the key from VmiLocations #
Ask an LLM
“What are the settings of a specific VMI location?”
“Is a given vendor-managed inventory location active and enforcing max quantities?”
Tell an agent
Get VMI location {id}.
Show VMI location {id} with its related {expand} expanded.
PUT /api/v1/admin/VmiLocations({id}) Replace a VMI location record · Replace entity in EntitySet VmiLocations #
Ask an LLM
“How do I overwrite every field of an existing VMI location in one call?”
“Can I replace a VMI location record wholesale instead of patching it?”
Tell an agent
Replace VMI location {id} with name {name} and note {note}.
Overwrite the full record of VMI location {id}.
DELETE /api/v1/admin/VmiLocations({id}) Delete a VMI location · Delete entity in EntitySet VmiLocations #
Ask an LLM
“How do I delete a single VMI location by its ID?”
“Can I guard a VMI location delete with an ETag so I do not remove a changed record?”
Tell an agent destructive · confirm first
Delete VMI location {id}.
Delete VMI location {id} only if its ETag still matches {ifMatch}.
PATCH /api/v1/admin/VmiLocations({id}) Partially update a VMI location · Update entity in EntitySet VmiLocations #
Ask an LLM
“Can I change just one setting of a VMI location, like deactivating it?”
“How do I turn on max-quantity enforcement for an existing VMI location?”
Tell an agent
Deactivate VMI location {id} by setting active to {isActive}.
Patch VMI location {id} to update its note to {note}.
GET /api/v1/admin/VmiLocations/Default.Default() Get the default VMI location template · Call operation Default #
Ask an LLM
“What does a blank VMI location look like with its default values?”
“Is there a default VMI location record I can start from?”
Tell an agent
Fetch the default VMI location template.
Get default values for a new VMI location.
POST /api/v1/admin/VmiLocations/Default.archive Archive VMI locations via the archive action · Call operation archive #
Ask an LLM
“How do I archive several VMI locations at once with the archive action?”
“Can I archive VMI locations instead of deleting them outright?”
Tell an agent destructive · confirm first
Run the archive action on VMI locations {ids}.
Archive VMI locations {ids} using the POST archive action.
DELETE /api/v1/admin/vmilocations/archive Archive VMI locations via the archive route · Vmi locations archive route #
Ask an LLM
“Is there a DELETE archive route for retiring a batch of VMI locations?”
“Can I send a list of IDs to the VMI location archive endpoint?”
Tell an agent destructive · confirm first
Archive VMI locations {ids} through the archive route.
Send VMI location IDs {ids} to the DELETE archive endpoint.
DELETE /api/v1/admin/vmilocations/delete Bulk delete VMI locations · Vmi locations delete route #
Ask an LLM
“How do I delete many VMI locations in one request?”
“Can I pass a list of IDs to remove multiple vendor-managed inventory locations?”
Tell an agent destructive · confirm first
Bulk delete VMI locations {ids}.
Delete all of these VMI locations in one call: {ids}.
GET /api/v1/admin/vmilocations({key})/customproperties({custompropertyKey}) Get a custom property of a VMI location · Vmi locations get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property value attached to a VMI location?”
“Can I look up one specific custom field on a vendor-managed inventory location?”
Tell an agent
Get custom property {custompropertyKey} of VMI location {key}.
Show custom field {custompropertyKey} on VMI location {key}.
GET /api/v1/admin/vmilocations({key})/vmibins({vmibinKey}) Get a bin within a VMI location · Vmi locations get vmi bin by key and vmibinkey #
Ask an LLM
“How do I look up a specific bin inside a VMI location?”
“What details are stored for one VMI bin at a location?”
Tell an agent
Get bin {vmibinKey} in VMI location {key}.
Show VMI bin {vmibinKey} at location {key}.
GET /api/v1/vmiLocations/{vmiLocationId}/bins List the bins at a VMI location · Vmi bins V1 get collection async #
Ask an LLM
“How do I see every bin at one of my vendor-managed inventory locations?”
“Can I find only the bins that are below their minimum quantity?”
Tell an agent
List all bins at VMI location {vmiLocationId}.
Show bins at VMI location {vmiLocationId} that are below minimum = {isBelowMinimum}.
POST /api/v1/vmiLocations/{vmiLocationId}/bins Add a bin to a VMI location · Vmi bins V1 post async #
Ask an LLM
“How do I add a new stocking bin to a vendor-managed inventory location?”
“Can I set minimum and maximum quantities when I create a VMI bin?”
Tell an agent
Create bin {binNumber} for product {productId} at VMI location {vmiLocationId}.
Add a new bin at VMI location {vmiLocationId} with minimum {minimumQty} and maximum {maximumQty}.
DELETE /api/v1/vmiLocations/{vmiLocationId}/bins/{vmiBinId} Delete one bin from a VMI location · Vmi bins V1 delete async #
Ask an LLM
“Can I remove a single bin from a vendor-managed inventory location?”
“What happens when I delete one VMI bin I no longer stock?”
Tell an agent destructive · confirm first
Delete bin {vmiBinId} from VMI location {vmiLocationId}.
Remove the single VMI bin {vmiBinId} at location {vmiLocationId}.
PATCH /api/v1/vmiLocations/{vmiLocationId}/bins/{vmiBinId} Update an existing VMI bin · Vmi bins V1 patch async #
Ask an LLM
“How do I change the min and max quantities on an existing VMI bin?”
“Can I reassign the product or unit of measure on a bin I already created?”
Tell an agent
Set the minimum quantity of bin {vmiBinId} at VMI location {vmiLocationId} to {minimumQty}.
Change the maximum quantity on existing bin {vmiBinId} at location {vmiLocationId} to {maximumQty}.
POST /api/v1/vmiLocations/{vmiLocationId}/bins/batch Create many VMI bins in one batch · Vmi bins V1 post collection async #
Ask an LLM
“Is there a way to create a whole set of bins at a VMI location in one request?”
“Can I bulk load bins into a vendor-managed inventory location?”
Tell an agent
Batch create bins at VMI location {vmiLocationId}.
Bulk load this set of new bins into VMI location {vmiLocationId}.
DELETE /api/v1/vmiLocations/{vmiLocationId}/bins/batch Delete several VMI bins at once · Vmi bins V1 delete collection async #
Ask an LLM
“Can I delete multiple bins from a VMI location in a single call?”
“What do I pass to bulk remove bins by their IDs?”
Tell an agent destructive · confirm first
Batch delete bins {ids} from VMI location {vmiLocationId}.
Remove all of these bins at location {vmiLocationId} in one request: {ids}.
POST /api/v1/vmiLocations/{vmiLocationId}/bins/send-pdf Email a PDF of bin labels for a VMI location · Vmi bins V1 send pdf async #
Ask an LLM
“How do I send a printable PDF of bin labels with barcodes for a VMI location?”
“Can I choose the barcode format and layout on the bin label PDF?”
Tell an agent
Send a bin label PDF for VMI location {vmiLocationId}.
Email the bin PDF for location {vmiLocationId} using barcode format {barcodeFormat} and layout {layout}.
GET /api/v1/vmiLocations List VMI locations through the storefront API · Vmi locations V1 get collection async #
Ask an LLM
“Which VMI locations can a signed-in storefront user see?”
“Can I page through vendor-managed inventory locations from the website API, 20 at a time?”
Tell an agent
Page through storefront VMI locations, {pageSize} per page.
Show the VMI locations available to storefront user {userId}.
POST /api/v1/vmiLocations Create a VMI location from the storefront API · Vmi locations V1 post async #
Ask an LLM
“How do I set up a vendor-managed inventory location tied to a bill-to and ship-to address?”
“Can a storefront user add a VMI location for one of their ship-to addresses?”
Tell an agent
Create a storefront VMI location named {name} for bill-to {billToId}.
Add VMI location {name} delivering to ship-to {shipToId} with bins enabled.
GET /api/v1/vmiLocations/{VmiLocationId}/notes List notes for a VMI location · Vmi locations V1 get notes async #
Ask an LLM
“Where can I read the notes left on a VMI location's bins?”
“Can I narrow VMI notes down to a single bin?”
Tell an agent
Show the notes for VMI location {VmiLocationId}.
List notes on bin {vmiBinId} at VMI location {VmiLocationId}.
POST /api/v1/vmiLocations/batch Create many VMI locations in one batch · Vmi locations V1 post collection async #
Ask an LLM
“Can I import a list of vendor-managed inventory locations in bulk?”
“Is there a validation-only mode to check a batch of VMI locations before saving?”
Tell an agent
Batch create these VMI locations: {vmiLocations}.
Validate this batch of VMI locations without saving, validationOnly {validationOnly}.
DELETE /api/v1/vmiLocations/batch Delete several VMI locations at once · Vmi locations V1 delete collection async #
Ask an LLM
“How do I bulk remove VMI locations by ID?”
“Can several vendor-managed inventory locations be deleted in one request?”
Tell an agent destructive · confirm first
Batch delete VMI locations {ids}.
Remove these VMI locations in one call: {ids}.
GET /api/v1/vmiLocations/{vmiLocationId} Get a VMI location through the storefront API · Vmi locations V1 get async #
Ask an LLM
“What bill-to and ship-to does a given vendor-managed inventory location use on the storefront?”
“Can the website API tell me whether a VMI location uses bins?”
Tell an agent
Fetch storefront VMI location {vmiLocationId} with its bill-to and ship-to.
Look up VMI location {vmiLocationId} through the website API.
DELETE /api/v1/vmiLocations/{vmiLocationId} Delete a VMI location through the storefront API · Vmi locations V1 delete async #
Ask an LLM
“Can a storefront user remove a vendor-managed inventory location they no longer use?”
“What happens when a VMI location is removed through the website API rather than the admin console?”
Tell an agent destructive · confirm first
Remove storefront VMI location {vmiLocationId}.
Use the website API to delete the vendor-managed inventory location {vmiLocationId}.
PATCH /api/v1/vmiLocations/{vmiLocationId} Update a VMI location · Vmi locations V1 patch async #
Ask an LLM
“How do I rename an existing VMI location or change its ship-to?”
“Can I turn on max quantity enforcement for a location I already set up?”
Tell an agent
Rename VMI location {vmiLocationId} to {name}.
Change the ship-to of existing VMI location {vmiLocationId} to {shipToId}.
POST /api/v1/vmiLocations/{vmiLocationId}/bins/{vmiBinId}/notes Add a note to a VMI bin · Vmi notes V1 post async #
Ask an LLM
“How do I leave a note on a VMI bin?”
“Can a bin note be included on the replenishment order?”
Tell an agent
Add the note {note} to bin {vmiBinId} at VMI location {vmiLocationId}.
Post a note on bin {vmiBinId} at location {vmiLocationId} and include it on the order.
DELETE /api/v1/vmiLocations/{vmiLocationId}/bins/{vmiBinId}/notes/{vmiNoteId} Delete a note from a VMI bin · Vmi notes V1 delete async #
Ask an LLM
“Can I remove a note I left on a VMI bin?”
“What does it take to delete one bin note by ID?”
Tell an agent destructive · confirm first
Delete note {vmiNoteId} from bin {vmiBinId} at VMI location {vmiLocationId}.
Remove bin note {vmiNoteId} on bin {vmiBinId}, location {vmiLocationId}.
PATCH /api/v1/vmiLocations/{vmiLocationId}/bins/{vmiBinId}/notes/{vmiNoteId} Edit a note on a VMI bin · Vmi notes V1 patch async #
Ask an LLM
“How do I edit the text of an existing note on a VMI bin?”
“Can I stop an existing bin note from appearing on orders?”
Tell an agent
Change note {vmiNoteId} on bin {vmiBinId} at location {vmiLocationId} to read {note}.
Set includeOnOrder to {includeOnOrder} on bin note {vmiNoteId} (bin {vmiBinId}, location {vmiLocationId}).
POST /api/v1/vmiLocations/{vmiLocationId}/bins/{vmiBinId}/binCounts Record a stock count for a VMI bin · Vmi counts V1 post async #
Ask an LLM
“How do I record a new on-hand count for a VMI bin?”
“Can I log who performed a bin count and when?”
Tell an agent
Record a count of {count} for bin {vmiBinId} at VMI location {vmiLocationId}.
Log a new bin count of {count} by {createdBy} on bin {vmiBinId}, location {vmiLocationId}.
GET /api/v1/vmiLocations/{vmiLocationId}/bins/{vmiBinId}/binCounts/{vmiCountId} Get one stock count for a VMI bin · Vmi counts V1 get async #
Ask an LLM
“What quantity was recorded in a specific bin count?”
“Can I look up one past count on a VMI bin by its ID?”
Tell an agent
Get bin count {vmiCountId} for bin {vmiBinId} at VMI location {vmiLocationId}.
Show the recorded quantity of count {vmiCountId} on bin {vmiBinId}, location {vmiLocationId}.
DELETE /api/v1/vmiLocations/{vmiLocationId}/bins/{vmiBinId}/binCounts/{vmiCountId} Delete a stock count from a VMI bin · Vmi counts V1 delete async #
Ask an LLM
“Can I delete a bin count that was entered by mistake?”
“Is removing a VMI bin count permanent?”
Tell an agent destructive · confirm first
Delete count {vmiCountId} from bin {vmiBinId} at VMI location {vmiLocationId}.
Remove the mistaken bin count {vmiCountId} on bin {vmiBinId}, location {vmiLocationId}.
PATCH /api/v1/vmiLocations/{vmiLocationId}/bins/{vmiBinId}/binCounts/{vmiCountId} Correct an existing VMI bin count · Vmi counts V1 patch async #
Ask an LLM
“How do I fix the quantity on a bin count I already recorded?”
“Can I change the product on an existing VMI count?”
Tell an agent
Correct count {vmiCountId} on bin {vmiBinId} at location {vmiLocationId} to {count}.
Update existing bin count {vmiCountId} (bin {vmiBinId}, location {vmiLocationId}) to product {productId}.
POST /api/v1/vmiLocations/{vmiLocationId}/bins/{vmiBinId}/binCounts/batch Record many counts for a VMI bin in one batch · Vmi counts V1 post batch async #
Ask an LLM
“Can I submit several stock counts for a bin in one request?”
“Is there a bulk upload for VMI bin counts?”
Tell an agent
Batch record these counts on bin {vmiBinId} at VMI location {vmiLocationId}.
Bulk upload bin counts for bin {vmiBinId}, location {vmiLocationId}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-vmi-locations-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-locations-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-locations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Vmi Locations API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:


# --- truncated at 32 KB (87 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-vmi-locations-api-openapi.yml