A valid request URL is required to generate request examples{
"productCode": "<string>",
"productUsage": "<string>",
"fulfillmentTypesSupported": [
"<string>"
],
"masterCatalogId": 123,
"productSequence": 123,
"productTypeId": 123,
"isValidForProductType": true,
"baseProductCode": "<string>",
"productInCatalogs": [
{
"catalogId": 123,
"isActive": true,
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "<string>",
"price": 123,
"salePrice": 123,
"msrp": 123,
"map": 123,
"mapStartDate": "2023-11-07T05:31:56Z",
"mapEndDate": "2023-11-07T05:31:56Z",
"creditValue": 123
},
"productCategories": [
{
"categoryId": 123
}
],
"primaryProductCategory": {
"categoryId": 123
},
"dateFirstAvailableInCatalog": "2023-11-07T05:31:56Z",
"activeDateRange": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
},
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}
],
"content": {
"localeCode": "<string>",
"productName": "<string>",
"productFullDescription": "<string>",
"productShortDescription": "<string>",
"productImages": [
{
"id": 123,
"localeCode": "<string>",
"imageLabel": "<string>",
"altText": "<string>",
"imageUrl": "<string>",
"cmsId": "<string>",
"videoUrl": "<string>",
"mediaType": "<string>",
"sequence": 123,
"productImageGroupId": "<string>"
}
]
},
"localizedContent": [
{
"localeCode": "<string>",
"productName": "<string>",
"productFullDescription": "<string>",
"productShortDescription": "<string>",
"productImages": [
{
"id": 123,
"localeCode": "<string>",
"imageLabel": "<string>",
"altText": "<string>",
"imageUrl": "<string>",
"cmsId": "<string>",
"videoUrl": "<string>",
"mediaType": "<string>",
"sequence": 123,
"productImageGroupId": "<string>"
}
]
}
],
"price": {
"isoCurrencyCode": "<string>",
"price": 123,
"salePrice": 123,
"msrp": 123,
"map": 123,
"mapStartDate": "2023-11-07T05:31:56Z",
"mapEndDate": "2023-11-07T05:31:56Z",
"creditValue": 123
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
"discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
"variationPricingMethod": "<string>"
},
"seoContent": {
"localeCode": "<string>",
"metaTagTitle": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"titleTagTitle": "<string>",
"seoFriendlyUrl": "<string>"
},
"localizedSEOContent": [
{
"localeCode": "<string>",
"metaTagTitle": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"titleTagTitle": "<string>",
"seoFriendlyUrl": "<string>"
}
],
"options": [
{
"attributeFQN": "<string>",
"isProductImageGroupSelector": true,
"values": [
{
"value": "<unknown>",
"attributeVocabularyValueDetail": {
"valueSequence": 123,
"value": "<unknown>",
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"displayOrder": 123
}
}
]
}
],
"extras": [
{
"attributeFQN": "<string>",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": "<unknown>",
"deltaPrice": {
"currencyCode": "<string>",
"deltaPrice": 123
},
"localizedDeltaPrice": [
{
"currencyCode": "<string>",
"deltaPrice": 123
}
],
"deltaWeight": 123,
"isDefaulted": true,
"quantity": 123,
"attributeVocabularyValueDetail": {
"valueSequence": 123,
"value": "<unknown>",
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"displayOrder": 123
}
}
]
}
],
"properties": [
{
"attributeFQN": "<string>",
"values": [
{
"value": "<unknown>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 123,
"value": "<unknown>",
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"displayOrder": 123
}
}
],
"forceOrder": true
}
],
"isTaxable": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "<string>"
},
"shippingClassId": 123,
"isRecurring": true,
"upc": "<string>",
"supplierInfo": {
"mfgPartNumber": "<string>",
"distPartNumber": "<string>",
"cost": {
"isoCurrencyCode": "<string>",
"cost": 123
}
},
"isPackagedStandAlone": true,
"standAlonePackageType": "<string>",
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"applicableDiscounts": [
{
"scope": "<string>",
"target": {
"type": "<string>",
"includeAllProducts": true,
"includedCategoriesOperator": "<string>",
"categories": [
{
"id": 123
}
],
"excludedCategoriesOperator": "<string>",
"excludedCategories": [
{
"id": 123
}
],
"products": [
{
"productCode": "<string>"
}
],
"excludedProducts": [
{
"productCode": "<string>"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "<string>",
"name": "<string>"
}
],
"shippingZones": [
{
"zone": "<string>"
}
],
"doNotApplyToHandlingFees": true,
"maximumQuantityPerRedemption": 123,
"appliesToLeastExpensiveProductsFirst": true
},
"amountType": "<string>",
"id": 123,
"content": {
"name": "<string>",
"localeCode": "<string>",
"friendlyDescription": "<string>",
"customPropertyValues": {
"value1": "<string>",
"value2": "<string>",
"value3": "<string>",
"value4": "<string>",
"value5": "<string>",
"value6": "<string>",
"value7": "<string>",
"value8": "<string>",
"value9": "<string>",
"value10": "<string>"
},
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
},
"localizedContent": [
{
"name": "<string>",
"localeCode": "<string>",
"friendlyDescription": "<string>",
"customPropertyValues": {
"value1": "<string>",
"value2": "<string>",
"value3": "<string>",
"value4": "<string>",
"value5": "<string>",
"value6": "<string>",
"value7": "<string>",
"value8": "<string>",
"value9": "<string>",
"value10": "<string>"
},
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}
],
"conditions": {
"maxRedemptionCount": 123,
"requiresCoupon": true,
"couponCode": "<string>",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"<string>"
],
"includedCategories": [
{
"categoryId": 123
}
],
"excludedCategories": [
{
"categoryId": 123
}
],
"includedProducts": [
{
"productCode": "<string>"
}
],
"excludedProducts": [
{
"productCode": "<string>"
}
],
"customerSegments": [
{
"id": 123
}
],
"minimumQuantityRequiredProducts": 123,
"minimumQuantityProductsRequiredInCategories": 123,
"minimumOrderAmount": 123,
"maximumOrderAmount": 123,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 123
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "<string>"
}
],
"minimumLifetimeValueAmount": 123,
"startDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"minimumCategorySubtotalBeforeDiscounts": 123,
"minimumRequiredQuantityPerRedemption": 123,
"validSubscriptionFrequencies": [
"<string>"
],
"validSubscriptionContinuityOrdinals": [
123
],
"minDistinctProductsRequired": 123,
"minTotalOrderQuantity": 123,
"pricingContext": "<string>",
"continuityRecurrenceSettings": {
"startOrdinal": 123,
"interval": 123,
"stopOrdinal": 123
},
"validFulfillmentMethods": [
"<string>"
],
"exclusiveSiteIds": [
123
],
"expression": {
"text": "<string>",
"tree": {
"type": "<string>",
"logicalOperator": "<string>",
"nodes": "<array>",
"left": "<string>",
"operator": "<string>",
"right": "<unknown>"
}
},
"exclusiveLocationCodes": [
"<string>"
]
},
"currentRedemptionCount": 123,
"amount": 123,
"status": "<string>",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"isDisabled": true,
"maximumUsesPerUser": 123,
"maximumDiscountImpactPerOrder": 123,
"maximumDiscountImpactPerRedemption": 123,
"maximumRedemptionsPerOrder": 123,
"includedPriceLists": [
"<string>"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 123,
"thresholdMessage": {
"discountId": 123,
"thresholdValue": 123,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"messageTemplate": "<string>",
"localeCode": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
},
"localizedContent": [
{
"messageTemplate": "<string>",
"localeCode": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"tagCodes": [
"<string>"
],
"isSubscriptionDiscount": true,
"isPublic": true,
"code": "<string>",
"labels": [
"<string>"
]
}
],
"isVariation": true,
"variationKey": "<string>",
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"variationOptions": [
{
"attributeFQN": "<string>",
"value": "<unknown>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
}
}
],
"publishingInfo": {
"publishedState": "<string>",
"lastPublishedBy": "<string>",
"lastPublishedDate": "2023-11-07T05:31:56Z",
"publishSetCode": "<string>"
},
"bundledProducts": [
{
"productCode": "<string>",
"quantity": 123,
"price": {
"isoCurrencyCode": "<string>",
"price": 123,
"salePrice": 123,
"msrp": 123,
"map": 123,
"mapStartDate": "2023-11-07T05:31:56Z",
"mapEndDate": "2023-11-07T05:31:56Z",
"creditValue": 123
},
"productName": "<string>",
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"fulfillmentTypesSupported": [
"<string>"
]
}
],
"productCollectionProducts": [
{
"memberKey": {
"value": "<string>"
},
"productUsage": "<string>",
"content": {
"localeCode": "<string>",
"productName": "<string>",
"productFullDescription": "<string>",
"productShortDescription": "<string>",
"productImages": [
{
"id": 123,
"localeCode": "<string>",
"imageLabel": "<string>",
"altText": "<string>",
"imageUrl": "<string>",
"cmsId": "<string>",
"videoUrl": "<string>",
"mediaType": "<string>",
"sequence": 123,
"productImageGroupId": "<string>"
}
]
},
"price": {
"isoCurrencyCode": "<string>",
"price": 123,
"salePrice": 123,
"msrp": 123,
"map": 123,
"mapStartDate": "2023-11-07T05:31:56Z",
"mapEndDate": "2023-11-07T05:31:56Z",
"creditValue": 123
}
}
],
"productCollections": [
{
"collectionProductCode": "<string>",
"collectionName": "<string>",
"isPrimaryCollection": true
}
],
"productImageGroups": [
{
"productImageGroupId": "<string>",
"productImageGroupTags": [
{
"fqn": "<string>",
"values": [
"<string>"
]
}
]
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"slicingSettings": {
"slicingAttributeFqn": "<string>"
},
"primaryProductCollectionCode": "<string>"
}Creates a new product. This current version of the Products API includes localizedContent to support multi-locale catalogs, which was not present in the previous API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access product data that has not yet been rewritten to the new model by providing an x-api-version header set to “1”.
A valid request URL is required to generate request examples{
"productCode": "<string>",
"productUsage": "<string>",
"fulfillmentTypesSupported": [
"<string>"
],
"masterCatalogId": 123,
"productSequence": 123,
"productTypeId": 123,
"isValidForProductType": true,
"baseProductCode": "<string>",
"productInCatalogs": [
{
"catalogId": 123,
"isActive": true,
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "<string>",
"price": 123,
"salePrice": 123,
"msrp": 123,
"map": 123,
"mapStartDate": "2023-11-07T05:31:56Z",
"mapEndDate": "2023-11-07T05:31:56Z",
"creditValue": 123
},
"productCategories": [
{
"categoryId": 123
}
],
"primaryProductCategory": {
"categoryId": 123
},
"dateFirstAvailableInCatalog": "2023-11-07T05:31:56Z",
"activeDateRange": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
},
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}
],
"content": {
"localeCode": "<string>",
"productName": "<string>",
"productFullDescription": "<string>",
"productShortDescription": "<string>",
"productImages": [
{
"id": 123,
"localeCode": "<string>",
"imageLabel": "<string>",
"altText": "<string>",
"imageUrl": "<string>",
"cmsId": "<string>",
"videoUrl": "<string>",
"mediaType": "<string>",
"sequence": 123,
"productImageGroupId": "<string>"
}
]
},
"localizedContent": [
{
"localeCode": "<string>",
"productName": "<string>",
"productFullDescription": "<string>",
"productShortDescription": "<string>",
"productImages": [
{
"id": 123,
"localeCode": "<string>",
"imageLabel": "<string>",
"altText": "<string>",
"imageUrl": "<string>",
"cmsId": "<string>",
"videoUrl": "<string>",
"mediaType": "<string>",
"sequence": 123,
"productImageGroupId": "<string>"
}
]
}
],
"price": {
"isoCurrencyCode": "<string>",
"price": 123,
"salePrice": 123,
"msrp": 123,
"map": 123,
"mapStartDate": "2023-11-07T05:31:56Z",
"mapEndDate": "2023-11-07T05:31:56Z",
"creditValue": 123
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedStartDate": "2023-11-07T05:31:56Z",
"discountsRestrictedEndDate": "2023-11-07T05:31:56Z",
"variationPricingMethod": "<string>"
},
"seoContent": {
"localeCode": "<string>",
"metaTagTitle": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"titleTagTitle": "<string>",
"seoFriendlyUrl": "<string>"
},
"localizedSEOContent": [
{
"localeCode": "<string>",
"metaTagTitle": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"titleTagTitle": "<string>",
"seoFriendlyUrl": "<string>"
}
],
"options": [
{
"attributeFQN": "<string>",
"isProductImageGroupSelector": true,
"values": [
{
"value": "<unknown>",
"attributeVocabularyValueDetail": {
"valueSequence": 123,
"value": "<unknown>",
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"displayOrder": 123
}
}
]
}
],
"extras": [
{
"attributeFQN": "<string>",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": "<unknown>",
"deltaPrice": {
"currencyCode": "<string>",
"deltaPrice": 123
},
"localizedDeltaPrice": [
{
"currencyCode": "<string>",
"deltaPrice": 123
}
],
"deltaWeight": 123,
"isDefaulted": true,
"quantity": 123,
"attributeVocabularyValueDetail": {
"valueSequence": 123,
"value": "<unknown>",
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"displayOrder": 123
}
}
]
}
],
"properties": [
{
"attributeFQN": "<string>",
"values": [
{
"value": "<unknown>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 123,
"value": "<unknown>",
"mappedGenericValues": [
"<unknown>"
],
"productName": "<string>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
},
"localizedContent": [
{
"localeCode": "<string>",
"stringValue": "<string>"
}
],
"displayOrder": 123
}
}
],
"forceOrder": true
}
],
"isTaxable": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "<string>"
},
"shippingClassId": 123,
"isRecurring": true,
"upc": "<string>",
"supplierInfo": {
"mfgPartNumber": "<string>",
"distPartNumber": "<string>",
"cost": {
"isoCurrencyCode": "<string>",
"cost": 123
}
},
"isPackagedStandAlone": true,
"standAlonePackageType": "<string>",
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"applicableDiscounts": [
{
"scope": "<string>",
"target": {
"type": "<string>",
"includeAllProducts": true,
"includedCategoriesOperator": "<string>",
"categories": [
{
"id": 123
}
],
"excludedCategoriesOperator": "<string>",
"excludedCategories": [
{
"id": 123
}
],
"products": [
{
"productCode": "<string>"
}
],
"excludedProducts": [
{
"productCode": "<string>"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "<string>",
"name": "<string>"
}
],
"shippingZones": [
{
"zone": "<string>"
}
],
"doNotApplyToHandlingFees": true,
"maximumQuantityPerRedemption": 123,
"appliesToLeastExpensiveProductsFirst": true
},
"amountType": "<string>",
"id": 123,
"content": {
"name": "<string>",
"localeCode": "<string>",
"friendlyDescription": "<string>",
"customPropertyValues": {
"value1": "<string>",
"value2": "<string>",
"value3": "<string>",
"value4": "<string>",
"value5": "<string>",
"value6": "<string>",
"value7": "<string>",
"value8": "<string>",
"value9": "<string>",
"value10": "<string>"
},
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
},
"localizedContent": [
{
"name": "<string>",
"localeCode": "<string>",
"friendlyDescription": "<string>",
"customPropertyValues": {
"value1": "<string>",
"value2": "<string>",
"value3": "<string>",
"value4": "<string>",
"value5": "<string>",
"value6": "<string>",
"value7": "<string>",
"value8": "<string>",
"value9": "<string>",
"value10": "<string>"
},
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}
],
"conditions": {
"maxRedemptionCount": 123,
"requiresCoupon": true,
"couponCode": "<string>",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"<string>"
],
"includedCategories": [
{
"categoryId": 123
}
],
"excludedCategories": [
{
"categoryId": 123
}
],
"includedProducts": [
{
"productCode": "<string>"
}
],
"excludedProducts": [
{
"productCode": "<string>"
}
],
"customerSegments": [
{
"id": 123
}
],
"minimumQuantityRequiredProducts": 123,
"minimumQuantityProductsRequiredInCategories": 123,
"minimumOrderAmount": 123,
"maximumOrderAmount": 123,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 123
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "<string>"
}
],
"minimumLifetimeValueAmount": 123,
"startDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"minimumCategorySubtotalBeforeDiscounts": 123,
"minimumRequiredQuantityPerRedemption": 123,
"validSubscriptionFrequencies": [
"<string>"
],
"validSubscriptionContinuityOrdinals": [
123
],
"minDistinctProductsRequired": 123,
"minTotalOrderQuantity": 123,
"pricingContext": "<string>",
"continuityRecurrenceSettings": {
"startOrdinal": 123,
"interval": 123,
"stopOrdinal": 123
},
"validFulfillmentMethods": [
"<string>"
],
"exclusiveSiteIds": [
123
],
"expression": {
"text": "<string>",
"tree": {
"type": "<string>",
"logicalOperator": "<string>",
"nodes": "<array>",
"left": "<string>",
"operator": "<string>",
"right": "<unknown>"
}
},
"exclusiveLocationCodes": [
"<string>"
]
},
"currentRedemptionCount": 123,
"amount": 123,
"status": "<string>",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"isDisabled": true,
"maximumUsesPerUser": 123,
"maximumDiscountImpactPerOrder": 123,
"maximumDiscountImpactPerRedemption": 123,
"maximumRedemptionsPerOrder": 123,
"includedPriceLists": [
"<string>"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 123,
"thresholdMessage": {
"discountId": 123,
"thresholdValue": 123,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"messageTemplate": "<string>",
"localeCode": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
},
"localizedContent": [
{
"messageTemplate": "<string>",
"localeCode": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"tagCodes": [
"<string>"
],
"isSubscriptionDiscount": true,
"isPublic": true,
"code": "<string>",
"labels": [
"<string>"
]
}
],
"isVariation": true,
"variationKey": "<string>",
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"variationOptions": [
{
"attributeFQN": "<string>",
"value": "<unknown>",
"content": {
"localeCode": "<string>",
"stringValue": "<string>"
}
}
],
"publishingInfo": {
"publishedState": "<string>",
"lastPublishedBy": "<string>",
"lastPublishedDate": "2023-11-07T05:31:56Z",
"publishSetCode": "<string>"
},
"bundledProducts": [
{
"productCode": "<string>",
"quantity": 123,
"price": {
"isoCurrencyCode": "<string>",
"price": 123,
"salePrice": 123,
"msrp": 123,
"map": 123,
"mapStartDate": "2023-11-07T05:31:56Z",
"mapEndDate": "2023-11-07T05:31:56Z",
"creditValue": 123
},
"productName": "<string>",
"packageHeight": {
"unit": "<string>",
"value": 123
},
"packageWidth": {
"unit": "<string>",
"value": 123
},
"packageLength": {
"unit": "<string>",
"value": 123
},
"packageWeight": {
"unit": "<string>",
"value": 123
},
"fulfillmentTypesSupported": [
"<string>"
]
}
],
"productCollectionProducts": [
{
"memberKey": {
"value": "<string>"
},
"productUsage": "<string>",
"content": {
"localeCode": "<string>",
"productName": "<string>",
"productFullDescription": "<string>",
"productShortDescription": "<string>",
"productImages": [
{
"id": 123,
"localeCode": "<string>",
"imageLabel": "<string>",
"altText": "<string>",
"imageUrl": "<string>",
"cmsId": "<string>",
"videoUrl": "<string>",
"mediaType": "<string>",
"sequence": 123,
"productImageGroupId": "<string>"
}
]
},
"price": {
"isoCurrencyCode": "<string>",
"price": 123,
"salePrice": 123,
"msrp": 123,
"map": 123,
"mapStartDate": "2023-11-07T05:31:56Z",
"mapEndDate": "2023-11-07T05:31:56Z",
"creditValue": 123
}
}
],
"productCollections": [
{
"collectionProductCode": "<string>",
"collectionName": "<string>",
"isPrimaryCollection": true
}
],
"productImageGroups": [
{
"productImageGroupId": "<string>",
"productImageGroupTags": [
{
"fqn": "<string>",
"values": [
"<string>"
]
}
]
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"slicingSettings": {
"slicingAttributeFqn": "<string>"
},
"primaryProductCollectionCode": "<string>"
}JWT Authorization header using the Bearer scheme.
limits which fields are returned in the response body
Properties of the new product. Required properties: ProductCode, Content.ProductName, and Price.ListPrice. Mozu.ProductAdmin.Contracts.Product
Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.
Merchant-created code identifier associated with the product, for example, a SKU or product item number.
Indicates the usage type of this product. Must be one of the values in ProductUsageConst.
Indicates the fulfillment types the product supports.
Identifier of the Master Catalog that this product is a member of. System-supplied and read-only
System generated monotonically increasing sequence
Unique identifier of the productType of the product. Refers to a valid ProductType that was previously created with the ProductType resource.
Read only flag that indicates if the product meets the product type constraints (All adminRequired attributes have a valid value)
This is the base product ProductCode of a product that is a variation. It is read-only and only populated for products that are variations of a configurable base product.
Catalog specific info for each catalog a product is valid in. There should always be one or more entries here.
Show child attributes
Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.
Show child attributes
The content for each locale code supported by the master catalog
Show child attributes
Price of the product and currency used.
Show child attributes
Pricing behavior associated with the product
Show child attributes
Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.
Show child attributes
The default content SEO content of a product. This content is always in the default language of the MasterCatalog
Show child attributes
The Options defined in the product Type that are currently assigned to this product
Show child attributes
The Extras defined in the product Type that are currently assigned to this product
Show child attributes
The Properties defined in the product Type that are currently assigned to this product
Show child attributes
If true, the product is subject to tax.
Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.
Show child attributes
If true, the product can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.
UPC code of the product.
Supplier info for the product
Show child attributes
Does this product need to be packaged on its own
When packaged alone this is the package type
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Read only. List of discounts that are available for a product.
Show child attributes
Read only. If true, this is a product variation of a product with configurable options. System-supplied and read-only.
Read only. If IsVariation true, thish provides a unique key to manage the variation of the base product.
Read only. If true, this product has configurable options. The product is not purchasable until the shopper selects options that resolve to a product variation. System-supplied and read-only.
Read only. If true, the product has stand-alone options that a shopper may select. System-supplied and read-only.
Read only List of variations that exist for a product. This is only populated when IsVariation is true. To get the list of options, the GET request must include the VariationOptions response group.
Show child attributes
Price of the product and currency used.
Show child attributes
list of other products that are included in a BundleProduct This requires that the ProductUsage be set to Bundle
Show child attributes
list of other products that are members of a ProductCollection This requires that the ProductUsage be set to Collection
Show child attributes
List of Mozu.ProductAdmin.Contracts.ProductCollectionInfo that this product belongs to
Show child attributes
List of the image groups this product uses. Image groups are used to map different images to different product options. If the product doesn't have options then all images will be in the default image group.
Show child attributes
Show child attributes
Container class for Slicing Settings
Show child attributes
When this product belongs to a product collection this is the product id for the primary collection.
Success
Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.
Merchant-created code identifier associated with the product, for example, a SKU or product item number.
Indicates the usage type of this product. Must be one of the values in ProductUsageConst.
Indicates the fulfillment types the product supports.
Identifier of the Master Catalog that this product is a member of. System-supplied and read-only
System generated monotonically increasing sequence
Unique identifier of the productType of the product. Refers to a valid ProductType that was previously created with the ProductType resource.
Read only flag that indicates if the product meets the product type constraints (All adminRequired attributes have a valid value)
This is the base product ProductCode of a product that is a variation. It is read-only and only populated for products that are variations of a configurable base product.
Catalog specific info for each catalog a product is valid in. There should always be one or more entries here.
Show child attributes
Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.
Show child attributes
The content for each locale code supported by the master catalog
Show child attributes
Price of the product and currency used.
Show child attributes
Pricing behavior associated with the product
Show child attributes
Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.
Show child attributes
The default content SEO content of a product. This content is always in the default language of the MasterCatalog
Show child attributes
The Options defined in the product Type that are currently assigned to this product
Show child attributes
The Extras defined in the product Type that are currently assigned to this product
Show child attributes
The Properties defined in the product Type that are currently assigned to this product
Show child attributes
If true, the product is subject to tax.
Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.
Show child attributes
If true, the product can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.
UPC code of the product.
Supplier info for the product
Show child attributes
Does this product need to be packaged on its own
When packaged alone this is the package type
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Read only. List of discounts that are available for a product.
Show child attributes
Read only. If true, this is a product variation of a product with configurable options. System-supplied and read-only.
Read only. If IsVariation true, thish provides a unique key to manage the variation of the base product.
Read only. If true, this product has configurable options. The product is not purchasable until the shopper selects options that resolve to a product variation. System-supplied and read-only.
Read only. If true, the product has stand-alone options that a shopper may select. System-supplied and read-only.
Read only List of variations that exist for a product. This is only populated when IsVariation is true. To get the list of options, the GET request must include the VariationOptions response group.
Show child attributes
Price of the product and currency used.
Show child attributes
list of other products that are included in a BundleProduct This requires that the ProductUsage be set to Bundle
Show child attributes
list of other products that are members of a ProductCollection This requires that the ProductUsage be set to Collection
Show child attributes
List of Mozu.ProductAdmin.Contracts.ProductCollectionInfo that this product belongs to
Show child attributes
List of the image groups this product uses. Image groups are used to map different images to different product options. If the product doesn't have options then all images will be in the default image group.
Show child attributes
Show child attributes
Container class for Slicing Settings
Show child attributes
When this product belongs to a product collection this is the product id for the primary collection.