Optimizely Warehouses API
The Warehouses API from Optimizely — 13 operation(s) for warehouses.
Operations 17
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
Ask an LLM
“Which warehouses are configured in my commerce admin?”
“Can I filter the admin warehouse list by city or state with an OData query?”
Tell an agent
List all warehouses in the admin console.
List admin warehouses matching {filter}.
Ask an LLM
“How do I add a new warehouse with its address, phone and opening hours?”
“Can a new warehouse be set up to allow customer pickup?”
Tell an agent
Create a warehouse named {name} at {address1}, {city}, {state} {postalCode}.
Add pickup warehouse {name} open {hours} with contact {contactName}.
GET
/api/v1/admin/Warehouses({id})
Get a warehouse's admin record · Returns the entity with the key from Warehouses
#
Ask an LLM
“What address and contact details are stored for one warehouse?”
“Can I expand related data when fetching a single admin warehouse?”
Tell an agent
Show admin details for warehouse {id}.
Fetch warehouse {id} expanding {expand}.
PUT
/api/v1/admin/Warehouses({id})
Replace a warehouse record · Replace entity in EntitySet Warehouses
#
Ask an LLM
“How do I overwrite an existing warehouse's entire record, address included?”
“Can I resend every field of a warehouse to replace it in one go?”
Tell an agent
Replace warehouse {id} with name {name} located at {address1}, {city}.
Overwrite the full record of warehouse {id}, contact now {contactName}.
DELETE
/api/v1/admin/Warehouses({id})
Delete one warehouse · Delete entity in EntitySet Warehouses
#
Ask an LLM
“How do I remove a single warehouse by its id?”
“Does deleting a warehouse honor an If-Match ETag check?”
Tell an agent destructive · confirm first
Delete warehouse {id}.
Delete warehouse {id} only if its ETag still equals {etag}.
PATCH
/api/v1/admin/Warehouses({id})
Update selected fields on a warehouse · Update entity in EntitySet Warehouses
#
Ask an LLM
“Can I change just the phone number of a warehouse without resending everything?”
“How do I schedule a warehouse to deactivate on a date?”
Tell an agent
Change the phone on warehouse {id} to {phone}.
Deactivate warehouse {id} on {deactivateOn}.
GET
/api/v1/admin/Warehouses/Default.Default()
Get default values for a new warehouse · Call operation Default
#
Ask an LLM
“What default values does a brand-new warehouse start with?”
“Is there a blank warehouse object I can use to pre-fill a create form?”
Tell an agent
Get the default template for a new warehouse.
Fetch a blank warehouse with its default field values.
POST
/api/v1/admin/Warehouses/Default.archive
Archive warehouses via the archive action · Call operation archive
#
Ask an LLM
“Can I archive several warehouses at once instead of deleting them?”
“Which POST action archives warehouses from a list of ids?”
Tell an agent
Archive warehouses {ids} using the POST archive action.
Run the Default.archive operation on warehouses {ids}.
DELETE
/api/v1/admin/warehouses/archive
Archive warehouses via the DELETE archive route · Warehouses archive route
#
Ask an LLM
“Is there a DELETE-verb route that archives a batch of warehouses?”
“How can I archive warehouses through the lowercase warehouses/archive endpoint?”
Tell an agent destructive · confirm first
Call the DELETE archive route for warehouses {ids}.
Archive warehouses {ids} through the warehouses/archive route.
Ask an LLM
“Can I permanently delete many warehouses in one request?”
“How do I bulk-remove warehouses given a list of ids?”
Tell an agent destructive · confirm first
Bulk delete warehouses {ids}.
Permanently remove every warehouse in {ids}.
GET
/api/v1/admin/warehouses({key})/alternateofwarehouses({warehouseKey})
Get a warehouse this one backs up · Warehouses get alternate of warehouse by key and warehousekey
#
Ask an LLM
“Which warehouse relies on this warehouse as its alternate?”
“Can I check that a warehouse is registered as an alternate of another one?”
Tell an agent
Get warehouse {warehouseKey} that warehouse {key} is an alternate of.
Confirm warehouse {key} serves as backup for warehouse {warehouseKey}.
GET
/api/v1/admin/warehouses({key})/alternatewarehouses({warehouseKey})
Get an alternate warehouse of a warehouse · Warehouses get alternate warehouse by key and warehousekey
#
Ask an LLM
“Which backup warehouse is configured as an alternate for my warehouse?”
“Can I read one specific alternate warehouse assigned to a warehouse?”
Tell an agent
Get alternate warehouse {warehouseKey} assigned to warehouse {key}.
Show fallback warehouse {warehouseKey} for primary warehouse {key}.
GET
/api/v1/admin/warehouses({key})/customproperties({custompropertyKey})
Get a custom property on a warehouse · Warehouses get custom property by key and custompropertykey
#
Ask an LLM
“What custom property values have been added to a warehouse?”
“Can I read a single custom property attached to a warehouse?”
Tell an agent
Get custom property {custompropertyKey} on warehouse {key}.
Read extra attribute {custompropertyKey} stored on warehouse {key}.
GET
/api/v1/admin/warehouses({key})/productwarehouses({productwarehouseKey})
Get a product stocking record for a warehouse · Warehouses get product warehouse by key and productwarehousekey
#
Ask an LLM
“How do I see a product's stocking record at a particular warehouse?”
“Can I fetch one product-warehouse entry under a warehouse?”
Tell an agent
Get product warehouse record {productwarehouseKey} for warehouse {key}.
Show product stocking entry {productwarehouseKey} at warehouse {key}.
GET
/api/v1/admin/warehouses({key})/websites({websiteKey})
Get a website a warehouse serves · Warehouses get website by key and websitekey
#
Ask an LLM
“Which storefront websites is a warehouse assigned to?”
“Can I check one website linked to a warehouse?”
Tell an agent
Get website {websiteKey} linked to warehouse {key}.
Show the storefront site {websiteKey} that warehouse {key} fulfils for.
GET
/api/v1/warehouses
Find storefront pickup warehouses near a location · Warehouses V1 get collection async
#
Ask an LLM
“Which pickup warehouses are within a radius of my customer's location?”
“Can the storefront warehouse list leave out the customer's current pickup warehouse?”
Tell an agent
Find pickup warehouses within {radius} of {latitude}, {longitude}.
List storefront warehouses, page {page} with {pageSize} per page.
GET
/api/v1/warehouses/{warehouseId}
Get a warehouse from the storefront API · Warehouses V1 get async
#
Ask an LLM
“What does the storefront show a shopper about one warehouse?”
“Can I load a pickup location's details for my storefront by warehouseId?”
Tell an agent
Get storefront warehouse {warehouseId}.
Load pickup location {warehouseId} for the shopper-facing site.