Update Product in Catalog

put https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/catalog/admin/productsV1/{productCode}/ProductInCatalogs/{catalogId}

Updates products in a particular catalog. 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.

Path Params

productCode

string

required

catalogId

int32

required

Query Params

responseFields

string

limits which fields are returned in the response body

Body Params

catalogId

int32

The CatalogId of the catalog that the product is associated with (The catalog must a valid catalog within the MasterCatalog that the product belongs to)

isActive

boolean | null

If true, the product is marked as available for sale in the catalog. Setting a product to IsActive = false will prevent it from being shown on the customer facing storefront.

isContentOverridden

boolean | null

If true, the content for this product is overridden in the catalog. If false, the MasterCatalog level content will be used for the product.

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.

isPriceOverridden

boolean | null

If true, the price for this product is overridden in the catalog. If false, the MasterCatalog level price will be used for the product.

price

object

Price of the product and currency used.

isSEOContentOverridden

boolean | null

If true, the SEO content for this product is overridden in the catalog. If false, the MasterCatalog level SEO content will be used for the product.

seoContent

object

productCategories

array of objects | null

Categories to which the product belongs for this catalog.

productCategories

primaryProductCategory

object

Categories to which the product belongs.

dateFirstAvailableInCatalog

date-time | null

Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag.

activeDateRange

object

Active Effectivity Dates

auditInfo

object

Response

Response body

object

catalogId

int32

The CatalogId of the catalog that the product is associated with (The catalog must a valid catalog within the MasterCatalog that the product belongs to)

isActive

boolean | null

If true, the product is marked as available for sale in the catalog. Setting a product to IsActive = false will prevent it from being shown on the customer facing storefront.

isContentOverridden

boolean | null

If true, the content for this product is overridden in the catalog. If false, the MasterCatalog level content will be used for the product.

content

object

localeCode

string | null

Lanugage used for product content. Currently, only en_US is supported.

productName

string | null

Name of the product.

productFullDescription

string | null

Long description of the product typically used for a product details page.

productShortDescription

string | null

Brief description of the product typically used when the product is displayed in a list or search results.

productImages

array of objects | null

List of images associated with the product.

productImages

object

int32 | null

Unique identifier of the image. System-supplied and read-only.

localeCode

string | null

Language used for the image content.

imageLabel

string | null

Image title that appears on the storefront.

altText

string | null

Descriptive text associated with the image or video that appears on the storefront.

imageUrl

string | null

URL of the image.

cmsId

string | null

Id of the image in the CMS.

videoUrl

string | null

URL of a video associated with the product.

mediaType

string | null

Type of media. Used by the client to determine how to render the image or video or what have you.

sequence

int32 | null

For products with multiple images, the order in which this image appears on the storefront.

productImageGroupId

string | null

Image group to which this image belongs. Default is null.

isPriceOverridden

boolean | null

If true, the price for this product is overridden in the catalog. If false, the MasterCatalog level price will be used for the product.

price

object

Price of the product and currency used.

isoCurrencyCode

string | null

Currency code.

price

double | null

Price of the product. This is the price the merchant intends to sell the product if no sale price is present.

salePrice

double | null

Current sale price of the product. Sale price is a numeric (monetary) amount, not a percentage off.

msrp

double | null

Manufacturer Suggested Retail Price. +

map

double | null

Minimum Advertised Price

mapStartDate

date-time | null

Minimum Advertised Price effective start date (null = begining of time)

mapEndDate

date-time | null

Minimum Advertised Price effectivity end date (null = forever)

creditValue

double | null

Credit amt of the product

isSEOContentOverridden

boolean | null

If true, the SEO content for this product is overridden in the catalog. If false, the MasterCatalog level SEO content will be used for the product.

seoContent

object

localeCode

string | null

Lanugage used for product content. Currently, only en_US is supported.

metaTagTitle

string | null

Metadata title. Metadata can be used to manage information internally. Sometimes used for SEO.

metaTagDescription

string | null

Metadata description. Metadata can be used to manage information internally. Sometimes used for SEO.

metaTagKeywords

string | null

Metadata keywords. Metadata can be used to manage information internally. Sometimes used for SEO.

titleTagTitle

string | null

Used to customize the HTML title tag within the head section of the product details page

seoFriendlyUrl

string | null

Human-readable identifier that you can give to the product to create friendly URLs. For example,
instead of "http: //example.com/products?category=2&id=25," the friendly URL can be "http: //example.com/products/category/2/25."

productCategories

array of objects | null

Categories to which the product belongs for this catalog.

productCategories

object

categoryId

int32

Unique identifier of the category. System-supplied and read-only.

primaryProductCategory

object

Categories to which the product belongs.

categoryId

int32

Unique identifier of the category. System-supplied and read-only.

dateFirstAvailableInCatalog

date-time | null

Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag.

activeDateRange

object

Active Effectivity Dates

startDate

date-time | null

endDate

date-time | null

auditInfo

object

updateDate

date-time | null

createDate

date-time | null

updateBy

string | null

createBy

string | null

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://t0-s0.sandbox.mozu.com/api/commerce/catalog/admin/productsV1/productCode/ProductInCatalogs/catalogId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success