Optimizely Brands API
The Brands API from Optimizely — 23 operation(s) for brands.
Operations 27
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
“How do I pull every brand record from the Optimizely Configured Commerce admin API?”
“Can I filter and sort the admin brand list, or page through it with top and skip?”
Tell an agent
List all brands in the admin console.
List admin brands matching the filter {filter}, sorted by {orderby}.
Ask an LLM
“What fields do I need to set up a new brand, like logos, URL segment and SEO title?”
“Can I mark a newly created brand as sponsored and give it a search boost?”
Tell an agent
Create a brand named {name} with site URL {siteUrl} and URL segment {urlSegment}.
Add a new brand {name} made by manufacturer {manufacturer} with page title {pageTitle}.
GET
/api/v1/admin/Brands({id})
Get one brand's admin record · Returns the entity with the key from Brands
#
Ask an LLM
“How can I look up a single brand's admin record by its ID?”
“Which related data can I expand when fetching one brand record from admin?”
Tell an agent
Show me the admin record for brand {id}.
Fetch admin brand {id} with {expand} expanded.
PUT
/api/v1/admin/Brands({id})
Replace a brand record entirely · Replace entity in EntitySet Brands
#
Ask an LLM
“Can I overwrite an existing brand with a complete new set of values?”
“What happens to brand fields I leave out when I replace the whole record?”
Tell an agent
Replace brand {id} with a full record named {name} at site URL {siteUrl}.
Overwrite every field of brand {id}, setting the meta description to {metaDescription}.
Ask an LLM
“How do I remove one brand from the catalog by its ID?”
“Can I make a brand delete conditional on an ETag so I don't remove a changed record?”
Tell an agent destructive · confirm first
Delete brand {id}.
Delete brand {id} only if its ETag still matches {etag}.
PATCH
/api/v1/admin/Brands({id})
Update selected fields on a brand · Update entity in EntitySet Brands
#
Ask an LLM
“Can I change just a brand's sort order or logo alt text without resending everything?”
“How would I switch off the sponsored flag on an existing brand?”
Tell an agent
Patch brand {id} so its sort order is {sortOrder}.
Update brand {id} to set sponsored to {isSponsored} and search boost to {searchBoost}.
GET
/api/v1/admin/Brands/Default.Default()
Get default values for a new brand · Call operation Default
#
Ask an LLM
“What default values does the admin API pre-fill for a brand before I create one?”
“Is there a blank brand template I can start from?”
Tell an agent
Get the default brand template from the admin API.
Show the pre-filled default values for a new brand.
GET
/api/v1/admin/Brands/Default.checkbrandspage(websiteId={websiteId})
Check a website's brands page (OData function) · Call operation checkbrandspage
#
Ask an LLM
“How can I check whether a website has a brands page using the OData Default.checkbrandspage function?”
“Does the Default namespace checkbrandspage call tell me if a site's brand listing page exists?”
Tell an agent
Run the OData Default.checkbrandspage function for website {websiteId}.
Call the namespaced checkbrandspage operation to verify the brands page on site {websiteId}.
POST
/api/v1/admin/Brands({id})/Default.unassignProductLinesProducts
Unassign chosen products from a brand's lines · Call operation unassignProductLinesProducts
#
Ask an LLM
“How do I detach specific products from a brand's product lines by passing their IDs?”
“Can I pick which products to unassign from a brand's product lines instead of all of them?”
Tell an agent
Unassign products {productIds} from the product lines of brand {id}.
Through the Default action, remove products {productIds} from brand {id}'s product lines.
POST
/api/v1/admin/brands({key})/unassignProductLinesProducts
Unassign product-line products by brand key · Brands unassign product lines products by key
#
Ask an LLM
“Is there a lowercase brands route that unassigns product-line products using just the brand key?”
“Can I call unassignProductLinesProducts with no product list in the body?”
Tell an agent
Call the brands({key}) unassignProductLinesProducts route with no request body.
Clear product-line product assignments for brand key {key} via the plain route.
GET
/api/v1/admin/brands/checkbrandspage(websiteId={websiteId})
Check a website's brands page (plain route) · Brands check brands page by websiteid 2
#
Ask an LLM
“Is there a plain lowercase brands/checkbrandspage route to verify a website's brands page?”
“Can I check a site's brands page without the Default OData namespace in the URL?”
Tell an agent
Hit the plain brands/checkbrandspage route for website {websiteId}.
Use the non-namespaced route to check whether site {websiteId} has a brands page.
Ask an LLM
“Can I bulk delete a batch of brands in a single call?”
“How do I pass a list of brand IDs to remove them together?”
Tell an agent destructive · confirm first
Bulk delete the brands with IDs {ids}.
Remove every brand in the list {ids} in one request.
GET
/api/v1/admin/brands({key})/brandcategoryimages({brandcategoryimageKey})
Get a brand's category image · Brands get brand category image by key and brandcategoryimagekey
#
Ask an LLM
“How do I fetch one category image attached to a brand?”
“Where can I read the image a brand uses for a specific category tile?”
Tell an agent
Get brand category image {brandcategoryimageKey} for brand {key}.
Show the category image record {brandcategoryimageKey} under brand {key}.
GET
/api/v1/admin/brands({key})/customproperties({custompropertyKey})
Get a custom property on a brand · Brands get custom property by key and custompropertykey
#
Ask an LLM
“Can I read a single custom property value stored on a brand?”
“Which custom attributes has my team attached to a given brand record?”
Tell an agent
Get custom property {custompropertyKey} on brand {key}.
Show brand {key}'s custom property {custompropertyKey}.
GET
/api/v1/admin/brands({key})/productlines({productlineKey})
Get a brand's product line in admin · Brands get product line by key and productlinekey
#
Ask an LLM
“How do I read one product line record under a brand in the admin API?”
“Can I select only certain fields of a brand's product line from admin?”
Tell an agent
Get admin product line {productlineKey} of brand {key}.
Fetch the admin record for brand {key}'s product line {productlineKey}, selecting {select}.
GET
/api/v1/admin/brands({key})/products({productKey})
Get a product linked to a brand in admin · Brands get product by key and productkey
#
Ask an LLM
“Can I confirm a particular product is linked to a brand through the admin API?”
“How do I open the admin record of one product under a brand?”
Tell an agent
Get admin product {productKey} under brand {key}.
Look up product {productKey} in brand {key}'s admin product collection.
GET
/api/v1/brands/{BrandId}/categories
List the storefront categories of a brand · Brand categories V1 get collection async
#
Ask an LLM
“Which categories does a brand's products appear in on the storefront?”
“Can I limit how deep the brand category tree goes when listing it?”
Tell an agent
List the storefront categories for brand {BrandId}.
Show brand {BrandId}'s category tree down to depth {maximumDepth}.
GET
/api/v1/brands/{BrandId}/categories/{CategoryId}
Get one category within a brand · Brand categories V1 get async
#
Ask an LLM
“How do I get the details of a single category as it appears under a brand on the storefront?”
“Can I expand extra data on one brand category?”
Tell an agent
Get category {CategoryId} for brand {BrandId}.
Show brand {BrandId}'s category {CategoryId} with {expand} expanded.
GET
/api/v1/brands/{BrandId}/productlines/{ProductLineId}/products
List products in a brand's product line · Brand product line products V1 get async
#
Ask an LLM
“What products belong to a specific product line of a brand?”
“Can I filter a brand product line's products by price range or stocked items only?”
Tell an agent
List products in product line {ProductLineId} of brand {BrandId}.
Show brand {BrandId} product line {ProductLineId} products priced between {minimumPrice} and {maximumPrice}.
GET
/api/v1/brands/{brandId}/products
Search all products of a brand · Brand products V1 get async
#
Ask an LLM
“How can a shopper browse every product a brand sells on the storefront?”
“Can I search within a brand's products by keyword and page through the results?”
Tell an agent
List all storefront products for brand {brandId}.
Search brand {brandId}'s products for {query}, page {page}.
GET
/api/v1/brands/{BrandId}/categories/{CategoryId}/products
List a brand's products in one category · Brand category products V1 get async
#
Ask an LLM
“Which of a brand's products fall inside a particular category?”
“Can I sort a brand's products within one category?”
Tell an agent
List brand {BrandId}'s products in category {CategoryId}.
Show products for brand {BrandId} in category {CategoryId} sorted by {sort}.
Ask an LLM
“How do I build an A-Z brand directory showing brands that start with a given letter?”
“Can I show brands from one manufacturer or in random order on the storefront?”
Tell an agent
List storefront brands whose names start with {startsWith}.
Show brands from manufacturer {manufacturer} in random order.
Ask an LLM
“How do I load a brand's details to render its storefront brand page?”
“Can I expand extra information when fetching a single storefront brand?”
Tell an agent
Get storefront brand {BrandId}.
Load brand {BrandId} for display with {expand} expanded.
Ask an LLM
“Can I resolve which brand a storefront URL path belongs to?”
“How do I look up a brand when I only have its page path?”
Tell an agent
Find the brand at URL path {path}.
Resolve the brand behind page path {path}.
Ask an LLM
“What does the brands feederData endpoint return for storefront widgets?”
“Is there a single call that feeds brand data into content blocks?”
Tell an agent
Get the brand feeder data.
Pull brands feederData for the storefront content widgets.
GET
/api/v1/brands/{BrandId}/productlines
List a brand's product lines · Brand product lines V1 get collection async
#
Ask an LLM
“What product lines does a brand offer on the storefront?”
“Can I show only featured or sponsored product lines for a brand?”
Tell an agent
List the product lines of brand {BrandId}.
Show only featured product lines for brand {BrandId}.
GET
/api/v1/brands/{BrandId}/productlines/{ProductLineId}
Get one product line for the storefront · Brand product lines V1 get async
#
Ask an LLM
“How do I display the details of a single product line on a brand's storefront page?”
“Can I expand extra detail on one storefront product line?”
Tell an agent
Get storefront product line {ProductLineId} of brand {BrandId}.
Load brand {BrandId}'s product line {ProductLineId} with {expand} expanded.