BETA: PW Overview

This is a pilot version of product webhooks for testing purposes only! This documentation may change during testing.

Reference of all webhook events emitted for product-related actions — both from the admin interface and via the API.

Legend

`P:U`	product:update	`P:C`	product:create	`P:D`	product:delete
`P:MU`	product:massUpdate	`P:MC`	product:massCreate	`P:MD`	product:massDelete
`PV:U`	productVariant:update	`PV:C`	productVariant:create	`PV:D`	productVariant:delete
`PV:MU`	productVariant:massUpdate	`PV:MC`	productVariant:massCreate	`PV:MD`	productVariant:massDelete
`PVP:U`	productVariantPrice:update	`PVP:MU`	productVariantPrice:massUpdate

Identifiers in event instances: product: eventInstance contains guid, productVariant: eventInstance contains code.

Mass webhooks behaviour: Each individual PATCH request generates exactly 1 webhook. Batch operations generate 1 mass webhook containing the data of the entire operation. For imports, webhooks are emitted in batches of approximately 300 updates per 1 mass webhook, to prevent individual webhooks from becoming excessively large.

Admin Actions

Action	Events emitted
Product Import
Add 1 product via import	P:C
Add multiple products via import	P:MC
Edit product variant prices	PVP:U / PVP:MU
Delete product(s) / variants	P:D; P:MD; PV:D; PV:MD
Product List
Add product button	P:C; PV:C
Delete 1 product (click X in row)	P:D; PV:D / PV:MD
Delete multiple products	P:MD; PV:MD
Make visible	P:U
Hide	P:U
Set visibility	P:U; P:MU
Move	P:U; P:MU
Copy	P:C; PV:C / P:MC; PV:MC
Change default category	P:U / P:MU
Change parameters	P:U / P:MU
Add categories	P:U / P:MU
Remove categories	P:U / P:MU
Individual parameter change (action icon: New, Tip, Variants)	P:U
Show – Visibility column toggle	P:U
Hide – Visibility column toggle	P:U
Product Detail
On data change	P:U
Change price	P:U; PVP:U / PVP:MU
Add variant (without clicking Save)	P:U; PV:C; PV:MC
Delete variant	P:U; PV:D; PV:MD
Add surcharge parameter (even without clicking Save)	P:U
Delete parameter (filtering, surcharge, etc.)	P:U
Related (tab)	P:U
Advanced (tab)	P:U
Copy button	P:C; PV:C
Add image to Gallery / 360	P:U
Remove image from Gallery / 360	P:U
Change variant visibility	P:U; PV:U
Change surcharge parameter visibility	P:U
Change caption in Gallery / 360	P:U; P:MU
Prices
(Bulk) edit prices in inputs	PVP:U / PVP:MU
Hide	P:U; P:MU; PV:U; PV:MU
Make visible	P:U; P:MU; PV:U; PV:MU
Change price	PVP:U; PVP:MU
Delete variant	P:D; P:MD; PV:D; PV:MD
Delete product and variants	P:D; P:MD; PV:D; PV:MD
Warehouse
Changes in Availability inputs	PV:U; PV:MU
Changes in quantity inputs	PVP:U; PVP:MU
Delete	P:D; P:MD; PV:D; PV:MD; P:MU
Hide	P:U; P:MU; PV:U; PV:MU
Make visible	P:U; P:MU; PV:U; PV:MU
Discounts
Bulk delete	P:D; P:MD; PV:D; PV:MD; P:MU
Edit discount in input	PVP:U; PVP:MU
Delete individually	P:U; P:D; PV:D
Logistics
Individual changes in inputs	PV:U; PV:MU
Search Results
Delete product	P:D; P:MD; PV:D; PV:MD

API Endpoints

