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
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
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
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
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

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

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