Skip to main content
GET
/
commerce
/
catalog
/
admin
/
productsV1
/
{productCode}
Error
A valid request URL is required to generate request examples
{
  "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>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
productCode
string
required

Merchant-created code associated with the product, for example, a SKU. Required.

Query Parameters

​
responseGroups
string

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.

​
responseFields
string

limits which fields are returned in the response body

Response

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.

​
applicableDiscounts
object[] | null

Read only. List of discounts that are available for a product.

​
auditInfo
object
​
baseProductCode
string | null

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.

​
bundledProducts
object[] | null

list of other products that are included in a BundleProduct This requires that the ProductUsage be set to Bundle

​
content
object

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.

​
extras
object[] | null

The Extras defined in the product Type that are currently assigned to this product

​
fulfillmentTypesSupported
string[] | null

Indicates the fulfillment types the product supports.

​
hasConfigurableOptions
boolean

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.

​
hasStandAloneOptions
boolean

Read only. If true, the product has stand-alone options that a shopper may select. System-supplied and read-only.

​
inventoryInfo
object

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.

​
isPackagedStandAlone
boolean | null

Does this product need to be packaged on its own

​
isRecurring
boolean | null

If true, the product can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.

​
isTaxable
boolean | null

If true, the product is subject to tax.

​
isValidForProductType
boolean | null

Read only flag that indicates if the product meets the product type constraints (All adminRequired attributes have a valid value)

​
isVariation
boolean

Read only. If true, this is a product variation of a product with configurable options. System-supplied and read-only.

​
masterCatalogId
integer<int32> | null

Identifier of the Master Catalog that this product is a member of. System-supplied and read-only

​
options
object[] | null

The Options defined in the product Type that are currently assigned to this product

​
packageHeight
object
​
packageLength
object
​
packageWeight
object
​
packageWidth
object
​
price
object

Price of the product and currency used.

​
pricingBehavior
object

Pricing behavior associated with the product

​
primaryProductCollectionCode
string | null

When this product belongs to a product collection this is the product id for the primary collection.

​
productCode
string | null

Merchant-created code identifier associated with the product, for example, a SKU or product item number.

​
productCollectionProducts
object[] | null

list of other products that are members of a ProductCollection This requires that the ProductUsage be set to Collection

​
productCollections
object[] | null

List of Mozu.ProductAdmin.Contracts.ProductCollectionInfo that this product belongs to

​
productImageGroups
object[] | null

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.

​
productInCatalogs
object[] | null

Catalog specific info for each catalog a product is valid in. There should always be one or more entries here.

​
productSequence
integer<int32> | null

System generated monotonically increasing sequence

​
productTypeId
integer<int32> | null

Unique identifier of the productType of the product. Refers to a valid ProductType that was previously created with the ProductType resource.

​
productUsage
string | null

Indicates the usage type of this product. Must be one of the values in ProductUsageConst.

​
properties
object[] | null

The Properties defined in the product Type that are currently assigned to this product

​
publishingInfo
object

Price of the product and currency used.

​
seoContent
object

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.

​
shippingClassId
integer<int32> | null
​
slicingSettings
object

Container class for Slicing Settings

​
standAlonePackageType
string | null

When packaged alone this is the package type

​
supplierInfo
object

Supplier info for the product

​
upc
string | null

UPC code of the product.

​
variationKey
string | null

Read only. If IsVariation true, thish provides a unique key to manage the variation of the base product.

​
variationOptions
object[] | null

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.