Product Notifications - The product Catalog was changed / ProductCatalogChanged
Introduction
This article guides Seller Admins in setting up automated notifications to stay informed about significant changes to the Product Catalog on your Platform. These notifications help you keep Offers integrated into your marketplace synchronized and up to date whenever catalog modifications occur.
In this article:
- Understanding Catalog Change Notifications
- Configuring Notification Recipients
- Catalog Change Triggers
- Notification Content Details
- Webhook
Understanding Catalog Change Notifications
The Platform provides automated notifications whenever significant changes occur in your Product Catalog. These real-time alerts enable you to maintain accurate and current product information across your marketplace without manual monitoring.
The notification system monitors various catalog activities and sends alerts to designated recipients whenever changes are made to products, categories, or Offers within your catalog.
Configuring Notification Recipients
To configure who receives catalog change notifications, you need to specify recipient email addresses in three optional fields:
To: Primary recipients who will receive the notifications directly.
Cc: Secondary recipients who will receive copies of the notifications for awareness purposes.
Bcc: Hidden recipients who will receive notifications without other recipients knowing.
All recipient fields are optional, allowing you to customize your notification distribution based on your team's needs and organizational structure. Learn more here about Notification Settings.
Catalog Change Triggers
The Product Catalog change notification is triggered by nine distinct actions that affect your product catalog structure and content. Understanding these triggers helps you anticipate when notifications will be sent:
- Create a new category
- Add Product to the new category
- Rename existing category
- Add Product to the renamed category
- Delete the category with the Product
- Remove Product from category
- New Subscription synced
- Product Catalog changed
- The list of Offers under the Product changed
Each trigger represents a significant modification to your catalog that may impact how products are displayed or accessed by Customers and Partners in your marketplace.
Notification Content Details
When a catalog change notification is triggered, the alert includes detailed information about what changed in your catalog. The notification contains several key identifiers that help you understand and process the change:
ProductCatalogId: Unique identifier for the Product Catalog that was modified.
CustomerCategoryId: Identifier for the Customer Segment category affected by the change.
CustomerCategoryName: Display name of the Customer Segment category.
ProductCategoryId: Identifier for the product category involved in the change.
ProductCategoryUrlName: URL-friendly name for the product category.
ProductId: Unique identifier for the specific Product that was changed.
ProductName: Display name of the Product affected by the modification.
The notification also separates Offers into two categories based on their visibility status. Viewable offers are those currently available to Customers, while Hidden offers are those that exist in the catalog but are not currently accessible for purchase. Each offer is listed with its unique identifier and name, allowing you to track exactly which offerings have been modified.
Webhook
To see the webhook body with all fields, their descriptions and other data, see the Webhooks Documentation.
Summary
Setting up Product Catalog change notifications enables automated monitoring of your catalog modifications. By configuring recipient addresses and understanding the nine actions that trigger notifications, you can maintain accurate product information across your marketplace. The detailed notification content provides comprehensive information about catalog changes, including product identifiers, category relationships, and offer visibility status, ensuring your systems stay synchronized with catalog updates.
Add comment
Please sign in to leave a comment.