commerce/catalog/admin/mastercatalogs

Use the Master Catalog resource to view details of the master catalogs associated with a tenant and to manage the product publishing mode for each master catalog.

JSON Example

MasterCatalog Properties

Property Description
enableLiveEdit

type: bool

Enables the live editing of products feature. If you set the productPublishingMode field to Pending, set this field to true, and set the DataViewMode in the context header to live, you can edit the live version of products instead of the pending draft.

This should only be enabled for immediate changes to the live version of products. Any edits made to the live version are not applied to the pending draft version, so when you publish the pending draft version, your edits to the live version are overwritten.

id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

isDeleted

type: bool

Indicates if the object is deleted. If true, the object has been deleted. This may affect associated child members and objects. For example, a deleted master catalog affects all associated catalogs.

name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

productPublishingMode

type: string

The mode this master catalog uses for product updates. Possible values are "Pending" which saves product updates as a draft until they are published, and "Live" which publishes all product updates immediately.

Operations

Operation Name Request URI Description
GetMasterCatalog GET %7bmasterCatalogId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieve the details of the master catalog specified in the request.

GetMasterCatalogs GET %3fresponseFields%3d%7bresponseFields%7d

Retrieve the details of all master catalog associated with a tenant.

UpdateMasterCatalog PUT %7bmasterCatalogId%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the product publishing mode for the master catalog specified in the request.