EcommerceProducts

Update Product

Update an existing Product.

Updating an existing Product will set the product type to Advanced, which ensures all Product and SKU fields will be shown to users in the Designer.

Required scope | ecommerce:write

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site
product_idstringRequiredformat: "objectid"
Unique identifier for a Product

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

The product to update
publishStatusenumOptionalDefaults to staging
Indicate whether your Product should be set as "staging" or "live"
Allowed values:
productobjectOptional
The Product object
skuobjectOptional
The SKU object

Response

Request was successful
idstring or null
Unique identifier for the Product
cmsLocaleIdstring or null
Identifier for the locale of the CMS item
lastPublishedstring or nullformat: "date-time"
The date the Product was last published
lastUpdatedstring or nullformat: "date-time"
The date the Product was last updated
createdOnstring or nullformat: "date-time"
The date the Product was created
isArchivedboolean or nullDefaults to false
Boolean determining if the Product is set to archived
isDraftboolean or nullDefaults to false
Boolean determining if the Product is set to draft
fieldDataobject or null

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

Errors