Optimizely Categories API
The Categories API from Optimizely — 22 operation(s) for categories.
Operations 26
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/Categories
List product categories in the admin console · Returns the EntitySet Categories
#
Ask an LLM
“How do I pull every product category from the Commerce admin API?”
“Can I filter and sort the admin category list, or only page through it?”
Tell an agent
List all product categories from the admin API.
Show the first {top} admin categories matching {filter}.
POST
/api/v1/admin/Categories
Create a new product category · Post a new entity to EntitySet Categories
#
Ask an LLM
“What fields are required when I add a new product category?”
“Can a new category be created under an existing parent category?”
Tell an agent
Create a category named {name} with URL segment {urlSegment}.
Add a new category {name} under parent category {parentId}.
GET
/api/v1/admin/Categories({id})
Get one category by its id in the admin API · Returns the entity with the key from Categories
#
Ask an LLM
“How can I look up a single category record by its id as an admin?”
“What does the admin API return for one specific category?”
Tell an agent
Fetch admin category {id}.
Show me the full admin record for category {id}.
PUT
/api/v1/admin/Categories({id})
Replace a category record entirely · Replace entity in EntitySet Categories
#
Ask an LLM
“Can I overwrite every field of an existing category in one call?”
“What happens to fields I leave out when I fully replace a category?”
Tell an agent
Replace category {id} with a full record named {name}.
Overwrite category {id} entirely, setting its page title to {pageTitle}.
DELETE
/api/v1/admin/Categories({id})
Delete a single category by id · Delete entity in EntitySet Categories
#
Ask an LLM
“How do I delete one category by its id?”
“Does removing a single category support an If-Match concurrency check?”
Tell an agent destructive · confirm first
Delete category {id}.
Delete category {id} only if its ETag still matches {etag}.
PATCH
/api/v1/admin/Categories({id})
Update some fields on a category · Update entity in EntitySet Categories
#
Ask an LLM
“Can I change just a category's meta description without resending everything?”
“Is there a way to mark an existing category as featured?”
Tell an agent
Update the meta description of category {id} to {metaDescription}.
Mark category {id} as featured.
GET
/api/v1/admin/Categories/Default.Default()
Get default values for a new category · Call operation Default
#
Ask an LLM
“What default values does a brand-new category start with?”
“Is there a blank category template I can start from before creating one?”
Tell an agent
Get the default starting values for a new category.
Show me the empty category template the admin uses.
POST
/api/v1/admin/Categories/Default.archive
Archive categories via the OData archive action · Call operation archive
#
Ask an LLM
“How do I archive several categories using the OData archive action?”
“Can I hide categories without permanently deleting them through the Default.archive call?”
Tell an agent destructive · confirm first
Run the OData archive action on categories {ids}.
Archive categories {ids} with the Default.archive action call.
GET
/api/v1/admin/categories({key})/categoryPersonas
List the personas assigned to a category · Categories get category personas by key
#
Ask an LLM
“Which personas are linked to a given category?”
“Can I include archived persona assignments when listing a category's personas?”
Tell an agent
List the category persona assignments for category {key}.
Show the personas for category {key} using archive filter {archiveFilter}.
POST
/api/v1/admin/categories/categoriesWithParents
Get categories together with their parent chain · Categories get categories with parents
#
Ask an LLM
“How can I get categories along with their parent categories in one response?”
“Is there a way to see the full parent hierarchy for my categories?”
Tell an agent
Fetch the categories with their parent categories included.
Return each category alongside its parent hierarchy.
DELETE
/api/v1/admin/categories/archive
Archive categories through the archive route · Categories archive route
#
Ask an LLM
“Can I archive a batch of categories with a DELETE on the archive route?”
“What is the REST-style route for archiving categories by id list?”
Tell an agent destructive · confirm first
Archive categories {ids} using the categories/archive route.
Send the batch archive request for categories {ids}.
DELETE
/api/v1/admin/categories/delete
Permanently delete several categories at once · Categories delete route
#
Ask an LLM
“How do I bulk delete multiple categories in one request?”
“Can I permanently remove a list of categories by their ids?”
Tell an agent destructive · confirm first
Bulk delete categories {ids}.
Permanently delete every category in the list {ids}.
GET
/api/v1/admin/categories({key})/attributevalues({attributevalueKey})
Get an attribute value assigned to a category · Categories get attribute value by key and attributevaluekey
#
Ask an LLM
“How do I read one attribute value attached to a category?”
“Can I check whether a specific attribute value belongs to a category?”
Tell an agent
Get attribute value {attributevalueKey} on category {key}.
Show the attribute value {attributevalueKey} linked to category {key}.
GET
/api/v1/admin/categories({key})/categoryattributetypes({categoryattributetypeKey})
Get an attribute type configured on a category · Categories get category attribute type by key and categoryattributetypekey
#
Ask an LLM
“Which attribute type settings apply to a given category?”
“Can I look up one category attribute type assignment by its key?”
Tell an agent
Get category attribute type {categoryattributetypeKey} for category {key}.
Show how attribute type {categoryattributetypeKey} is configured on category {key}.
GET
/api/v1/admin/categories({key})/categoryrelatedproducts({categoryrelatedproductKey})
Get a related product link on a category · Categories get category related product by key and categoryrelatedproductkey
#
Ask an LLM
“How can I see one related-product entry set up for a category?”
“What details are stored for a category's related product?”
Tell an agent
Get category related product {categoryrelatedproductKey} on category {key}.
Show related-product entry {categoryrelatedproductKey} for category {key}.
GET
/api/v1/admin/categories({key})/customproperties({custompropertyKey})
Get a custom property on a category · Categories get custom property by key and custompropertykey
#
Ask an LLM
“How do I read a custom property value stored on a category?”
“Can I fetch one specific custom field from a category record?”
Tell an agent
Get custom property {custompropertyKey} of category {key}.
Show the value of custom property {custompropertyKey} on category {key}.
GET
/api/v1/admin/categories({key})/dealers({dealerKey})
Get a dealer associated with a category · Categories get dealer by key and dealerkey
#
Ask an LLM
“Which dealer record is tied to a particular category?”
“Can I confirm that a dealer is assigned to a category?”
Tell an agent
Get dealer {dealerKey} assigned to category {key}.
Show the dealer {dealerKey} linked with category {key}.
GET
/api/v1/admin/categories({key})/documents({documentKey})
Get a document attached to a category · Categories get document by key and documentkey
#
Ask an LLM
“How do I retrieve a document attached to a category?”
“Can categories carry documents like spec sheets I can look up individually?”
Tell an agent
Get document {documentKey} attached to category {key}.
Open the category document {documentKey} for category {key}.
GET
/api/v1/admin/categories({key})/personas({personaKey})
Get one persona targeted by a category · Categories get persona by key and personakey
#
Ask an LLM
“Can I look up a single persona that a category targets?”
“What persona details come back for one category persona key?”
Tell an agent
Get persona {personaKey} on category {key}.
Show the single persona {personaKey} that category {key} targets.
GET
/api/v1/admin/categories({key})/products({productKey})
Get a product assigned to a category · Categories get product by key and productkey
#
Ask an LLM
“How do I check a specific product inside a category?”
“Can I fetch one product through the category it belongs to?”
Tell an agent
Get product {productKey} within category {key}.
Show product {productKey} as assigned to category {key}.
GET
/api/v1/admin/categories({key})/specifications({specificationKey})
Get a specification on a category · Categories get specification by key and specificationkey
#
Ask an LLM
“Where do I read a specification entry defined for a category?”
“Can a category have specifications I can retrieve one at a time?”
Tell an agent
Get specification {specificationKey} of category {key}.
Show the specification {specificationKey} content for category {key}.
GET
/api/v1/admin/categories({key})/subcategories({categoryKey})
Get a subcategory of a category · Categories get sub category by key and categorykey
#
Ask an LLM
“How do I get one child subcategory under a parent category?”
“Can I confirm a category is a subcategory of another one?”
Tell an agent
Get subcategory {categoryKey} under category {key}.
Show child category {categoryKey} of parent category {key}.
GET
/api/v1/admin/categories({key})/taxexemptions({taxexemptionKey})
Get a tax exemption linked to a category · Categories get tax exemption by key and taxexemptionkey
#
Ask an LLM
“Which tax exemption applies to products in a category?”
“Can I look up one tax exemption assigned to a category?”
Tell an agent
Get tax exemption {taxexemptionKey} on category {key}.
Show tax exemption {taxexemptionKey} for category {key}.
Ask an LLM
“How do I get the category navigation tree for my storefront?”
“Can I limit how many levels deep the storefront category tree goes?”
Tell an agent
Get the storefront category tree down to depth {maxDepth}.
Load the storefront categories beneath category {startCategoryId}.
GET
/api/v1/categories/{categoryId}
Get a category as shoppers see it on the storefront · Categories V1 get by id async
#
Ask an LLM
“How do I load one category for display on the storefront?”
“What does a shopper-facing category record include?”
Tell an agent
Get storefront category {categoryId}.
Load the shopper-facing details for category {categoryId}.
GET
/api/v1/categories/feederData
Get category feeder data for a storefront widget · Categories V1 get feeder data
#
Ask an LLM
“What is category feeder data and how do I request it by type?”
“Can I pull the category feed that populates storefront widgets?”
Tell an agent
Get category feeder data of type {type}.
Load the {type} category feed for the storefront.