How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Optimizely Products API

The Products API from Optimizely — 54 operation(s) for products.

Optimizely Products API is one of 420 APIs that Optimizely publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Product. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 58 operations across 54 paths, and defines 75 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 4 base URLs: https://dogfood.commerce.insitesandbox.com, https://api.us1.odp.optimizely.com/v3, https://api.eu1.odp.optimizely.com/v3, https://api.au1.odp.optimizely.com/v3.

58 operations 54 paths 75 schemas 3 DELETE49 GET1 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://exp.mcp.opal.optimizely.com/mcp
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Optimizely Products API declares 2 security schemes for authenticating requests. An API key is passed in the query as access_token (access_token). An API key is passed in the header as x-api-key (x-api-key).

  • access_token — Token used to access storefront API.

Paths & Operations 58

Across 54 paths, the API surfaces 58 operations — 3 DELETE, 49 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Products 58
GET
/api/v1/admin/Products
Returns the EntitySet Products
Products_Get 8 params → 200
POST
/api/v1/admin/Products
Post a new entity to EntitySet Products
Products_Post body → 200
GET
/api/v1/admin/Products({id})
Returns the entity with the key from Products
Products_GetById 3 params → 200
PUT
/api/v1/admin/Products({id})
Replace entity in EntitySet Products
Products_PutById 1 param body → 200
DELETE
/api/v1/admin/Products({id})
Delete entity in EntitySet Products
Products_DeleteById 2 params → 200
PATCH
/api/v1/admin/Products({id})
Update entity in EntitySet Products
Products_PatchById 1 param body → 200
GET
/api/v1/admin/Products/Default.Default()
Call operation Default
Products_Default → 200
POST
/api/v1/admin/Products/Default.archive
Call operation archive
Products_Archive 1 param body → 200
GET
/api/v1/admin/Products/Default.isdiscontinued(productId={productId})
Call operation isdiscontinued
Products_IsDiscontinuedByProductid_1 1 param → 200
GET
/api/v1/admin/Products/Default.unitofmeasures(productId={productId})
Call operation unitofmeasures
Products_UnitOfMeasuresByProductid_1 3 params → 200
GET
/api/v1/admin/products/isdiscontinued(productId={productId})
Products_IsDiscontinuedByProductid_2 1 param → 200
GET
/api/v1/admin/products/unitofmeasures(productId={productId})
Products_UnitOfMeasuresByProductid_2 3 params → 200
DELETE
/api/v1/admin/products/archive
Products_ArchiveRoute 1 param → 200
DELETE
/api/v1/admin/products/delete
Products_DeleteRoute 1 param → 200
GET
/api/v1/admin/products({key})/attributevalues({attributevalueKey})
Products_GetAttributeValueByKeyAndAttributevaluekey 4 params → 200
GET
/api/v1/admin/products({key})/badges({badgeKey})
Products_GetBadgeByKeyAndBadgekey 4 params → 200
GET
/api/v1/admin/products({key})/categories({categoryKey})
Products_GetCategoryByKeyAndCategorykey 4 params → 200
GET
/api/v1/admin/products({key})/customerproductsets({customerproductsetKey})
Products_GetCustomerProductSetByKeyAndCustomerproductsetkey 4 params → 200
GET
/api/v1/admin/products({key})/customervisibilityadditions({customerKey})
Products_GetCustomerVisibilityAdditionByKeyAndCustomerkey 4 params → 200
GET
/api/v1/admin/products({key})/customervisibilityexceptions({customerKey})
Products_GetCustomerVisibilityExceptionByKeyAndCustomerkey 4 params → 200
GET
/api/v1/admin/products({key})/customproperties({custompropertyKey})
Products_GetCustomPropertyByKeyAndCustompropertykey 4 params → 200
GET
/api/v1/admin/products({key})/dealers({dealerKey})
Products_GetDealerByKeyAndDealerkey 4 params → 200
GET
/api/v1/admin/products({key})/documents({documentKey})
Products_GetDocumentByKeyAndDocumentkey 4 params → 200
GET
/api/v1/admin/products({key})/parentrelatedcategories({categoryrelatedproductKey})
Products_GetParentRelatedCategoryByKeyAndCategoryrelatedproductkey 4 params → 200
GET
/api/v1/admin/products({key})/parentrelatedproducts({productrelatedproductKey})
Products_GetParentRelatedProductByKeyAndProductrelatedproductkey 4 params → 200
GET
/api/v1/admin/products({key})/productimages({productimageKey})
Products_GetProductImageByKeyAndProductimagekey 4 params → 200
GET
/api/v1/admin/products({key})/productkitsections({productkitsectionKey})
Products_GetProductKitSectionByKeyAndProductkitsectionkey 4 params → 200
GET
/api/v1/admin/products({key})/productrelatedproducts({productrelatedproductKey})
Products_GetProductRelatedProductByKeyAndProductrelatedproductkey 4 params → 200
GET
/api/v1/admin/products({key})/productunitofmeasures({productunitofmeasureKey})
Products_GetProductUnitOfMeasureByKeyAndProductunitofmeasurekey 4 params → 200
GET
/api/v1/admin/products({key})/productwarehouses({productwarehouseKey})
Products_GetProductWarehouseByKeyAndProductwarehousekey 4 params → 200
GET
/api/v1/admin/products({key})/promotionresults({promotionresultKey})
Products_GetPromotionResultByKeyAndPromotionresultkey 4 params → 200
GET
/api/v1/admin/products({key})/restrictiongroupadditions({restrictiongroupKey})
Products_GetRestrictionGroupAdditionByKeyAndRestrictiongroupkey 4 params → 200
GET
/api/v1/admin/products({key})/restrictiongroupexceptions({restrictiongroupKey})
Products_GetRestrictionGroupExceptionByKeyAndRestrictiongroupkey 4 params → 200
GET
/api/v1/admin/products({key})/restrictiongroups({restrictiongroupKey})
Products_GetRestrictionGroupByKeyAndRestrictiongroupkey 4 params → 200
GET
/api/v1/admin/products({key})/ruleclauses({ruleclauseKey})
Products_GetRuleClauseByKeyAndRuleclausekey 4 params → 200
GET
/api/v1/admin/products({key})/specifications({specificationKey})
Products_GetSpecificationByKeyAndSpecificationkey 4 params → 200
GET
/api/v1/admin/products({key})/stylechildren({productKey})
Products_GetStyleChildrenByKeyAndProductkey 4 params → 200
GET
/api/v1/admin/products({key})/styletraitvalues({styletraitvalueKey})
Products_GetStyleTraitValueByKeyAndStyletraitvaluekey 4 params → 200
GET
/api/v1/admin/products({key})/subscriptionproducts({subscriptionproductKey})
Products_GetSubscriptionProductByKeyAndSubscriptionproductkey 4 params → 200
GET
/api/v1/admin/products({key})/taxexemptions({taxexemptionKey})
Products_GetTaxExemptionByKeyAndTaxexemptionkey 4 params → 200
GET
/api/v1/admin/products({key})/websites({websiteKey})
Products_GetWebsiteByKeyAndWebsitekey 4 params → 200
GET
/api/v1/admin/products({key})/wishlistproducts({wishlistproductKey})
Products_GetWishListProductByKeyAndWishlistproductkey 4 params → 200
GET
/api/v1/products
ProductsV1_GetCollectionAsync 31 params → 200
GET
/api/v1/products/{productId}
ProductsV1_GetAsync 13 params → 200
GET
/api/v1/products/{productId}/crosssells
ProductsV1_GetCrossSellAsync 1 param → 200
GET
/api/v1/products/{productId}/price
ProductsV1_GetPriceAsync 8 params → 200
GET
/api/v1/products/{productId}/availability
ProductsV1_GetAvailabilityAsync 4 params → 200
POST
/api/v1/products/batchget
ProductsV1_BatchGet body → 200
GET
/api/v1/products/feederData
ProductsV1_GetFeederData → 200
GET
/api/v2/products
ProductsV2_GetAsync 29 params → 200
GET
/api/v2/products/{ProductId}
ProductsV2_GetAsync2ByProductid 7 params → 200
GET
/api/v2/products/{productId}/alsopurchased
ProductsV2_GetAlsoPurchasedCollectionAsyncByProductid 8 params → 200
GET
/api/v2/products/{productId}/relatedproducts
ProductsV2_GetRelatedProductCollectionAsyncByProductid 9 params → 200
GET
/api/v2/products/{productId}/variantchildren
ProductsV2_GetVariantChildCollectionAsyncByProductid 9 params → 200
GET
/api/v2/products/{productId}/variantchildren/{variantChildId}
ProductsV2_GetVariantChildAsyncByProductidAndVariantchildid 6 params → 200
GET
/api/v2/products/feederData/productWithMostAttributes
ProductsV2_GetProductWithMostAttributes → 200
GET
/api/v2/products/feederData/productWithMostVariants
ProductsV2_GetProductWithMostVariants → 200
POST
/objects/products
Update Products
update-products body → 202400403404

