Webhook: Basket
Basket webhooks are fired when Customers interact with the Storefront, adding or removing items from their basket.
product_added
Description
This webhook fires when a product was added to the basket or the quantity of the product or bundle was increased
Payload Format
| Attribute | Type | Description |
|---|---|---|
| viewer_id | String | The Identifier of the current session |
| customer_id | String | The identifier of the logged in Customer, if the current viewer is logged in |
| product_id | String | The identifier of the Product that was added or updated |
| bundle_id | String | The identifier of the Bundle that was added or updated |
| variant_ids | Array | A list of the component parts of the Product affected by this change |
| quantity | Integer | The amount that was added or removed |
| created_at | DateTime | An ISO-8166 timestamp of when the action happened |
product_removed
Description
This webhook fires when a product was removed from the basket or the quantity of the product or bundle in the basket was reduced
Payload Format
| Attribute | Type | Description |
|---|---|---|
| viewer_id | String | The Identifier of the current session |
| customer_id | String | The identifier of the logged in Customer, if the current viewer is logged in |
| product_id | String | The identifier of the Product that was added or updated |
| bundle_id | String | The identifier of the Bundle that was added or updated |
| variant_ids | Array | A list of the component parts of the Product affected by this change |
| quantity | Integer | The amount that was added or removed |
| created_at | DateTime | An ISO-8166 timestamp of when the action happened |