Webhook: Product

Product webhooks are fired in response to actions within the lifecycle of a Product. This includes creation, updates, deletion and restoration of Products.

product_create

Description

This webhook is fired when a Product is created

Payload Format

Attribute	Type	Description
id	String	The identifier of this Product
name	String	The name of this Product
appdata	Map	App-specific data attached to this Product
variants	Variant[]	The Variants belonging to this Product
store	Store	The Store this Product belongs to
vendor	Vendor	The Vendor that owns this Product
url	String	The storefront URL of this Product on this Store's primary domain. External-vendor products take the /vendors/:vendor_id/products/:handle form.
images	ProductImage[]	This Product's images, ordered by position (ascending)
released_at	DateTime	An ISO8601 format timestamp for the product release date
created_at	DateTime	An ISO8601 format timestamp for the creation time of this record
updated_at	DateTime	An ISO8601 format timestamp for the last update to this record

product_update

Description

This webhook is fired when a Product is updated

Payload Format

Attribute	Type	Description
id	String	The identifier of this Product
name	String	The name of this Product
appdata	Map	App-specific data attached to this Product
variants	Variant[]	The Variants belonging to this Product
store	Store	The Store this Product belongs to
vendor	Vendor	The Vendor that owns this Product
url	String	The storefront URL of this Product on this Store's primary domain. External-vendor products take the /vendors/:vendor_id/products/:handle form.
images	ProductImage[]	This Product's images, ordered by position (ascending)
released_at	DateTime	An ISO8601 format timestamp for the product release date
created_at	DateTime	An ISO8601 format timestamp for the creation time of this record
updated_at	DateTime	An ISO8601 format timestamp for the last update to this record

product_delete

Description

This webhook is fired when a Product is deleted (moved to recycle bin)

Payload Format

Attribute	Type	Description
id	String	The identifier of this Product
name	String	The name of this Product
appdata	Map	App-specific data attached to this Product
variants	Variant[]	The Variants belonging to this Product
store	Store	The Store this Product belongs to
vendor	Vendor	The Vendor that owns this Product
url	String	The storefront URL of this Product on this Store's primary domain. External-vendor products take the /vendors/:vendor_id/products/:handle form.
images	ProductImage[]	This Product's images, ordered by position (ascending)
released_at	DateTime	An ISO8601 format timestamp for the product release date
created_at	DateTime	An ISO8601 format timestamp for the creation time of this record
updated_at	DateTime	An ISO8601 format timestamp for the last update to this record

product_restore

Description

This webhook is fired when a Product is restored from the recycle bin

Payload Format

Attribute	Type	Description
id	String	The identifier of this Product
name	String	The name of this Product
appdata	Map	App-specific data attached to this Product
variants	Variant[]	The Variants belonging to this Product
store	Store	The Store this Product belongs to
vendor	Vendor	The Vendor that owns this Product
url	String	The storefront URL of this Product on this Store's primary domain. External-vendor products take the /vendors/:vendor_id/products/:handle form.
images	ProductImage[]	This Product's images, ordered by position (ascending)
released_at	DateTime	An ISO8601 format timestamp for the product release date
created_at	DateTime	An ISO8601 format timestamp for the creation time of this record
updated_at	DateTime	An ISO8601 format timestamp for the last update to this record

stock_status_update

Description

This webhook is fired when a Variant’s stock status changes — it sells out, or comes back in stock

Payload Format

Attribute	Type	Description
id	String	The identifier of the parent Product
name	String	The name of the parent Product
url	String	The storefront URL of the parent Product
store	Store	The Store the Product belongs to
status	String	The new stock status: "in_stock" or "out_of_stock"
variant	StockStatusVariant	The Variant whose stock status changed

Additional Data Types

Variant

A purchasable variation of a Product

Attribute	Type	Description
id	String	The identifier of this Variant
name	String	The name of this Variant
sku	String	The SKU of this Variant
fulfiller	Object	The fulfiller for this Variant (id, name) or null
product_id	String	The identifier of the parent Product
variation	Map	The variation options for this Variant
price	Money	The price of this Variant
position	Integer	The display position of this Variant
stock	Integer	The available stock level of this Variant

Store

The Store this Product belongs to

Attribute	Type	Description
id	String	The identifier of the Store
name	String	The name of the Store

Vendor

The Vendor that owns this Product

Attribute	Type	Description
id	String	The identifier of the Vendor
name	String	The name of the Vendor

ProductImage

An image belonging to a Product

Attribute	Type	Description
url	String	The URL of this image, resized for delivery
position	Integer	The display position of this image, ascending from 0

StockStatusVariant

The Variant whose stock status changed

Attribute	Type	Description
id	String	The identifier of the Variant whose stock status changed
name	String	The name of the Variant
sku	String	The SKU of the Variant
stock	Integer	The available stock level of the Variant after the change