openapi: 3.2.0 info: title: Optimizely Products API version: '1.0' description: 'Operations tagged Products across 4 of this provider''s published API definitions: optimizely-configured-commerce-admin-api-v1-openapi.json, optimizely-configured-commerce-storefront-api-v1-openapi.json, optimizely-configured-commerce-storefront-api-v2-openapi.json, optimizely-data-platform-products-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: https://dogfood.commerce.insitesandbox.com - url: https://api.us1.odp.optimizely.com/v3 description: United States - url: https://api.eu1.odp.optimizely.com/v3 description: Europe - url: https://api.au1.odp.optimizely.com/v3 description: Asia-Pacific tags: - name: Products paths: /api/v1/admin/Products: get: tags: - Products summary: Returns the EntitySet Products operationId: Products_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: - Products summary: Post a new entity to EntitySet Products operationId: Products_Post requestBody: content: application/json: schema: $ref: '#/components/schemas/Insite.Data.Entities.Product' 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/Products({id}): get: tags: - Products summary: Returns the entity with the key from Products operationId: Products_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: - Products summary: Replace entity in EntitySet Products operationId: Products_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.Product' description: The entity to put required: true responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] delete: tags: - Products summary: Delete entity in EntitySet Products operationId: Products_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: - Products summary: Update entity in EntitySet Products operationId: Products_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.Product' 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/Products/Default.Default(): get: tags: - Products summary: Call operation Default operationId: Products_Default responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] servers: - url: https://dogfood.commerce.insitesandbox.com /api/v1/admin/Products/Default.archive: post: tags: - Products summary: Call operation archive operationId: Products_Archive parameters: - name: ids in: query required: true explode: true schema: type: array items: type: string format: uuid requestBody: $ref: '#/components/requestBodies/Affiliates_ArchiveParameters' responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] servers: - url: https://dogfood.commerce.insitesandbox.com /api/v1/admin/Products/Default.isdiscontinued(productId={productId}): get: tags: - Products summary: Call operation isdiscontinued operationId: Products_IsDiscontinuedByProductid_1 parameters: - name: productId in: path description: 'parameter: productId' required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: type: boolean deprecated: false security: - access_token: [] servers: - url: https://dogfood.commerce.insitesandbox.com /api/v1/admin/Products/Default.unitofmeasures(productId={productId}): get: tags: - Products summary: Call operation unitofmeasures operationId: Products_UnitOfMeasuresByProductid_1 parameters: - name: productId in: path description: 'parameter: productId' 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/products/isdiscontinued(productId={productId}): get: tags: - Products operationId: Products_IsDiscontinuedByProductid_2 parameters: - name: productId in: path required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: type: boolean deprecated: false security: - access_token: [] servers: - url: https://dogfood.commerce.insitesandbox.com /api/v1/admin/products/unitofmeasures(productId={productId}): get: tags: - Products operationId: Products_UnitOfMeasuresByProductid_2 parameters: - name: productId 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/products/archive: delete: tags: - Products operationId: Products_ArchiveRoute 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/products/delete: delete: tags: - Products operationId: Products_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/products({key})/attributevalues({attributevalueKey}): get: tags: - Products operationId: Products_GetAttributeValueByKeyAndAttributevaluekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: attributevalueKey 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/products({key})/badges({badgeKey}): get: tags: - Products operationId: Products_GetBadgeByKeyAndBadgekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: badgeKey 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/products({key})/categories({categoryKey}): get: tags: - Products operationId: Products_GetCategoryByKeyAndCategorykey parameters: - name: key in: path required: true schema: type: string format: uuid - name: categoryKey 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/products({key})/customerproductsets({customerproductsetKey}): get: tags: - Products operationId: Products_GetCustomerProductSetByKeyAndCustomerproductsetkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: customerproductsetKey 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/products({key})/customervisibilityadditions({customerKey}): get: tags: - Products operationId: Products_GetCustomerVisibilityAdditionByKeyAndCustomerkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: customerKey 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/products({key})/customervisibilityexceptions({customerKey}): get: tags: - Products operationId: Products_GetCustomerVisibilityExceptionByKeyAndCustomerkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: customerKey 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/products({key})/customproperties({custompropertyKey}): get: tags: - Products operationId: Products_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/products({key})/dealers({dealerKey}): get: tags: - Products operationId: Products_GetDealerByKeyAndDealerkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: dealerKey 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/products({key})/documents({documentKey}): get: tags: - Products operationId: Products_GetDocumentByKeyAndDocumentkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: documentKey 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/products({key})/parentrelatedcategories({categoryrelatedproductKey}): get: tags: - Products operationId: Products_GetParentRelatedCategoryByKeyAndCategoryrelatedproductkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: categoryrelatedproductKey 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/products({key})/parentrelatedproducts({productrelatedproductKey}): get: tags: - Products operationId: Products_GetParentRelatedProductByKeyAndProductrelatedproductkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: productrelatedproductKey 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/products({key})/productimages({productimageKey}): get: tags: - Products operationId: Products_GetProductImageByKeyAndProductimagekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: productimageKey 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/products({key})/productkitsections({productkitsectionKey}): get: tags: - Products operationId: Products_GetProductKitSectionByKeyAndProductkitsectionkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: productkitsectionKey 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/products({key})/productrelatedproducts({productrelatedproductKey}): get: tags: - Products operationId: Products_GetProductRelatedProductByKeyAndProductrelatedproductkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: productrelatedproductKey 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/products({key})/productunitofmeasures({productunitofmeasureKey}): get: tags: - Products operationId: Products_GetProductUnitOfMeasureByKeyAndProductunitofmeasurekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: productunitofmeasureKey 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/products({key})/productwarehouses({productwarehouseKey}): get: tags: - Products operationId: Products_GetProductWarehouseByKeyAndProductwarehousekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: productwarehouseKey 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/products({key})/promotionresults({promotionresultKey}): get: tags: - Products operationId: Products_GetPromotionResultByKeyAndPromotionresultkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: promotionresultKey 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/products({key})/restrictiongroupadditions({restrictiongroupKey}): get: tags: - Products operationId: Products_GetRestrictionGroupAdditionByKeyAndRestrictiongroupkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: restrictiongroupKey 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/products({key})/restrictiongroupexceptions({restrictiongroupKey}): get: tags: - Products operationId: Products_GetRestrictionGroupExceptionByKeyAndRestrictiongroupkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: restrictiongroupKey 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/products({key})/restrictiongroups({restrictiongroupKey}): get: tags: - Products operationId: Products_GetRestrictionGroupByKeyAndRestrictiongroupkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: restrictiongroupKey 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/products({key})/ruleclauses({ruleclauseKey}): get: tags: - Products operationId: Products_GetRuleClauseByKeyAndRuleclausekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: ruleclauseKey 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/products({key})/specifications({specificationKey}): get: tags: - Products operationId: Products_GetSpecificationByKeyAndSpecificationkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: specificationKey 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/products({key})/stylechildren({productKey}): get: tags: - Products operationId: Products_GetStyleChildrenByKeyAndProductkey 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/admin/products({key})/styletraitvalues({styletraitvalueKey}): get: tags: - Products operationId: Products_GetStyleTraitValueByKeyAndStyletraitvaluekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: styletraitvalueKey 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/products({key})/subscriptionproducts({subscriptionproductKey}): get: tags: - Products operationId: Products_GetSubscriptionProductByKeyAndSubscriptionproductkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: subscriptionproductKey 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/products({key})/taxexemptions({taxexemptionKey}): get: tags: - Products operationId: Products_GetTaxExemptionByKeyAndTaxexemptionkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: taxexemptionKey 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/products({key})/websites({websiteKey}): get: tags: - Products operationId: Products_GetWebsiteByKeyAndWebsitekey parameters: - name: key in: path required: true schema: type: string format: uuid - name: websiteKey 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/products({key})/wishlistproducts({wishlistproductKey}): get: tags: - Products operationId: Products_GetWishListProductByKeyAndWishlistproductkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: wishlistproductKey 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/products: get: tags: - Products operationId: ProductsV1_GetCollectionAsync parameters: - name: model.query in: query required: false schema: type: string - name: model.categoryId in: query required: false schema: type: string format: uuid - name: model.brandIds in: query required: false explode: true schema: type: array items: type: string format: uuid - name: model.productLineIds in: query required: false explode: true schema: type: array items: type: string format: uuid - name: model.attributeValueIds in: query required: false explode: true schema: type: array items: type: string - name: model.priceFilters in: query required: false explode: true schema: type: array items: type: integer format: int32 - name: model.minimumPrice in: query required: false schema: type: number format: double - name: model.maximumPrice in: query required: false schema: type: number format: double - name: model.sort in: query required: false schema: type: string - name: model.page in: query required: false schema: type: integer format: int32 - name: model.pageSize in: query required: false schema: type: integer format: int32 - name: model.productIds in: query required: false explode: true schema: type: array items: type: string format: uuid - name: model.names in: query required: false explode: true schema: type: array items: type: string - name: model.erpNumbers in: query required: false explode: true schema: type: array items: type: string - name: model.extendedNames in: query required: false explode: true schema: type: array items: type: string - name: model.replaceProducts in: query required: false schema: type: boolean - name: model.priceParameters in: query required: false explode: true schema: type: array items: {} - name: model.expand in: query required: false schema: type: string - name: model.includeSuggestions in: query required: false schema: type: boolean - name: model.searchWithin in: query required: false schema: type: string - name: model.getAllAttributeFacets in: query required: false schema: type: boolean - name: model.filter in: query required: false schema: type: string - name: model.topSellersCategoryIds in: query required: false explode: true schema: type: array items: type: string format: uuid - name: model.topSellersPersonaIds in: query required: false explode: true schema: type: array items: type: string format: uuid - name: model.topSellersMaxResults in: query required: false schema: type: integer format: int32 - name: model.applyPersonalization in: query required: false schema: type: boolean - name: model.includeAttributes in: query required: false schema: type: string - name: model.includeAlternateInventory in: query required: false schema: type: boolean - name: model.makeBrandUrls in: query required: false schema: type: boolean - name: model.previouslyPurchasedProducts in: query required: false schema: type: boolean - name: model.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/products/{productId}: get: tags: - Products operationId: ProductsV1_GetAsync parameters: - name: productId in: path required: true schema: type: string - name: parameter.productId in: query required: false schema: type: string format: uuid - name: parameter.categoryId in: query required: false schema: type: string format: uuid - name: parameter.replaceProducts in: query required: false schema: type: boolean - name: parameter.unitOfMeasure in: query required: false schema: type: string - name: parameter.qtyOrdered in: query required: false schema: type: number format: decimal - name: parameter.configuration in: query required: false explode: true schema: type: array items: type: string format: uuid - name: parameter.expand in: query required: false schema: type: string - name: parameter.addToRecentlyViewed in: query required: false schema: type: boolean - name: parameter.alsoPurchasedMaxResults 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 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductModel' text/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductModel' application/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductModel' text/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductModel' text/html: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductModel' servers: - url: https://dogfood.commerce.insitesandbox.com /api/v1/products/{productId}/crosssells: get: tags: - Products operationId: ProductsV1_GetCrossSellAsync parameters: - name: productId in: path required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CrossSellCollectionModel' text/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CrossSellCollectionModel' application/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CrossSellCollectionModel' text/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CrossSellCollectionModel' text/html: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CrossSellCollectionModel' servers: - url: https://dogfood.commerce.insitesandbox.com /api/v1/products/{productId}/price: get: tags: - Products operationId: ProductsV1_GetPriceAsync parameters: - name: productId in: path required: true schema: type: string - name: productPriceModel.productId in: query required: false schema: type: string - name: productPriceModel.unitOfMeasure in: query required: false schema: type: string - name: productPriceModel.qtyOrdered in: query required: false schema: type: number format: decimal - name: productPriceModel.configuration in: query required: false explode: true schema: type: array items: type: string format: uuid - name: productPriceModel.properties in: query required: false schema: type: string - name: productPriceModel.isValid in: query required: false schema: type: boolean - name: productPriceModel.validationMessage in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductPriceModel' text/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductPriceModel' application/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductPriceModel' text/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductPriceModel' text/html: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductPriceModel' servers: - url: https://dogfood.commerce.insitesandbox.com /api/v1/products/{productId}/availability: get: tags: - Products operationId: ProductsV1_GetAvailabilityAsync parameters: - name: productId in: path required: true schema: type: string - name: productAvailabilityParameter.productId in: query required: false schema: type: string - name: productAvailabilityParameter.includeAlternateInventory in: query required: false schema: type: boolean - name: productAvailabilityParameter.configuration in: query required: false explode: true schema: type: array items: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductPriceModel' text/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductPriceModel' application/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductPriceModel' text/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductPriceModel' text/html: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.ProductPriceModel' servers: - url: https://dogfood.commerce.insitesandbox.com /api/v1/products/batchget: post: tags: - Products operationId: ProductsV1_BatchGet requestBody: content: application/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.BatchGetProductParameter' text/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.BatchGetProductParameter' application/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.BatchGetProductParameter' text/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.BatchGetProductParameter' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.BatchGetProductParameter' text/html: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.BatchGetProductParameter' required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' text/json: schema: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' application/xml: schema: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' text/xml: schema: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' text/html: schema: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' servers: - url: https://dogfood.commerce.insitesandbox.com /api/v1/products/feederData: get: tags: - Products operationId: ProductsV1_GetFeederData responses: '200': description: OK content: application/json: schema: type: object text/json: schema: type: object application/xml: schema: type: object text/xml: schema: type: object text/html: schema: type: object servers: - url: https://dogfood.commerce.insitesandbox.com /api/v2/products: get: tags: - Products operationId: ProductsV2_GetAsync parameters: - name: model.search in: query required: false schema: type: string - name: model.searchWithin in: query required: false schema: type: string - name: model.productIds in: query required: false explode: true schema: type: array items: type: string format: uuid - name: model.names in: query required: false explode: true schema: type: array items: type: string - name: model.productNumbers in: query required: false explode: true schema: type: array items: type: string - name: model.extendedNames in: query required: false explode: true schema: type: array items: type: string - name: model.categoryId in: query required: false schema: type: string format: uuid - name: model.includeProductsInSubCategories in: query required: false schema: type: boolean - name: model.brandIds in: query required: false explode: true schema: type: array items: type: string format: uuid - name: model.productLineIds in: query required: false explode: true schema: type: array items: type: string format: uuid - name: model.attributeValueIds in: query required: false explode: true schema: type: array items: type: string - name: model.priceFilters in: query required: false explode: true schema: type: array items: type: integer format: int32 - name: model.minimumPrice in: query required: false schema: type: number format: double - name: model.maximumPrice in: query required: false schema: type: number format: double - name: model.includeSuggestions in: query required: false schema: type: boolean - name: model.filter in: query required: false schema: type: string - name: model.topSellersCategoryIds in: query required: false explode: true schema: type: array items: type: string format: uuid - name: model.topSellersPersonaIds in: query required: false explode: true schema: type: array items: type: string format: uuid - name: model.cartId in: query required: false schema: type: string - name: model.applyPersonalization in: query required: false schema: type: boolean - name: model.stockedItemsOnly in: query required: false schema: type: boolean - name: model.previouslyPurchasedProducts in: query required: false schema: type: boolean - name: model.relevancy in: query required: false schema: type: boolean - name: model.expand in: query required: false schema: type: string - name: model.includeAttributes in: query required: false schema: type: string - name: model.sort in: query required: false schema: type: string - name: model.page in: query required: false schema: type: integer format: int32 - name: model.pageSize in: query required: false schema: type: integer format: int32 - name: model.pageToken in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' text/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' application/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' text/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' text/html: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' servers: - url: https://dogfood.commerce.insitesandbox.com /api/v2/products/{ProductId}: get: tags: - Products operationId: ProductsV2_GetAsync2ByProductid parameters: - name: ProductId in: path required: true schema: type: string - name: parameter.productId in: query required: false schema: type: string format: uuid - name: parameter.includeAttributes in: query required: false schema: type: string - name: parameter.expand in: query required: false schema: type: string - name: parameter.addToRecentlyViewed in: query required: false schema: type: boolean - name: parameter.applyPersonalization in: query required: false schema: type: boolean - name: parameter.categoryId in: query required: false schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel' text/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel' application/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel' text/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel' text/html: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel' servers: - url: https://dogfood.commerce.insitesandbox.com /api/v2/products/{productId}/alsopurchased: get: tags: - Products operationId: ProductsV2_GetAlsoPurchasedCollectionAsyncByProductid parameters: - name: productId in: path required: true schema: type: string format: uuid - name: parameter.productId in: query required: false schema: type: string format: uuid - name: parameter.expand in: query required: false schema: type: string - name: parameter.includeAttributes in: query required: false schema: type: string - 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.pageToken in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' text/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' application/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' text/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' text/html: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' servers: - url: https://dogfood.commerce.insitesandbox.com /api/v2/products/{productId}/relatedproducts: get: tags: - Products operationId: ProductsV2_GetRelatedProductCollectionAsyncByProductid parameters: - name: productId in: path required: true schema: type: string format: uuid - name: parameter.productId in: query required: false schema: type: string format: uuid - name: parameter.relationship in: query required: false schema: type: string - name: parameter.expand in: query required: false schema: type: string - name: parameter.includeAttributes in: query required: false schema: type: string - 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.pageToken in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' text/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' application/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' text/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' text/html: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' servers: - url: https://dogfood.commerce.insitesandbox.com /api/v2/products/{productId}/variantchildren: get: tags: - Products operationId: ProductsV2_GetVariantChildCollectionAsyncByProductid parameters: - name: productId in: path required: true schema: type: string format: uuid - name: parameter.productId 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 - name: parameter.includeAttributes in: query required: false schema: type: string - 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.pageToken in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' text/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' application/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' text/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' text/html: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel' servers: - url: https://dogfood.commerce.insitesandbox.com /api/v2/products/{productId}/variantchildren/{variantChildId}: get: tags: - Products operationId: ProductsV2_GetVariantChildAsyncByProductidAndVariantchildid parameters: - name: productId in: path required: true schema: type: string format: uuid - name: variantChildId in: path required: true schema: type: string format: uuid - name: parameter.productId in: query required: false schema: type: string format: uuid - name: parameter.variantChildId in: query required: false schema: type: string format: uuid - name: parameter.includeAttributes in: query required: false schema: type: string - name: parameter.expand in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel' text/json: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel' application/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel' text/xml: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel' text/html: schema: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel' servers: - url: https://dogfood.commerce.insitesandbox.com /api/v2/products/feederData/productWithMostAttributes: get: tags: - Products operationId: ProductsV2_GetProductWithMostAttributes responses: '200': description: OK content: application/json: schema: type: object text/json: schema: type: object application/xml: schema: type: object text/xml: schema: type: object text/html: schema: type: object servers: - url: https://dogfood.commerce.insitesandbox.com /api/v2/products/feederData/productWithMostVariants: get: tags: - Products operationId: ProductsV2_GetProductWithMostVariants responses: '200': description: OK content: application/json: schema: type: object text/json: schema: type: object application/xml: schema: type: object text/xml: schema: type: object text/html: schema: type: object servers: - url: https://dogfood.commerce.insitesandbox.com /objects/products: post: tags: - Products summary: Update Products description: Update products with new metadata as your inventory updates. operationId: update-products requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Product' examples: Example Payload: description: Example Payload value: - product_id: 123 name: Red Shirt - product_id: 456 name: Blue Shirt required: true responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/GenericUpdateResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/40xResponse' example: '{"title":"Bad Request","status":400,"timestamp":"2018-09-10T21:07:10-05:00","detail":{"invalids":[{"field":"delimiter","reason":"Unrecognized delimiter, valid options are comma, tab or pipe"}]}}' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/403Response' example: '{ "message": "Forbidden"}' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/40xResponse' example: '{"title":"Bad Request","status":404,"timestamp":"2018-09-10T21:07:10-05:00","detail":{"message":"Not found description"}}' security: - x-api-key: [] servers: - url: https://api.us1.odp.optimizely.com/v3 description: United States - url: https://api.eu1.odp.optimizely.com/v3 description: Europe - url: https://api.au1.odp.optimizely.com/v3 description: Asia-Pacific components: requestBodies: Affiliates_ArchiveParameters: content: application/json: schema: type: object properties: {} description: archive action parameters schemas: Insite.Data.Entities.Product: required: - erpDescription - erpNumber - manufacturerItem - metaDescription - metaKeywords - modelNumber - name - packDescription - pageTitle - priceBasis - priceCode - productCode - roundingRule - shippingClassification - shortDescription - sku - subscriptionCyclePeriod - taxCategory - taxCode1 - taxCode2 - unitOfMeasure - unitOfMeasureDescription - unspsc - upcCode - urlSegment - defaultVisibility type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 activateOn: format: date-time type: string allowAnyGiftCardAmount: type: boolean basicListPrice: format: decimal type: number basicSaleEndDate: format: date-time type: string basicSalePrice: format: decimal type: number basicSaleStartDate: format: date-time type: string configurationObjectId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 contentManagerId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 customAvailabilityMessage: type: string deactivateOn: format: date-time type: string displayPricePerPiece: type: boolean erpDescription: maxLength: 2048 minLength: 0 type: string erpManaged: type: boolean erpNumber: maxLength: 50 minLength: 0 type: string handlingAmountOverride: format: double type: number hasMsds: type: boolean indexStatus: format: int32 type: integer isConfigured: type: boolean isDiscontinued: type: boolean isFixedConfiguration: type: boolean isGiftCard: type: boolean isHazardousGood: type: boolean isSpecialOrder: type: boolean isSponsored: type: boolean isSubscription: type: boolean lowStockLevel: format: decimal type: number manufacturerItem: maxLength: 100 minLength: 0 type: string metaDescription: type: string metaKeywords: type: string minimumOrderQty: format: int32 type: integer maximumOrderQty: format: int32 type: integer modelNumber: maxLength: 50 minLength: 0 type: string multipleSaleQty: format: int32 type: integer name: maxLength: 255 minLength: 0 type: string packDescription: maxLength: 255 minLength: 0 type: string pageTitle: maxLength: 1024 minLength: 0 type: string priceBasis: maxLength: 50 minLength: 0 type: string priceCode: maxLength: 50 minLength: 0 type: string productCode: maxLength: 50 minLength: 0 type: string qtyPerShippingPackage: format: int32 type: integer isQuoteRequired: type: boolean replacementProductId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 roundingRule: maxLength: 50 minLength: 0 type: string salePriceLabel: maxLength: 255 minLength: 0 type: string shipSeparately: type: boolean shippingAmountOverride: format: double type: number shippingClassification: maxLength: 100 minLength: 0 type: string shippingHeight: format: decimal type: number shippingLength: format: decimal type: number shippingWeight: format: decimal type: number shippingWidth: format: decimal type: number shortDescription: maxLength: 2048 minLength: 0 type: string sku: maxLength: 100 minLength: 0 type: string sortOrder: format: int32 type: integer searchBoost: format: decimal type: number styleClassId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 styleParentId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 subscriptionAddToInitialOrder: type: boolean subscriptionAllMonths: type: boolean subscriptionApril: type: boolean subscriptionAugust: type: boolean subscriptionCyclePeriod: maxLength: 50 minLength: 0 type: string subscriptionDecember: type: boolean subscriptionFebruary: type: boolean subscriptionFixedPrice: type: boolean subscriptionJanuary: type: boolean subscriptionJuly: type: boolean subscriptionJune: type: boolean subscriptionMarch: type: boolean subscriptionMay: type: boolean subscriptionNovember: type: boolean subscriptionOctober: type: boolean subscriptionPeriodsPerCycle: format: int32 type: integer subscriptionSeptember: type: boolean subscriptionShipViaId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 subscriptionTotalCycles: format: int32 type: integer taxCategory: maxLength: 50 minLength: 0 type: string taxCode1: maxLength: 50 minLength: 0 type: string taxCode2: maxLength: 50 minLength: 0 type: string trackInventory: type: boolean unitCost: format: decimal type: number unitOfMeasure: maxLength: 50 minLength: 0 type: string unitOfMeasureDescription: maxLength: 100 minLength: 0 type: string unspsc: maxLength: 100 minLength: 0 type: string upcCode: maxLength: 50 minLength: 0 type: string urlSegment: maxLength: 255 minLength: 0 type: string vatCodeId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 vendorId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 brandId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 productLineId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 isStocked: type: boolean isStockedAtWarehouseLevel: type: boolean defaultVisibility: maxLength: 50 minLength: 0 type: string openGraphTitle: maxLength: 2048 minLength: 0 type: string openGraphUrl: maxLength: 2048 minLength: 0 type: string openGraphImage: maxLength: 1024 minLength: 0 type: string excludeFromRecommendations: type: boolean isSeasonal: type: boolean seasonalJanuary: type: boolean seasonalFebruary: type: boolean seasonalMarch: type: boolean seasonalApril: type: boolean seasonalMay: type: boolean seasonalJune: type: boolean seasonalJuly: type: boolean seasonalAugust: type: boolean seasonalSeptember: type: boolean seasonalOctober: type: boolean seasonalNovember: type: boolean seasonalDecember: type: boolean excludeWhenOutOfSeason: type: boolean cantBuy: type: boolean allowZeroPricing: type: boolean defaultChildProductId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 ruleManagerId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 createdOn: format: date-time type: string createdBy: type: string modifiedOn: format: date-time type: string modifiedBy: type: string Insite.Core.Plugins.Search.Dtos.CategoryFacetDto: type: object properties: categoryId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 websiteId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 shortDescription: type: string count: format: int32 type: integer selected: type: boolean subCategoryDtos: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Search.Dtos.CategoryFacetDto' Insite.Catalog.WebApi.V1.ApiModels.ProductModel: type: object properties: uri: type: string product: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' properties: type: object additionalProperties: type: string Insite.Catalog.WebApi.V1.ApiModels.BatchGetProductParameter: type: object properties: extendedNames: type: array items: type: string Insite.Catalog.Services.Dtos.ConfigSectionOptionDto: type: object properties: sectionOptionId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 sectionName: type: string productName: type: string productId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 description: type: string price: format: decimal type: number userProductPrice: type: boolean selected: type: boolean sortOrder: format: int32 type: integer quantity: format: decimal type: number cantBuy: type: boolean Insite.Core.WebApi.PaginationModel: type: object properties: currentPage: format: int32 type: integer page: format: int32 type: integer pageSize: format: int32 type: integer defaultPageSize: format: int32 type: integer totalItemCount: format: int32 type: integer numberOfPages: format: int32 type: integer pageSizeOptions: type: array items: format: int32 type: integer sortOptions: type: array items: $ref: '#/components/schemas/Insite.Core.WebApi.SortOptionModel' sortType: type: string nextPageUri: type: string prevPageUri: type: string nextPageToken: type: string Insite.Core.Plugins.Search.Dtos.GenericFacetDto: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string count: format: int32 type: integer sortOrder: format: int32 type: integer selected: type: boolean Insite.Core.Plugins.Search.Dtos.PriceRangeDto: type: object properties: minimumPrice: format: decimal type: number maximumPrice: format: decimal type: number count: format: int32 type: integer priceFacets: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Search.Dtos.PriceFacetDto' Insite.Catalog.Services.Dtos.ConfigSectionDto: type: object properties: sectionName: type: string label: type: string options: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ConfigSectionOptionDto' Insite.Catalog.Services.Dtos.BadgeDto: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string tagName: type: string badgeStyle: type: string sortOrder: format: int32 type: integer badgeType: type: string displayOnProductImages: type: boolean displayOnBadgeWidget: type: boolean displayText: type: string textColorHexCode: type: string badgeColorHexCode: type: string largeImageBadgePath: type: string largeImageTextSize: type: string largeImagePlacement: type: string otherImageBadgePath: type: string otherImageTextSize: type: string otherImagePlacement: type: string imageAltText: type: string detailWidgetBadgeSize: type: string Insite.Catalog.WebApi.V1.ApiModels.ProductCollectionModel: type: object properties: uri: type: string pagination: $ref: '#/components/schemas/Insite.Core.WebApi.PaginationModel' products: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' categoryFacets: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Search.Dtos.CategoryFacetDto' attributeTypeFacets: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Search.Dtos.AttributeTypeFacetDto' brandFacets: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Search.Dtos.GenericFacetDto' productLineFacets: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Search.Dtos.GenericFacetDto' didYouMeanSuggestions: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Search.Dtos.SuggestionDto' priceRange: $ref: '#/components/schemas/Insite.Core.Plugins.Search.Dtos.PriceRangeDto' exactMatch: type: boolean notAllProductsFound: type: boolean notAllProductsAllowed: type: boolean originalQuery: type: string correctedQuery: type: string searchTermRedirectUrl: type: string properties: type: object additionalProperties: type: string Insite.Catalog.Services.Dtos.BrandDto: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string urlSegment: type: string logoSmallImagePath: type: string logoLargeImagePath: type: string logoImageAltText: type: string detailPagePath: type: string Insite.Catalog.Services.Dtos.RelatedProductDto: type: object properties: relatedProductType: type: string productDto: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' Insite.Core.Plugins.Search.Dtos.ScoreExplanationDto: type: object properties: totalBoost: format: float type: number aggregateFieldScores: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Search.Dtos.FieldScoreDto' detailedFieldScores: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Search.Dtos.FieldScoreDetailedDto' Insite.Core.WebApi.SortOptionModel: type: object properties: displayName: type: string sortType: type: string Insite.Catalog.Services.Dtos.ProductSubscriptionDto: type: object properties: subscriptionAddToInitialOrder: type: boolean subscriptionAllMonths: type: boolean subscriptionApril: type: boolean subscriptionAugust: type: boolean subscriptionCyclePeriod: type: string subscriptionDecember: type: boolean subscriptionFebruary: type: boolean subscriptionFixedPrice: type: boolean subscriptionJanuary: type: boolean subscriptionJuly: type: boolean subscriptionJune: type: boolean subscriptionMarch: type: boolean subscriptionMay: type: boolean subscriptionNovember: type: boolean subscriptionOctober: type: boolean subscriptionPeriodsPerCycle: format: int32 type: integer subscriptionSeptember: type: boolean subscriptionShipViaId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 subscriptionTotalCycles: format: int32 type: integer Insite.Catalog.Services.Dtos.StyleTraitDto: type: object properties: styleTraitId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string nameDisplay: type: string unselectedValue: type: string sortOrder: format: int32 type: integer styleValues: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.StyleValueDto' displayType: type: string numberOfSwatchesVisible: format: int32 type: integer displayTextWithSwatch: type: boolean Insite.Core.Plugins.Search.Dtos.FieldScoreDetailedDto: type: object properties: name: type: string score: format: float type: number boost: format: float type: number matchText: type: string termFrequencyNormalized: format: float type: number inverseDocumentFrequency: format: float type: number scoreUsed: type: boolean Insite.Catalog.WebApi.V1.ApiModels.ProductPriceModel: type: object properties: uri: type: string productId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 isOnSale: type: boolean requiresRealTimePrice: type: boolean quoteRequired: type: boolean additionalResults: type: object additionalProperties: type: string unitCost: format: decimal type: number unitCostDisplay: type: string unitListPrice: format: decimal type: number unitListPriceDisplay: type: string extendedUnitListPrice: format: decimal type: number extendedUnitListPriceDisplay: type: string unitRegularPrice: format: decimal type: number unitRegularPriceDisplay: type: string extendedUnitRegularPrice: format: decimal type: number extendedUnitRegularPriceDisplay: type: string unitNetPrice: format: decimal type: number unitNetPriceDisplay: type: string extendedUnitNetPrice: format: decimal type: number extendedUnitNetPriceDisplay: type: string unitOfMeasure: type: string vatRate: format: decimal type: number vatAmount: format: decimal type: number vatAmountDisplay: type: string unitListBreakPrices: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Pricing.BreakPriceDto' unitRegularBreakPrices: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Pricing.BreakPriceDto' regularPrice: format: decimal type: number readOnly: true regularPriceDisplay: type: string readOnly: true extendedRegularPrice: format: decimal type: number readOnly: true extendedRegularPriceDisplay: type: string readOnly: true actualPrice: format: decimal type: number readOnly: true actualPriceDisplay: type: string readOnly: true extendedActualPrice: format: decimal type: number readOnly: true extendedActualPriceDisplay: type: string readOnly: true regularBreakPrices: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Pricing.BreakPriceDto' readOnly: true actualBreakPrices: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Pricing.BreakPriceDto' readOnly: true properties: type: object additionalProperties: type: string Insite.Catalog.WebApi.V1.ApiModels.CrossSellCollectionModel: type: object properties: uri: type: string products: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' properties: type: object additionalProperties: type: string Insite.Catalog.Services.Dtos.LegacyConfigurationDto: type: object properties: sections: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ConfigSectionDto' hasDefaults: type: boolean isKit: type: boolean Insite.Core.Plugins.Search.Dtos.AttributeValueFacetDto: type: object properties: attributeValueId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 value: type: string valueDisplay: type: string count: format: int32 type: integer sortOrder: format: int32 type: integer selected: type: boolean styleParentId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 styleChildId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 Insite.Catalog.Services.Dtos.DocumentDto: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string description: type: string createdOn: format: date-time type: string filePath: type: string fileUrl: type: string documentType: type: string languageId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 fileTypeString: type: string Insite.Core.Plugins.Pricing.ProductPriceDto: type: object properties: productId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 isOnSale: type: boolean requiresRealTimePrice: type: boolean additionalResults: type: object additionalProperties: type: string unitCost: format: decimal type: number unitCostDisplay: type: string unitListPrice: format: decimal type: number unitListPriceDisplay: type: string extendedUnitListPrice: format: decimal type: number extendedUnitListPriceDisplay: type: string unitRegularPrice: format: decimal type: number unitRegularPriceDisplay: type: string extendedUnitRegularPrice: format: decimal type: number extendedUnitRegularPriceDisplay: type: string unitNetPrice: format: decimal type: number unitNetPriceDisplay: type: string extendedUnitNetPrice: format: decimal type: number extendedUnitNetPriceDisplay: type: string unitOfMeasure: type: string vatRate: format: decimal type: number vatAmount: format: decimal type: number vatAmountDisplay: type: string unitListBreakPrices: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Pricing.BreakPriceDto' unitRegularBreakPrices: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Pricing.BreakPriceDto' regularPrice: format: decimal type: number readOnly: true regularPriceDisplay: type: string readOnly: true extendedRegularPrice: format: decimal type: number readOnly: true extendedRegularPriceDisplay: type: string readOnly: true actualPrice: format: decimal type: number readOnly: true actualPriceDisplay: type: string readOnly: true extendedActualPrice: format: decimal type: number readOnly: true extendedActualPriceDisplay: type: string readOnly: true regularBreakPrices: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Pricing.BreakPriceDto' readOnly: true actualBreakPrices: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Pricing.BreakPriceDto' readOnly: true unitListPriceWithVat: format: decimal type: number unitListPriceWithVatDisplay: type: string extendedUnitListPriceWithVat: format: decimal type: number extendedUnitListPriceWithVatDisplay: type: string unitRegularPriceWithVat: format: decimal type: number unitRegularPriceWithVatDisplay: type: string extendedUnitRegularPriceWithVat: format: decimal type: number extendedUnitRegularPriceWithVatDisplay: type: string vatMinusExtendedUnitRegularPrice: format: decimal type: number Insite.Catalog.Services.Dtos.StyledProductDto: type: object properties: productId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string shortDescription: type: string erpNumber: type: string customerName: type: string mediumImagePath: type: string smallImagePath: type: string largeImagePath: type: string qtyOnHand: format: decimal type: number unitOfMeasure: type: string trackInventory: type: boolean minimumOrderQty: format: int32 type: integer productDetailUrl: type: string pricing: $ref: '#/components/schemas/Insite.Core.Plugins.Pricing.ProductPriceDto' quoteRequired: type: boolean styleValues: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.StyleValueDto' availability: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.AvailabilityDto' productUnitOfMeasures: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductUnitOfMeasureDto' productImages: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductImageDto' warehouses: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.WarehouseDto' manufacturerItem: type: string upcCode: type: string sku: type: string cantBuy: type: boolean allowZeroPricing: type: boolean htmlContent: type: string specifications: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.SpecificationDto' documents: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.DocumentDto' attributeTypes: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.AttributeTypeDto' crossSells: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' relatedProducts: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.RelatedProductDto' metaDescription: type: string metaKeywords: type: string pageTitle: type: string openGraphTitle: type: string openGraphUrl: type: string openGraphImage: type: string customerProductNumber: type: string Insite.Core.Plugins.Search.Dtos.AttributeTypeFacetDto: type: object properties: attributeTypeId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string nameDisplay: type: string sort: format: int32 type: integer attributeValueFacets: type: array items: $ref: '#/components/schemas/Insite.Core.Plugins.Search.Dtos.AttributeValueFacetDto' Insite.Catalog.Services.Dtos.AttributeTypeDto: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string label: type: string isFilter: type: boolean isComparable: type: boolean isSearchable: type: boolean includeOnProduct: type: boolean isActive: type: boolean sortOrder: format: int32 type: integer attributeValues: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.AttributeValueDto' Insite.Catalog.Services.Dtos.StyleValueDto: type: object properties: styleTraitName: type: string styleTraitId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 styleTraitValueId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 value: type: string valueDisplay: type: string sortOrder: format: int32 type: integer isDefault: type: boolean swatchType: type: string swatchImageValue: type: string swatchColorValue: type: string Insite.Catalog.Services.Dtos.WarehouseDto: type: object properties: messageType: format: int32 enum: - 0 - 1 - 2 - 3 type: integer message: type: string requiresRealTimeInventory: type: boolean name: type: string description: type: string qty: format: decimal type: number properties: type: object additionalProperties: type: string Insite.Catalog.Services.Dtos.AvailabilityDto: type: object properties: messageType: format: int32 enum: - 0 - 1 - 2 - 3 type: integer message: type: string requiresRealTimeInventory: type: boolean Insite.Core.Plugins.Pricing.BreakPriceDto: type: object properties: breakQty: format: decimal type: number breakPrice: format: decimal type: number breakPriceDisplay: type: string savingsMessage: type: string breakPriceWithVat: format: decimal type: number breakPriceWithVatDisplay: type: string Insite.Catalog.Services.Dtos.ProductDto: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 orderLineId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string customerName: type: string shortDescription: type: string erpNumber: type: string erpDescription: type: string urlSegment: type: string basicListPrice: format: decimal type: number basicSalePrice: format: decimal type: number basicSaleStartDate: format: date-time type: string basicSaleEndDate: format: date-time type: string smallImagePath: type: string mediumImagePath: type: string largeImagePath: type: string pricing: $ref: '#/components/schemas/Insite.Core.Plugins.Pricing.ProductPriceDto' currencySymbol: type: string qtyOnHand: format: decimal type: number isConfigured: type: boolean isFixedConfiguration: type: boolean isActive: type: boolean isHazardousGood: type: boolean isDiscontinued: type: boolean isSpecialOrder: type: boolean isGiftCard: type: boolean isBeingCompared: type: boolean isSponsored: type: boolean isSubscription: type: boolean quoteRequired: type: boolean manufacturerItem: type: string packDescription: type: string altText: type: string customerUnitOfMeasure: type: string canBackOrder: type: boolean trackInventory: type: boolean multipleSaleQty: format: int32 type: integer minimumOrderQty: format: int32 type: integer htmlContent: type: string productCode: type: string priceCode: type: string sku: type: string upcCode: type: string modelNumber: type: string taxCode1: type: string taxCode2: type: string taxCategory: type: string shippingClassification: type: string shippingLength: type: string shippingWidth: type: string shippingHeight: type: string shippingWeight: type: string qtyPerShippingPackage: format: decimal type: number shippingAmountOverride: format: double type: number handlingAmountOverride: format: double type: number metaDescription: type: string metaKeywords: type: string pageTitle: type: string allowAnyGiftCardAmount: type: boolean sortOrder: format: int32 type: integer hasMsds: type: boolean unspsc: type: string roundingRule: type: string vendorNumber: type: string configurationDto: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.LegacyConfigurationDto' unitOfMeasure: type: string unitOfMeasureDisplay: type: string unitOfMeasureDescription: type: string selectedUnitOfMeasure: type: string selectedUnitOfMeasureDisplay: type: string productDetailUrl: type: string canAddToCart: type: boolean allowedAddToCart: type: boolean canAddToWishlist: type: boolean canViewDetails: type: boolean canShowPrice: type: boolean canShowUnitOfMeasure: type: boolean canEnterQuantity: type: boolean canConfigure: type: boolean isStyleProductParent: type: boolean styleParentId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 requiresRealTimeInventory: type: boolean numberInCart: format: decimal type: number qtyOrdered: format: decimal type: number availability: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.AvailabilityDto' styleTraits: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.StyleTraitDto' styledProducts: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.StyledProductDto' attributeTypes: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.AttributeTypeDto' documents: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.DocumentDto' specifications: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.SpecificationDto' crossSells: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' accessories: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' productUnitOfMeasures: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductUnitOfMeasureDto' productImages: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductImageDto' properties: type: object additionalProperties: type: string score: format: double type: number scoreExplanation: $ref: '#/components/schemas/Insite.Core.Plugins.Search.Dtos.ScoreExplanationDto' searchBoost: format: int32 type: integer searchBoostDecimal: format: decimal type: number salePriceLabel: type: string cantBuy: type: boolean allowZeroPricing: type: boolean brand: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.BrandDto' productLine: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductLineDto' productSubscription: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductSubscriptionDto' replacementProductId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 warehouses: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.WarehouseDto' relatedProducts: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.RelatedProductDto' alsoPurchasedProducts: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' openGraphTitle: type: string openGraphUrl: type: string openGraphImage: type: string badges: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.BadgeDto' replacementProduct: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.ProductDto' parentProductErpNumber: type: string Insite.Catalog.Services.Dtos.AttributeValueDto: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 value: type: string valueDisplay: type: string sortOrder: format: int32 type: integer isActive: type: boolean Insite.Catalog.Services.Dtos.ProductImageDto: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 sortOrder: format: int32 type: integer name: type: string imageType: type: string smallImagePath: type: string mediumImagePath: type: string largeImagePath: type: string altText: type: string Insite.Catalog.Services.Dtos.ProductLineDto: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string Insite.Core.Plugins.Search.Dtos.FieldScoreDto: type: object properties: name: type: string score: format: float type: number Insite.Core.Plugins.Search.Dtos.SuggestionDto: type: object properties: highlightedSuggestion: type: string score: format: double type: number suggestion: type: string Insite.Core.Plugins.Search.Dtos.PriceFacetDto: type: object properties: minimumPrice: format: int32 type: integer maximumPrice: format: int32 type: integer count: format: int32 type: integer selected: type: boolean Insite.Catalog.Services.Dtos.SpecificationDto: type: object properties: specificationId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string nameDisplay: type: string value: type: string description: type: string sortOrder: format: decimal type: number isActive: type: boolean parentSpecification: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.SpecificationDto' htmlContent: type: string specifications: type: array items: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.SpecificationDto' Insite.Catalog.Services.Dtos.ProductUnitOfMeasureDto: type: object properties: productUnitOfMeasureId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 unitOfMeasure: type: string unitOfMeasureDisplay: type: string description: type: string qtyPerBaseUnitOfMeasure: format: decimal type: number roundingRule: type: string isDefault: type: boolean availability: $ref: '#/components/schemas/Insite.Catalog.Services.Dtos.AvailabilityDto' Insite.Catalog.WebApi.V2.ApiModels.Product.FieldScoreModel: type: object properties: name: type: string score: format: float type: number Insite.Catalog.WebApi.V2.ApiModels.Product.TraitValueModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 value: type: string valueDisplay: type: string sortOrder: format: int32 type: integer isDefault: type: boolean swatchType: type: string swatchImageValue: type: string swatchColorValue: type: string Insite.Catalog.WebApi.V2.ApiModels.Product.ProductLineModel: type: object properties: uri: type: string id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string properties: type: object additionalProperties: type: string Insite.Catalog.WebApi.V2.ApiModels.Product.FacetModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string count: format: int32 type: integer selected: type: boolean sortOrder: format: int32 type: integer Insite.Catalog.WebApi.V2.ApiModels.Product.ConfigurationModel: type: object properties: configSections: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ConfigSectionModel' hasDefaults: type: boolean isKit: type: boolean Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeTypeModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string label: type: string isFilter: type: boolean isComparable: type: boolean isSearchable: type: boolean includeOnProduct: type: boolean sortOrder: format: int32 type: integer attributeValues: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeValueModel' Insite.Catalog.WebApi.V2.ApiModels.Product.SectionOptionModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 productId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string description: type: string price: format: decimal type: number selected: type: boolean sortOrder: format: int32 type: integer quantity: format: decimal type: number cantBuy: type: boolean Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeValueModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 value: type: string valueDisplay: type: string sortOrder: format: int32 type: integer Insite.Catalog.WebApi.V2.ApiModels.Product.ContentModel: type: object properties: htmlContent: type: string pageTitle: type: string metaDescription: type: string metaKeywords: type: string openGraphTitle: type: string openGraphUrl: type: string openGraphImage: type: string Insite.Catalog.WebApi.V2.ApiModels.Product.DocumentModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string description: type: string filePath: type: string documentType: type: string Insite.Catalog.WebApi.V2.ApiModels.Product.BrandModel: type: object properties: uri: type: string id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string urlSegment: type: string logoSmallImagePath: type: string logoLargeImagePath: type: string logoImageAltText: type: string detailPagePath: type: string properties: type: object additionalProperties: type: string Insite.Catalog.WebApi.V2.ApiModels.Product.ConfigSectionModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 sectionName: type: string label: type: string sortOrder: format: int32 type: integer sectionOptions: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.SectionOptionModel' Insite.Catalog.WebApi.V2.ApiModels.Product.PriceFacetModel: type: object properties: minimumPrice: format: int32 type: integer maximumPrice: format: int32 type: integer count: format: int32 type: integer selected: type: boolean Insite.Catalog.WebApi.V2.ApiModels.Product.DetailModel: type: object properties: name: type: string modelNumber: type: string sku: type: string upcCode: type: string unspsc: type: string productCode: type: string priceCode: type: string sortOrder: format: int32 type: integer multipleSaleQty: format: int32 type: integer canBackOrder: type: boolean roundingRule: type: string replacementProductId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 isHazardousGood: type: boolean hasMsds: type: boolean isSpecialOrder: type: boolean isGiftCard: type: boolean isSubscription: type: boolean subscription: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductSubscriptionModel' allowAnyGiftCardAmount: type: boolean taxCode1: type: string taxCode2: type: string taxCategory: type: string vatCodeId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 shippingClassification: type: string shippingLength: format: decimal type: number shippingWidth: format: decimal type: number shippingHeight: format: decimal type: number shippingWeight: format: decimal type: number configuration: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ConfigurationModel' Insite.Catalog.WebApi.V2.ApiModels.Product.ProductSubscriptionModel: type: object properties: uri: type: string subscriptionCyclePeriod: type: string subscriptionPeriodsPerCycle: format: int32 type: integer subscriptionTotalCycles: format: int32 type: integer subscriptionAllMonths: type: boolean subscriptionJanuary: type: boolean subscriptionFebruary: type: boolean subscriptionMarch: type: boolean subscriptionApril: type: boolean subscriptionMay: type: boolean subscriptionJune: type: boolean subscriptionJuly: type: boolean subscriptionAugust: type: boolean subscriptionSeptember: type: boolean subscriptionOctober: type: boolean subscriptionNovember: type: boolean subscriptionDecember: type: boolean subscriptionAddToInitialOrder: type: boolean subscriptionFixedPrice: type: boolean subscriptionShipViaId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 properties: type: object additionalProperties: type: string Insite.Catalog.WebApi.V2.ApiModels.Product.BadgeModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string tagName: type: string badgeStyle: type: string sortOrder: format: int32 type: integer badgeType: type: string displayOnProductImages: type: boolean displayOnBadgeWidget: type: boolean displayText: type: string textColorHexCode: type: string badgeColorHexCode: type: string largeImageBadgePath: type: string largeImageTextSize: type: string largeImagePlacement: type: string otherImageBadgePath: type: string otherImageTextSize: type: string otherImagePlacement: type: string imageAltText: type: string detailWidgetBadgeSize: type: string Insite.Catalog.WebApi.V2.ApiModels.Product.ImageModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 sortOrder: format: int32 type: integer name: type: string imageType: type: string smallImagePath: type: string mediumImagePath: type: string largeImagePath: type: string imageAltText: type: string Insite.Catalog.WebApi.V2.ApiModels.Product.ScoreExplanationModel: type: object properties: totalBoost: format: float type: number aggregateFieldScores: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.FieldScoreModel' detailedFieldScores: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.FieldScoreDetailedModel' Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel: type: object properties: uri: type: string id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 productNumber: type: string customerProductNumber: type: string customerUnitOfMeasure: type: string productTitle: type: string urlSegment: type: string canonicalUrl: type: string displayUrl: type: string manufacturerItem: type: string packDescription: type: string unitListPrice: format: decimal type: number unitListPriceDisplay: type: string priceFacet: format: int32 type: integer smallImagePath: type: string mediumImagePath: type: string largeImagePath: type: string imageAltText: type: string isDiscontinued: type: boolean quoteRequired: type: boolean minimumOrderQty: format: int32 type: integer isSponsored: type: boolean trackInventory: type: boolean configurationType: type: string canConfigure: type: boolean canAddToCart: type: boolean canAddToWishlist: type: boolean canShowPrice: type: boolean canShowUnitOfMeasure: type: boolean isVariantParent: type: boolean variantTypeId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 defaultChildProductId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 salePriceLabel: type: string cantBuy: type: boolean allowZeroPricing: type: boolean brand: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.BrandModel' productLine: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductLineModel' unitOfMeasures: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.UnitOfMeasureModel' score: format: double type: number scoreExplanation: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ScoreExplanationModel' detail: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.DetailModel' content: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ContentModel' images: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ImageModel' badges: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.BadgeModel' documents: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.DocumentModel' specifications: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.SpecificationModel' warehouses: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.WarehouseModel' attributeTypes: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeTypeModel' variantTraits: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.VariantTraitModel' childTraitValues: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ChildTraitValueModel' properties: type: object additionalProperties: type: string Insite.Catalog.WebApi.V2.ApiModels.Product.FieldScoreDetailedModel: type: object properties: name: type: string score: format: float type: number boost: format: float type: number matchText: type: string termFrequencyNormalized: format: float type: number inverseDocumentFrequency: format: float type: number scoreUsed: type: boolean Insite.Catalog.WebApi.V2.ApiModels.Product.ChildTraitValueModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 styleTraitId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 value: type: string valueDisplay: type: string Insite.Catalog.WebApi.V2.ApiModels.Product.UnitOfMeasureModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 unitOfMeasure: type: string unitOfMeasureDisplay: type: string description: type: string qtyPerBaseUnitOfMeasure: format: decimal type: number roundingRule: type: string isDefault: type: boolean Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeValueFacetModel: type: object properties: attributeValueId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 value: type: string valueDisplay: type: string count: format: int32 type: integer sortOrder: format: int32 type: integer selected: type: boolean Insite.Catalog.WebApi.V2.ApiModels.Product.SuggestionModel: type: object properties: highlightedSuggestion: type: string suggestion: type: string score: format: double type: number Insite.Catalog.WebApi.V2.ApiModels.Product.WarehouseModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string description: type: string qtyAvailable: format: decimal type: number Insite.Catalog.WebApi.V2.ApiModels.Product.SpecificationModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string nameDisplay: type: string description: type: string value: type: string htmlContent: type: string sortOrder: format: decimal type: number Insite.Catalog.WebApi.V2.ApiModels.Product.PriceRangeModel: type: object properties: minimumPrice: format: decimal type: number maximumPrice: format: decimal type: number count: format: int32 type: integer priceFacets: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.PriceFacetModel' Insite.Catalog.WebApi.V2.ApiModels.Product.VariantTraitModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string nameDisplay: type: string unselectedValue: type: string displayType: type: string numberOfSwatchesVisible: format: int32 type: integer displayTextWithSwatch: type: boolean sortOrder: format: int32 type: integer traitValues: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.TraitValueModel' Insite.Catalog.WebApi.V2.ApiModels.Product.ProductCollectionModel: type: object properties: uri: type: string products: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel' pagination: $ref: '#/components/schemas/Insite.Core.WebApi.PaginationModel' categoryFacets: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.CategoryFacetModel' attributeTypeFacets: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeTypeFacetModel' brandFacets: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.FacetModel' productLineFacets: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.FacetModel' didYouMeanSuggestions: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.SuggestionModel' priceRange: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.PriceRangeModel' exactMatch: type: boolean notAllProductsFound: type: boolean notAllProductsAllowed: type: boolean originalQuery: type: string correctedQuery: type: string searchTermRedirectUrl: type: string attributionToken: type: string properties: type: object additionalProperties: type: string Insite.Catalog.WebApi.V2.ApiModels.Product.CategoryFacetModel: type: object properties: categoryId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 shortDescription: type: string count: format: int32 type: integer selected: type: boolean subCategoryFacets: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.CategoryFacetModel' Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeTypeFacetModel: type: object properties: attributeTypeId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string nameDisplay: type: string sortOrder: format: int32 type: integer attributeValueFacets: type: array items: $ref: '#/components/schemas/Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeValueFacetModel' 403Response: type: object properties: message: type: string 40xResponse: type: object properties: title: type: string status: type: integer format: int32 timestamp: type: string detail: type: object properties: invalids: type: array items: type: object properties: event: type: integer message: type: string GenericUpdateResponse: type: object properties: title: type: string status: type: integer format: int32 timestamp: type: string Product: required: - product_id type: object properties: product_id: type: string description: the product_id associated with the product '{product_field}': type: object description: Any other product field. Refer to the product reference above for the full list of available fields. additionalProperties: type: string description: Any other product field. Refer to the product reference above for the full list of available fields. securitySchemes: access_token: type: apiKey description: Token used to access storefront API. name: access_token in: query x-api-key: type: apiKey name: x-api-key in: header x-refined-from: - optimizely-configured-commerce-admin-api-v1-openapi.json - optimizely-configured-commerce-storefront-api-v1-openapi.json - optimizely-configured-commerce-storefront-api-v2-openapi.json - optimizely-data-platform-products-openapi.json