Update Product

PATCH

Updating an existing Product will set the product type to Advanced. The product type is used to determine which Product and SKU fields are shown to users in the Designer and the Editor. Setting it to Advanced ensures that all Product and SKU fields will be shown. The product type can be edited in the Designer or the Editor.

Required scope | ecommerce:write

Path parameters

site_idstringRequired

Unique identifier for a Site

product_idstringRequired

Unique identifier for a Product

Request

This endpoint expects an object.
publishStatus"staging" or "live"OptionalDefaults to staging
Allowed values: staginglive

Indicate whether your Product should be set as “staging” or “live”

productobjectOptional

The Product object

skuobjectOptional

The SKU object

Response

Request was successful

idstringOptional

Unique identifier for the Product

cmsLocaleIdstringOptional

Identifier for the locale of the CMS item

lastPublisheddatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date the Product was last published

lastUpdateddatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date the Product was last updated

createdOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date the Product was created

isArchivedbooleanOptionalDefaults to false

Boolean determining if the Product is set to archived

isDraftbooleanOptionalDefaults to false

Boolean determining if the Product is set to draft

fieldDataobjectOptional

Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.

Errors