Schemas 75

The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are Insite.Data.Entities.Product (120 properties), Insite.Catalog.Services.Dtos.ProductDto (114 properties), Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel (51 properties), Insite.Core.Plugins.Pricing.ProductPriceDto (43 properties). Each schema is shown below with its type and property counts.

Insite.Data.Entities.Product
object
120 properties 26 required
Insite.Core.Plugins.Search.Dtos.CategoryFacetDto
object
6 properties
Insite.Catalog.WebApi.V1.ApiModels.ProductModel
object
3 properties
Insite.Catalog.WebApi.V1.ApiModels.BatchGetProductParameter
object
1 property
Insite.Catalog.Services.Dtos.ConfigSectionOptionDto
object
11 properties
Insite.Core.WebApi.PaginationModel
object
12 properties
Insite.Core.Plugins.Search.Dtos.GenericFacetDto
object
5 properties
Insite.Core.Plugins.Search.Dtos.PriceRangeDto
object
4 properties
Insite.Catalog.Services.Dtos.ConfigSectionDto
object
3 properties
Insite.Catalog.Services.Dtos.BadgeDto
object
19 properties
Insite.Catalog.WebApi.V1.ApiModels.ProductCollectionModel
object
16 properties
Insite.Catalog.Services.Dtos.BrandDto
object
7 properties
Insite.Catalog.Services.Dtos.RelatedProductDto
object
2 properties
Insite.Core.Plugins.Search.Dtos.ScoreExplanationDto
object
3 properties
Insite.Core.WebApi.SortOptionModel
object
2 properties
Insite.Catalog.Services.Dtos.ProductSubscriptionDto
object
19 properties
Insite.Catalog.Services.Dtos.StyleTraitDto
object
9 properties
Insite.Core.Plugins.Search.Dtos.FieldScoreDetailedDto
object
7 properties
Insite.Catalog.WebApi.V1.ApiModels.ProductPriceModel
object
37 properties
Insite.Catalog.WebApi.V1.ApiModels.CrossSellCollectionModel
object
3 properties
Insite.Catalog.Services.Dtos.LegacyConfigurationDto
object
3 properties
Insite.Core.Plugins.Search.Dtos.AttributeValueFacetDto
object
8 properties
Insite.Catalog.Services.Dtos.DocumentDto
object
9 properties
Insite.Core.Plugins.Pricing.ProductPriceDto
object
43 properties
Insite.Catalog.Services.Dtos.StyledProductDto
object
38 properties
Insite.Core.Plugins.Search.Dtos.AttributeTypeFacetDto
object
5 properties
Insite.Catalog.Services.Dtos.AttributeTypeDto
object
10 properties
Insite.Catalog.Services.Dtos.StyleValueDto
object
10 properties
Insite.Catalog.Services.Dtos.WarehouseDto
object
7 properties
Insite.Catalog.Services.Dtos.AvailabilityDto
object
3 properties
Insite.Core.Plugins.Pricing.BreakPriceDto
object
6 properties
Insite.Catalog.Services.Dtos.ProductDto
object
114 properties
Insite.Catalog.Services.Dtos.AttributeValueDto
object
5 properties
Insite.Catalog.Services.Dtos.ProductImageDto
object
8 properties
Insite.Catalog.Services.Dtos.ProductLineDto
object
2 properties
Insite.Core.Plugins.Search.Dtos.FieldScoreDto
object
2 properties
Insite.Core.Plugins.Search.Dtos.SuggestionDto
object
3 properties
Insite.Core.Plugins.Search.Dtos.PriceFacetDto
object
4 properties
Insite.Catalog.Services.Dtos.SpecificationDto
object
10 properties
Insite.Catalog.Services.Dtos.ProductUnitOfMeasureDto
object
8 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.FieldScoreModel
object
2 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.TraitValueModel
object
8 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ProductLineModel
object
4 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.FacetModel
object
5 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ConfigurationModel
object
3 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeTypeModel
object
9 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.SectionOptionModel
object
9 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeValueModel
object
4 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ContentModel
object
7 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.DocumentModel
object
5 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.BrandModel
object
9 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ConfigSectionModel
object
5 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.PriceFacetModel
object
4 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.DetailModel
object
29 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ProductSubscriptionModel
object
21 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.BadgeModel
object
19 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ImageModel
object
8 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ScoreExplanationModel
object
3 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel
object
51 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.FieldScoreDetailedModel
object
7 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ChildTraitValueModel
object
4 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.UnitOfMeasureModel
object
7 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeValueFacetModel
object
6 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.SuggestionModel
object
3 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.WarehouseModel
object
4 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.SpecificationModel
object
7 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.PriceRangeModel
object
4 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.VariantTraitModel
object
9 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel
object
17 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.CategoryFacetModel
object
5 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeTypeFacetModel
object
5 properties
403Response
object
1 property
40xResponse
object
4 properties
GenericUpdateResponse
object
3 properties
Product
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

optimizely-products-api-openapi.yml Raw ↑

Other APIs Optimizely publishes across the network.

Optimizely Remote MCP Server — Experimentation
Optimizely Assets API
Optimizely Attributes API
Optimizely Audiences API
Optimizely Campaigns API
Optimizely Catalog Entries API
Optimizely Catalog Entry Relations API
Optimizely Catalog Nodes API
Optimizely Catalogs API
Optimizely Content API
Optimizely Content Types API
Optimizely Customers API
Where this information came from

This is an independent, third-party profile of Optimizely Products API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.