API reference
Error
A valid request URL is required to generate request examples{
"items": [
{
"applicableDiscounts": [
{
"amountType": "<string>",
"scope": "<string>",
"target": {
"type": "<string>",
"appliesToLeastExpensiveProductsFirst": true,
"categories": [
{
"id": 123
}
],
"doNotApplyToHandlingFees": true,
"excludeItemsWithExistingProductDiscounts": true,
"excludeItemsWithExistingShippingDiscounts": true,
"excludedCategories": [
{
"id": 123
}
],
"excludedCategoriesOperator": "<string>",
"excludedProducts": [
{
"productCode": "<string>"
}
],
"includeAllProducts": true,
"includedCategoriesOperator": "<string>",
"maximumQuantityPerRedemption": 123,
"products": [
{
"productCode": "<string>"
}
],
"shippingMethods": [
{
"code": "<string>",
"name": "<string>"
}
],
"shippingZones": [
{
"zone": "<string>"
}
]
},
"amount": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"canBeDeleted": true,
"canBeStackedUpon": true,
"code": "<string>",
"conditions": {
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 123
}
],
"continuityRecurrenceSettings": {
"interval": 123,
"startOrdinal": 123,
"stopOrdinal": 123
},
"couponCode": "<string>",
"customerSegments": [
{
"id": 123
}
],
"excludedCategories": [
{
"categoryId": 123
}
],
"excludedProducts": [
{
"productCode": "<string>"
}
],
"exclusiveLocationCodes": [
"<string>"
],
"exclusiveSiteIds": [
123
],
"expirationDate": "2023-11-07T05:31:56Z",
"expression": {
"text": "<string>",
"tree": {
"left": "<string>",
"logicalOperator": "<string>",
"nodes": "<array>",
"operator": "<string>",
"right": "<unknown>",
"type": "<string>"
}
},
"includedCategories": [
{
"categoryId": 123
}
],
"includedPaymentWorkflows": [
"<string>"
],
"includedProducts": [
{
"productCode": "<string>"
}
],
"maxRedemptionCount": 123,
"maximumOrderAmount": 123,
"minDistinctProductsRequired": 123,
"minTotalOrderQuantity": 123,
"minimumCategorySubtotalBeforeDiscounts": 123,
"minimumLifetimeValueAmount": 123,
"minimumOrderAmount": 123,
"minimumQuantityProductsRequiredInCategories": 123,
"minimumQuantityRequiredProducts": 123,
"minimumRequiredQuantityPerRedemption": 123,
"pricingContext": "<string>",
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "<string>"
}
],
"requiresAuthenticatedUser": true,
"requiresCoupon": true,
"startDate": "2023-11-07T05:31:56Z",
"validFulfillmentMethods": [
"<string>"
],
"validSubscriptionContinuityOrdinals": [
123
],
"validSubscriptionFrequencies": [
"<string>"
]
},
"content": {
"name": "<string>",
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"customPropertyValues": {
"value1": "<string>",
"value10": "<string>",
"value2": "<string>",
"value3": "<string>",
"value4": "<string>",
"value5": "<string>",
"value6": "<string>",
"value7": "<string>",
"value8": "<string>",
"value9": "<string>"
},
"friendlyDescription": "<string>",
"localeCode": "<string>"
},
"currentRedemptionCount": 123,
"doesNotApplyToMultiShipToOrders": true,
"doesNotApplyToProductsWithSalePrice": true,
"doesNotApplyToSalePrice": true,
"hasPurchaseConditions": true,
"id": 123,
"includedPriceLists": [
"<string>"
],
"isBxGx": true,
"isDisabled": true,
"isPublic": true,
"isSubscriptionDiscount": true,
"labels": [
"<string>"
],
"localizedContent": [
{
"name": "<string>",
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"customPropertyValues": {
"value1": "<string>",
"value10": "<string>",
"value2": "<string>",
"value3": "<string>",
"value4": "<string>",
"value5": "<string>",
"value6": "<string>",
"value7": "<string>",
"value8": "<string>",
"value9": "<string>"
},
"friendlyDescription": "<string>",
"localeCode": "<string>"
}
],
"maximumDiscountImpactPerOrder": 123,
"maximumDiscountImpactPerRedemption": 123,
"maximumRedemptionsPerOrder": 123,
"maximumUsesPerUser": 123,
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"purchaseRequirementType": "<string>",
"stackingLayer": 123,
"status": "<string>",
"tagCodes": [
"<string>"
],
"thresholdMessage": {
"discountId": 123,
"thresholdValue": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"content": {
"messageTemplate": "<string>",
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"localeCode": "<string>"
},
"isActive": true,
"localizedContent": [
{
"messageTemplate": "<string>",
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"localeCode": "<string>"
}
],
"requiresCouponCode": true,
"showInCart": true,
"showOnCheckout": true
}
}
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"baseProductCode": "<string>",
"bundledProducts": [
{
"fulfillmentTypesSupported": [
"<string>"
],
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
},
"price": {
"creditValue": 123,
"isoCurrencyCode": "<string>",
"map": 123,
"mapEndDate": "2023-11-07T05:31:56Z",
"mapStartDate": "2023-11-07T05:31:56Z",
"msrp": 123,
"price": 123,
"salePrice": 123
},
"productCode": "<string>",
"productName": "<string>",
"quantity": 123
}
],
"content": {
"localeCode": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"id": 123,
"imageLabel": "<string>",
"imageUrl": "<string>",
"localeCode": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>"
},
"extras": [
{
"attributeFQN": "<string>",
"isMultiSelect": true,
"isRequired": true,
"values": [
{
"attributeVocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<unknown>",
"valueSequence": 123
},
"deltaPrice": {
"currencyCode": "<string>",
"deltaPrice": 123
},
"deltaWeight": 123,
"isDefaulted": true,
"localizedDeltaPrice": [
{
"currencyCode": "<string>",
"deltaPrice": 123
}
],
"quantity": 123,
"value": null
}
]
}
],
"fulfillmentTypesSupported": [
"<string>"
],
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "<string>"
},
"isPackagedStandAlone": true,
"isRecurring": true,
"isTaxable": true,
"isValidForProductType": true,
"isVariation": true,
"masterCatalogId": 123,
"options": [
{
"attributeFQN": "<string>",
"isProductImageGroupSelector": true,
"values": [
{
"attributeVocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<unknown>",
"valueSequence": 123
},
"value": null
}
]
}
],
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
},
"price": {
"creditValue": 123,
"isoCurrencyCode": "<string>",
"map": 123,
"mapEndDate": "2023-11-07T05:31:56Z",
"mapStartDate": "2023-11-07T05:31:56Z",
"msrp": 123,
"price": 123,
"salePrice": 123
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
"discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
"variationPricingMethod": "<string>"
},
"primaryProductCollectionCode": "<string>",
"productCode": "<string>",
"productCollectionProducts": [
{
"content": {
"localeCode": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"id": 123,
"imageLabel": "<string>",
"imageUrl": "<string>",
"localeCode": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>"
},
"memberKey": {
"value": "<string>"
},
"price": {
"creditValue": 123,
"isoCurrencyCode": "<string>",
"map": 123,
"mapEndDate": "2023-11-07T05:31:56Z",
"mapStartDate": "2023-11-07T05:31:56Z",
"msrp": 123,
"price": 123,
"salePrice": 123
},
"productUsage": "<string>"
}
],
"productCollections": [
{
"collectionName": "<string>",
"collectionProductCode": "<string>",
"isPrimaryCollection": true
}
],
"productImageGroups": [
{
"productImageGroupId": "<string>",
"productImageGroupTags": [
{
"fqn": "<string>",
"values": [
"<string>"
]
}
]
}
],
"productInCatalogs": [
{
"activeDateRange": {
"endDate": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z"
},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"catalogId": 123,
"content": {
"localeCode": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"id": 123,
"imageLabel": "<string>",
"imageUrl": "<string>",
"localeCode": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>"
},
"dateFirstAvailableInCatalog": "2023-11-07T05:31:56Z",
"isActive": true,
"isContentOverridden": true,
"isPriceOverridden": true,
"isSEOContentOverridden": true,
"price": {
"creditValue": 123,
"isoCurrencyCode": "<string>",
"map": 123,
"mapEndDate": "2023-11-07T05:31:56Z",
"mapStartDate": "2023-11-07T05:31:56Z",
"msrp": 123,
"price": 123,
"salePrice": 123
},
"primaryProductCategory": {
"categoryId": 123
},
"productCategories": [
{
"categoryId": 123
}
],
"seoContent": {
"localeCode": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"seoFriendlyUrl": "<string>",
"titleTagTitle": "<string>"
}
}
],
"productSequence": 123,
"productTypeId": 123,
"productUsage": "<string>",
"properties": [
{
"attributeFQN": "<string>",
"forceOrder": true,
"values": [
{
"attributeVocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<unknown>",
"valueSequence": 123
},
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"value": null
}
]
}
],
"publishingInfo": {
"lastPublishedBy": "<string>",
"lastPublishedDate": "2023-11-07T05:31:56Z",
"publishSetCode": "<string>",
"publishedState": "<string>"
},
"seoContent": {
"localeCode": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"seoFriendlyUrl": "<string>",
"titleTagTitle": "<string>"
},
"shippingClassId": 123,
"slicingSettings": {
"slicingAttributeFqn": "<string>"
},
"standAlonePackageType": "<string>",
"supplierInfo": {
"cost": {
"cost": 123,
"isoCurrencyCode": "<string>"
},
"distPartNumber": "<string>",
"mfgPartNumber": "<string>"
},
"upc": "<string>",
"variationKey": "<string>",
"variationOptions": [
{
"attributeFQN": "<string>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"value": "<unknown>"
}
]
}
],
"pageCount": 123,
"pageSize": 123,
"startIndex": 123,
"totalCount": 123
}Get Products
Retrieves a list of products according to any specified filter criteria and sort options. This is the legacy version of the Products API, which allows you to access product data that hasn’t yet been rewritten to the newer API model with localizedContent. If possible, Kibo recommends calling the /products endpoint with an x-api-version header set to “1” instead of using this V1 endpoint (as it may be deprecated at some point). This is only necessary if you upgraded your implementation to use the new API version by default to support multi-locale catalogs.
GET
/
commerce
/
catalog
/
admin
/
productsV1
Error
A valid request URL is required to generate request examples{
"items": [
{
"applicableDiscounts": [
{
"amountType": "<string>",
"scope": "<string>",
"target": {
"type": "<string>",
"appliesToLeastExpensiveProductsFirst": true,
"categories": [
{
"id": 123
}
],
"doNotApplyToHandlingFees": true,
"excludeItemsWithExistingProductDiscounts": true,
"excludeItemsWithExistingShippingDiscounts": true,
"excludedCategories": [
{
"id": 123
}
],
"excludedCategoriesOperator": "<string>",
"excludedProducts": [
{
"productCode": "<string>"
}
],
"includeAllProducts": true,
"includedCategoriesOperator": "<string>",
"maximumQuantityPerRedemption": 123,
"products": [
{
"productCode": "<string>"
}
],
"shippingMethods": [
{
"code": "<string>",
"name": "<string>"
}
],
"shippingZones": [
{
"zone": "<string>"
}
]
},
"amount": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"canBeDeleted": true,
"canBeStackedUpon": true,
"code": "<string>",
"conditions": {
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 123
}
],
"continuityRecurrenceSettings": {
"interval": 123,
"startOrdinal": 123,
"stopOrdinal": 123
},
"couponCode": "<string>",
"customerSegments": [
{
"id": 123
}
],
"excludedCategories": [
{
"categoryId": 123
}
],
"excludedProducts": [
{
"productCode": "<string>"
}
],
"exclusiveLocationCodes": [
"<string>"
],
"exclusiveSiteIds": [
123
],
"expirationDate": "2023-11-07T05:31:56Z",
"expression": {
"text": "<string>",
"tree": {
"left": "<string>",
"logicalOperator": "<string>",
"nodes": "<array>",
"operator": "<string>",
"right": "<unknown>",
"type": "<string>"
}
},
"includedCategories": [
{
"categoryId": 123
}
],
"includedPaymentWorkflows": [
"<string>"
],
"includedProducts": [
{
"productCode": "<string>"
}
],
"maxRedemptionCount": 123,
"maximumOrderAmount": 123,
"minDistinctProductsRequired": 123,
"minTotalOrderQuantity": 123,
"minimumCategorySubtotalBeforeDiscounts": 123,
"minimumLifetimeValueAmount": 123,
"minimumOrderAmount": 123,
"minimumQuantityProductsRequiredInCategories": 123,
"minimumQuantityRequiredProducts": 123,
"minimumRequiredQuantityPerRedemption": 123,
"pricingContext": "<string>",
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "<string>"
}
],
"requiresAuthenticatedUser": true,
"requiresCoupon": true,
"startDate": "2023-11-07T05:31:56Z",
"validFulfillmentMethods": [
"<string>"
],
"validSubscriptionContinuityOrdinals": [
123
],
"validSubscriptionFrequencies": [
"<string>"
]
},
"content": {
"name": "<string>",
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"customPropertyValues": {
"value1": "<string>",
"value10": "<string>",
"value2": "<string>",
"value3": "<string>",
"value4": "<string>",
"value5": "<string>",
"value6": "<string>",
"value7": "<string>",
"value8": "<string>",
"value9": "<string>"
},
"friendlyDescription": "<string>",
"localeCode": "<string>"
},
"currentRedemptionCount": 123,
"doesNotApplyToMultiShipToOrders": true,
"doesNotApplyToProductsWithSalePrice": true,
"doesNotApplyToSalePrice": true,
"hasPurchaseConditions": true,
"id": 123,
"includedPriceLists": [
"<string>"
],
"isBxGx": true,
"isDisabled": true,
"isPublic": true,
"isSubscriptionDiscount": true,
"labels": [
"<string>"
],
"localizedContent": [
{
"name": "<string>",
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"customPropertyValues": {
"value1": "<string>",
"value10": "<string>",
"value2": "<string>",
"value3": "<string>",
"value4": "<string>",
"value5": "<string>",
"value6": "<string>",
"value7": "<string>",
"value8": "<string>",
"value9": "<string>"
},
"friendlyDescription": "<string>",
"localeCode": "<string>"
}
],
"maximumDiscountImpactPerOrder": 123,
"maximumDiscountImpactPerRedemption": 123,
"maximumRedemptionsPerOrder": 123,
"maximumUsesPerUser": 123,
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"purchaseRequirementType": "<string>",
"stackingLayer": 123,
"status": "<string>",
"tagCodes": [
"<string>"
],
"thresholdMessage": {
"discountId": 123,
"thresholdValue": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"content": {
"messageTemplate": "<string>",
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"localeCode": "<string>"
},
"isActive": true,
"localizedContent": [
{
"messageTemplate": "<string>",
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"localeCode": "<string>"
}
],
"requiresCouponCode": true,
"showInCart": true,
"showOnCheckout": true
}
}
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"baseProductCode": "<string>",
"bundledProducts": [
{
"fulfillmentTypesSupported": [
"<string>"
],
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
},
"price": {
"creditValue": 123,
"isoCurrencyCode": "<string>",
"map": 123,
"mapEndDate": "2023-11-07T05:31:56Z",
"mapStartDate": "2023-11-07T05:31:56Z",
"msrp": 123,
"price": 123,
"salePrice": 123
},
"productCode": "<string>",
"productName": "<string>",
"quantity": 123
}
],
"content": {
"localeCode": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"id": 123,
"imageLabel": "<string>",
"imageUrl": "<string>",
"localeCode": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>"
},
"extras": [
{
"attributeFQN": "<string>",
"isMultiSelect": true,
"isRequired": true,
"values": [
{
"attributeVocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<unknown>",
"valueSequence": 123
},
"deltaPrice": {
"currencyCode": "<string>",
"deltaPrice": 123
},
"deltaWeight": 123,
"isDefaulted": true,
"localizedDeltaPrice": [
{
"currencyCode": "<string>",
"deltaPrice": 123
}
],
"quantity": 123,
"value": null
}
]
}
],
"fulfillmentTypesSupported": [
"<string>"
],
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "<string>"
},
"isPackagedStandAlone": true,
"isRecurring": true,
"isTaxable": true,
"isValidForProductType": true,
"isVariation": true,
"masterCatalogId": 123,
"options": [
{
"attributeFQN": "<string>",
"isProductImageGroupSelector": true,
"values": [
{
"attributeVocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<unknown>",
"valueSequence": 123
},
"value": null
}
]
}
],
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
},
"price": {
"creditValue": 123,
"isoCurrencyCode": "<string>",
"map": 123,
"mapEndDate": "2023-11-07T05:31:56Z",
"mapStartDate": "2023-11-07T05:31:56Z",
"msrp": 123,
"price": 123,
"salePrice": 123
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
"discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
"variationPricingMethod": "<string>"
},
"primaryProductCollectionCode": "<string>",
"productCode": "<string>",
"productCollectionProducts": [
{
"content": {
"localeCode": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"id": 123,
"imageLabel": "<string>",
"imageUrl": "<string>",
"localeCode": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>"
},
"memberKey": {
"value": "<string>"
},
"price": {
"creditValue": 123,
"isoCurrencyCode": "<string>",
"map": 123,
"mapEndDate": "2023-11-07T05:31:56Z",
"mapStartDate": "2023-11-07T05:31:56Z",
"msrp": 123,
"price": 123,
"salePrice": 123
},
"productUsage": "<string>"
}
],
"productCollections": [
{
"collectionName": "<string>",
"collectionProductCode": "<string>",
"isPrimaryCollection": true
}
],
"productImageGroups": [
{
"productImageGroupId": "<string>",
"productImageGroupTags": [
{
"fqn": "<string>",
"values": [
"<string>"
]
}
]
}
],
"productInCatalogs": [
{
"activeDateRange": {
"endDate": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z"
},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"catalogId": 123,
"content": {
"localeCode": "<string>",
"productFullDescription": "<string>",
"productImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"id": 123,
"imageLabel": "<string>",
"imageUrl": "<string>",
"localeCode": "<string>",
"mediaType": "<string>",
"productImageGroupId": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"productName": "<string>",
"productShortDescription": "<string>"
},
"dateFirstAvailableInCatalog": "2023-11-07T05:31:56Z",
"isActive": true,
"isContentOverridden": true,
"isPriceOverridden": true,
"isSEOContentOverridden": true,
"price": {
"creditValue": 123,
"isoCurrencyCode": "<string>",
"map": 123,
"mapEndDate": "2023-11-07T05:31:56Z",
"mapStartDate": "2023-11-07T05:31:56Z",
"msrp": 123,
"price": 123,
"salePrice": 123
},
"primaryProductCategory": {
"categoryId": 123
},
"productCategories": [
{
"categoryId": 123
}
],
"seoContent": {
"localeCode": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"seoFriendlyUrl": "<string>",
"titleTagTitle": "<string>"
}
}
],
"productSequence": 123,
"productTypeId": 123,
"productUsage": "<string>",
"properties": [
{
"attributeFQN": "<string>",
"forceOrder": true,
"values": [
{
"attributeVocabularyValueDetail": {
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"displayOrder": 123,
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"value": "<unknown>",
"valueSequence": 123
},
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"value": null
}
]
}
],
"publishingInfo": {
"lastPublishedBy": "<string>",
"lastPublishedDate": "2023-11-07T05:31:56Z",
"publishSetCode": "<string>",
"publishedState": "<string>"
},
"seoContent": {
"localeCode": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"seoFriendlyUrl": "<string>",
"titleTagTitle": "<string>"
},
"shippingClassId": 123,
"slicingSettings": {
"slicingAttributeFqn": "<string>"
},
"standAlonePackageType": "<string>",
"supplierInfo": {
"cost": {
"cost": 123,
"isoCurrencyCode": "<string>"
},
"distPartNumber": "<string>",
"mfgPartNumber": "<string>"
},
"upc": "<string>",
"variationKey": "<string>",
"variationOptions": [
{
"attributeFQN": "<string>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"value": "<unknown>"
}
]
}
],
"pageCount": 123,
"pageSize": 123,
"startIndex": 123,
"totalCount": 123
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0.
Used to page results from a query. Indicates the maximum number of entities to return from a single query. The default value is 20 and the maximum value is 200.
The element to sort the results by and the order in which the results appear. Either ascending or descending order. For example, to sort the results by “ID” ascending then by “CreateDate” descending, use: id asc,createdate desc.
Used to get more specific information from the request. For example to get discounts applied to a product use the AppliedProducts response group. Available response groups: ApplicableDiscounts, VariationOptions, and BaseProductCode.
A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.
limits which fields are returned in the response body
⌘I