Optimizely Brands API
The Brands API from Optimizely — 23 operation(s) for brands.
The Brands API from Optimizely — 23 operation(s) for brands.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/optimizely-brands-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Optimizely Brands API
version: '1.0'
description: 'Operations tagged Brands across 2 of this provider''s published API definitions: optimizely-configured-commerce-admin-api-v1-openapi.json, optimizely-configured-commerce-storefront-api-v1-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Brands
paths:
/api/v1/admin/Brands:
get:
tags:
- Brands
summary: Returns the EntitySet Brands
operationId: Brands_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:
- Brands
summary: Post a new entity to EntitySet Brands
operationId: Brands_Post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Data.Entities.Brand'
description: The entity to post
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/Brands({id}):
get:
tags:
- Brands
summary: Returns the entity with the key from Brands
operationId: Brands_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:
- Brands
summary: Replace entity in EntitySet Brands
operationId: Brands_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.Brand'
description: The entity to put
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
delete:
tags:
- Brands
summary: Delete entity in EntitySet Brands
operationId: Brands_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:
- Brands
summary: Update entity in EntitySet Brands
operationId: Brands_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.Brand'
description: The entity to patch
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/Brands/Default.Default():
get:
tags:
- Brands
summary: Call operation Default
operationId: Brands_Default
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/Brands/Default.checkbrandspage(websiteId={websiteId}):
get:
tags:
- Brands
summary: Call operation checkbrandspage
operationId: Brands_CheckBrandsPageByWebsiteid_1
parameters:
- name: websiteId
in: path
description: 'parameter: websiteId'
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/Brands({id})/Default.unassignProductLinesProducts:
post:
tags:
- Brands
summary: Call operation unassignProductLinesProducts
operationId: Brands_UnassignProductLinesProductsById
parameters:
- name: id
in: path
description: 'key: id'
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
type: object
properties:
productIds:
type: array
items:
type: string
description: unassignProductLinesProducts action parameters
responses:
'204':
description: No Content
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/brands({key})/unassignProductLinesProducts:
post:
tags:
- Brands
operationId: Brands_UnassignProductLinesProductsByKey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
responses:
'204':
description: No Content
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/brands/checkbrandspage(websiteId={websiteId}):
get:
tags:
- Brands
operationId: Brands_CheckBrandsPageByWebsiteid_2
parameters:
- name: websiteId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/brands/delete:
delete:
tags:
- Brands
operationId: Brands_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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/brands({key})/brandcategoryimages({brandcategoryimageKey}):
get:
tags:
- Brands
operationId: Brands_GetBrandCategoryImageByKeyAndBrandcategoryimagekey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: brandcategoryimageKey
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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/brands({key})/customproperties({custompropertyKey}):
get:
tags:
- Brands
operationId: Brands_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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/brands({key})/productlines({productlineKey}):
get:
tags:
- Brands
operationId: Brands_GetProductLineByKeyAndProductlinekey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: productlineKey
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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/brands({key})/products({productKey}):
get:
tags:
- Brands
operationId: Brands_GetProductByKeyAndProductkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: productKey
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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/brands/{BrandId}/categories:
get:
tags:
- Brands
operationId: BrandCategoriesV1_GetCollectionAsync
parameters:
- name: BrandId
in: path
required: true
schema:
type: string
- name: parameter.brandId
in: query
required: false
schema:
type: string
format: uuid
- name: parameter.categoryId
in: query
required: false
schema:
type: string
format: uuid
- name: parameter.maximumDepth
in: query
required: false
schema:
type: integer
format: int32
- name: parameter.expand
in: query
required: false
schema:
type: string
- name: parameter.page
in: query
required: false
schema:
type: integer
format: int32
- name: parameter.pageSize
in: query
required: false
schema:
type: integer
format: int32
- name: parameter.sort
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Brands.WebApi.V1.ApiModels.BrandCategoryCollectionModel'
text/json:
schema:
$ref: '#/components/schemas/Insite.Brands.WebApi.V1.ApiModels.BrandCategoryCollectionModel'
application/xml:
schema:
$ref: '#/components/schemas/Insite.Brands.WebApi.V1.ApiModels.BrandCategoryCollectionModel'
text/xml:
schema:
$ref: '#/components/schemas/Insite.Brands.WebApi.V1.ApiModels.BrandCategoryCollectionModel'
text/html:
schema:
$ref: '#/components/schemas/Insite.Brands.WebApi.V1.ApiModels.BrandCategoryCollectionModel'
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/brands/{BrandId}/categories/{CategoryId}:
get:
tags:
- Brands
operationId: BrandCategoriesV1_GetAsync
parameters:
- name: BrandId
in: path
required: true
schema:
type: string
- name: CategoryId
in: path
required: true
schema:
type: string
- name: parameter.brandId
in: query
required: false
schema:
type: string
format: uuid
- name: parameter.categoryId
in: query
required: false
schema:
type: string
format: uuid
- name: parameter.expand
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Brands.WebApi.V1.ApiModels.BrandCategoryModel'
text/json:
schema:
$ref: '#/components/schemas/Insite.Brands.WebApi.V1.ApiModels.BrandCategoryModel'
application/xml:
schema:
$ref: '#/components/schemas/Insite.Brands.WebApi.V1.ApiModels.BrandCategoryModel'
text/xml:
schema:
$ref: '#/components/schemas/Insite.Brands.WebApi.V1.ApiModels.BrandCategoryModel'
text/html:
schema:
$ref: '#/components/schemas/Insite.Brands.WebApi.V1.ApiModels.BrandCategoryModel'
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/brands/{BrandId}/productlines/{ProductLineId}/products:
get:
tags:
- Brands
operationId: BrandProductLineProductsV1_GetAsync
parameters:
- name: BrandId
in: path
required: true
schema:
type: string
- name: ProductLineId
in: path
required: true
schema:
type: string
- name: parameter.brandId
in: query
required: false
schema:
type: string
format: uuid
- name: parameter.productLineId
in: query
required: false
schema:
type: string
format: uuid
- name: parameter.query
in: query
required: false
schema:
type: string
- name: parameter.categoryId
in: query
required: false
schema:
type: string
format: uuid
- name: parameter.brandIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.productLineIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.attributeValueIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- name: parameter.priceFilters
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
- name: parameter.minimumPrice
in: query
required: false
schema:
type: number
format: double
- name: parameter.maximumPrice
in: query
required: false
schema:
type: number
format: double
- name: parameter.sort
in: query
required: false
schema:
type: string
- name: parameter.page
in: query
required: false
schema:
type: integer
format: int32
- name: parameter.pageSize
in: query
required: false
schema:
type: integer
format: int32
- name: parameter.productIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.names
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- name: parameter.erpNumbers
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- name: parameter.extendedNames
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- name: parameter.replaceProducts
in: query
required: false
schema:
type: boolean
- name: parameter.priceParameters
in: query
required: false
explode: true
schema:
type: array
items: {}
- name: parameter.expand
in: query
required: false
schema:
type: string
- name: parameter.includeSuggestions
in: query
required: false
schema:
type: boolean
- name: parameter.searchWithin
in: query
required: false
schema:
type: string
- name: parameter.getAllAttributeFacets
in: query
required: false
schema:
type: boolean
- name: parameter.filter
in: query
required: false
schema:
type: string
- name: parameter.topSellersCategoryIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.topSellersPersonaIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.topSellersMaxResults
in: query
required: false
schema:
type: integer
format: int32
- name: parameter.applyPersonalization
in: query
required: false
schema:
type: boolean
- name: parameter.includeAttributes
in: query
required: false
schema:
type: string
- name: parameter.includeAlternateInventory
in: query
required: false
schema:
type: boolean
- name: parameter.makeBrandUrls
in: query
required: false
schema:
type: boolean
- name: parameter.previouslyPurchasedProducts
in: query
required: false
schema:
type: boolean
- name: parameter.stockedItemsOnly
in: query
required: false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductCollectionModel'
text/json:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductCollectionModel'
application/xml:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductCollectionModel'
text/xml:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductCollectionModel'
text/html:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductCollectionModel'
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/brands/{brandId}/products:
get:
tags:
- Brands
operationId: BrandProductsV1_GetAsync
parameters:
- name: brandId
in: path
required: true
schema:
type: string
- name: parameter.brandId
in: query
required: false
schema:
type: string
format: uuid
- name: parameter.query
in: query
required: false
schema:
type: string
- name: parameter.categoryId
in: query
required: false
schema:
type: string
format: uuid
- name: parameter.brandIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.productLineIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.attributeValueIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- name: parameter.priceFilters
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
- name: parameter.minimumPrice
in: query
required: false
schema:
type: number
format: double
- name: parameter.maximumPrice
in: query
required: false
schema:
type: number
format: double
- name: parameter.sort
in: query
required: false
schema:
type: string
- name: parameter.page
in: query
required: false
schema:
type: integer
format: int32
- name: parameter.pageSize
in: query
required: false
schema:
type: integer
format: int32
- name: parameter.productIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.names
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- name: parameter.erpNumbers
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- name: parameter.extendedNames
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- name: parameter.replaceProducts
in: query
required: false
schema:
type: boolean
- name: parameter.priceParameters
in: query
required: false
explode: true
schema:
type: array
items: {}
- name: parameter.expand
in: query
required: false
schema:
type: string
- name: parameter.includeSuggestions
in: query
required: false
schema:
type: boolean
- name: parameter.searchWithin
in: query
required: false
schema:
type: string
- name: parameter.getAllAttributeFacets
in: query
required: false
schema:
type: boolean
- name: parameter.filter
in: query
required: false
schema:
type: string
- name: parameter.topSellersCategoryIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.topSellersPersonaIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.topSellersMaxResults
in: query
required: false
schema:
type: integer
format: int32
- name: parameter.applyPersonalization
in: query
required: false
schema:
type: boolean
- name: parameter.includeAttributes
in: query
required: false
schema:
type: string
- name: parameter.includeAlternateInventory
in: query
required: false
schema:
type: boolean
- name: parameter.makeBrandUrls
in: query
required: false
schema:
type: boolean
- name: parameter.previouslyPurchasedProducts
in: query
required: false
schema:
type: boolean
- name: parameter.stockedItemsOnly
in: query
required: false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductCollectionModel'
text/json:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductCollectionModel'
application/xml:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductCollectionModel'
text/xml:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductCollectionModel'
text/html:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductCollectionModel'
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/brands/{BrandId}/categories/{CategoryId}/products:
get:
tags:
- Brands
operationId: BrandCategoryProductsV1_GetAsync
parameters:
- name: BrandId
in: path
required: true
schema:
type: string
- name: CategoryId
in: path
required: true
schema:
type: string
- name: parameter.brandId
in: query
required: false
schema:
type: string
format: uuid
- name: parameter.query
in: query
required: false
schema:
type: string
- name: parameter.categoryId
in: query
required: false
schema:
type: string
format: uuid
- name: parameter.brandIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.productLineIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.attributeValueIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- name: parameter.priceFilters
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
- name: parameter.minimumPrice
in: query
required: false
schema:
type: number
format: double
- name: parameter.maximumPrice
in: query
required: false
schema:
type: number
format: double
- name: parameter.sort
in: query
required: false
schema:
type: string
- name: parameter.page
in: query
required: false
schema:
type: integer
format: int32
- name: parameter.pageSize
in: query
required: false
schema:
type: integer
format: int32
- name: parameter.productIds
in: query
required: false
explode: true
schema:
type: array
items:
type: string
format: uuid
- name: parameter.names
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- name: parameter.erpNumbers
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- name: parameter.extendedNames
in: query
required: false
explode: true
schema:
type: array
items:
type: string
- name: parameter.replaceProducts
in: query
required: false
schema:
type: boolean
- name: parameter.priceParameters
in: query
req
# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-brands-api-openapi.yml