commerce/catalog/admin/publishing

Use the Product Publishing resource to publish or discard pending changes to products in a master catalog, or to add or remove pending changes to and from product publish sets.

You can use product publish sets to group pending product changes together and publish them all at the same time.

JSON Example

PublishingScope Properties

Property Description
allPending

type: bool

Specifies whether all the pending product drafts are affected by the operation performed.

For example, when you perform the PublishDrafts operation and you set this field to true, all pending product changes in the master catalog or in a publish set are published.

productCodes

type: list of string

A list of product codes of associated products.

When this field is in the Product Publishing resource, you can use this field to publish or delete individual pending product changes, or assign individual pending product changes to a publish set.

publishSetCode

type: string

The unique identifier of the product publish set.

You can use this field to perform operations on all the pending product changes assigned to a publish set. For example, when you perform the PublishDrafts operation, you can specify the publish set that the pending product changes are assigned to in order to publish all of the pending changes.

Note: If you specify a publishSetCode, the respecting operation is performed on all pending product changes assigned to the publish set, even if you specify individual productCodes.

Operations

Operation Name Request URI Description
AssignProductsToPublishSet POST publishsets%3fresponseFields%3d%7bresponseFields%7d

Assigns pending product changes to a specified product publish set. Use the code field to specify the product publish set.

DeletePublishSet DELETE publishsets%2f%7bpublishSetCode%7d%3fdiscardDrafts%3d%7bdiscardDrafts%7d

Deletes the specified product publish set. If you set the discardDrafts parameter to true, this operation also deletes the product drafts assigned to the publish set.

DiscardDrafts POST discarddrafts

Deletes the draft version of product changes (pending product changes) for each product code specified in the request.

GetPublishSet GET publishsets%2f%7bpublishSetCode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the specified product publish set.

GetPublishSets GET publishsets%3fresponseFields%3d%7bresponseFields%7d

Retrieves a list of product publish sets and their properties, including the amount of pending product changes that are included in each one.

PublishDrafts POST publishdrafts

Publishes the draft version of product changes (pending product changes) for each product code specified in the request, and changes the product publish state to "live".