Method	Endpoint	Events emitted
PATCH	/api/pricelists/1	PVP:U; PVP:MU
POST	/api/products	P:C; PV:C; PV:MC
POST	/api/products/{guid}/copy	P:C; PV:C; PV:MC
DELETE	/api/products/{guid}	P:D; PV:D; PV:MD
PATCH	/api/products/batch	P:U; PV:U; PV:MU; PV:C; PV:MC
PATCH	/api/products/{guid}	P:U; PV:U; PV:MU; PV:C; PV:MC
PATCH	/api/products/code/{code}	P:U; PV:U; PV:MU; PV:C; PV:MC
DELETE	/api/products/code/{code}	PV:D; P:U
DELETE	/api/products/{guid}/related-files	P:U
PUT	/api/products/{guid}/gifts	P:U
POST	/api/products/{guid}/gifts	P:U
DELETE	/api/products/{guid}/{gallery}	P:U
PATCH	/api/products/{guid}/{gallery}	P:U
POST	/api/products/{guid}/{gallery}	P:U
PATCH	/api/products/{guid}/{gallery}/source	P:U
DELETE	/api/products/{guid}/images/{gallery}/{imageName}	P:U
POST / PUT	/api/products/{guid}/relatedProducts	P:U
POST / PUT	/api/products/{guid}/alternativeProducts	P:U
POST	/api/products/{guid}/related-files	P:U
DELETE	/api/products/{guid}/related-files/{id}	P:U
POST / PUT	/api/products/{guid}/set	P:U

Field-level Detail

Product Detail with Variants – Main Data tab

Field name	API field	Admin	API
Product name	name	P:U	P:U
URL address	indexName	P:U	P:U
Short description	shortDescription	P:U	P:U
Detailed description	description	P:U	P:U
Flags	flags	P:U	P:U
Brand	brandCode	P:U	P:U
Supplier	supplierGuid	P:U	–
Warranty	warrantyId	P:U	P:U
Item type	type	P:U	P:U
Condition (Bazaar only)	–	P:U	–
Condition description (Bazaar only)	–	P:U	–
Visibility	visibility	P:U	P:U
Internal note	internalNote	P:U	P:U

Product Detail with Variants – Price List tab

Field name	API field	Admin	API
Price	–	P:U, PVP:U	–
VAT		P:U, PVP:U	–
Purchase price	–	P:U, PVP:U	–
VAT (purchase)		P:U, PVP:U	–
Code	newCode	P:U; PV:U	P:U; PV:U
Availability	availabilityId	P:U; PV:U	P:U; PV:U
Availability when sold out	availabilityWhenSoldOutId	P:U; PV:U	P:U; PV:U
Visibility	visible	P:U	P:U; PV:U

Variant Detail – Main Data tab

Field name	API field	Admin	API
Code	newCode	PV:U	PV:U; P:U
Color parameter value	–	PV:U	–

Variant Detail – Price List tab

Field name	API field	Admin	API
Price	–	PV:U; P:U	–
Price coefficient	–	PV:U; P:U	–
Standard price	–	PV:U; P:U	–
Purchase price	–	PV:U; P:U	–
Action price	–	PV:U; P:U	–
Unit	unitId	PV:U	PV:U; P:U
Package amount	packagingUnit, packagingAmount	PV:U	PV:U; P:U
Measure unit	measureUnitId, measureAmount	PV:U	PV:U; P:U
Recycling fee – category	recyclingFeeId	PV:U	PV:U; P:U
Consumption tax – name	consumptionTaxId	PV:U	PV:U; P:U
OSS VAT rates	ossVatLevels[]	–	PV:U; P:U

Variant Detail – Warehouse tab

Field name	API field	Admin	API
Warehouse location	stocksLocations[]	–	PV:U; P:U
Availability	availabilityId	PV:U	P:U; PV:U
Availability when sold out	availabilityWhenSoldOutId	PV:U	P:U; PV:U
Minimum stock	minStockSupply	PV:U	P:U; PV:U
Min. orderable quantity	–	PV:U	–
Max. orderable quantity	–	PV:U	–
Allow to order product out of stock	negativeStockAllowed	PV:U	P:U; PV:U
Enable decimal places for quantity	amountDecimalPlaces	PV:U	P:U; PV:U