Store Group Events
This section covers all webhook events related to store groups, including store group updates, deletions, and market changes.
Event Types
The following store group-related events are available:
store_group.update- Triggered when a store group is created or modifiedstore_group.deleted- Triggered when a store group is deletedstore_group_market.update- Triggered when a store group's market is updatedstore_group_market.deleted- Triggered when a market is removed from a store group
Store Group Updated Event
The store_group.update event is triggered when a store group is created or modified.
Event Structure
- JSON Example
{
"event_type": "store_group.update",
"payload": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"slug": "main-store",
"name": "Main Store",
"country_of_sale": "US",
"description": "Primary retail store group",
"channel_type": "retail",
"markets": [
{
"created": true,
"country_code": "us",
"is_tax_included_in_price": true,
"is_tax_exemption_eligible": false,
"currency_code": "USD"
},
{
"created": true,
"country_code": "ca",
"is_tax_included_in_price": true,
"is_tax_exemption_eligible": true,
"currency_code": "CAD"
}
]
}
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the store group |
slug | string | URL-friendly identifier |
name | string | Display name of the store group |
country_of_sale | string | Primary country of sale |
description | string | Store group description |
channel_type | string | Type of sales channel |
markets | array | Associated markets configuration |
Store Group Deleted Event
The store_group.deleted event is triggered when a store group is removed from the system.
Event Structure
- JSON Example
{
"event_type": "store_group.deleted",
"payload": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"slug": "main-store"
}
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier of the deleted store group |
slug | string | URL-friendly identifier of the deleted store group |
Store Group Market Updated Event
The store_group_market.update event is triggered when a market within a store group is updated.
Event Structure
- JSON Example
{
"event_type": "store_group_market.update",
"payload": {
"store_group_id": "123e4567-e89b-12d3-a456-426614174000",
"store_group_slug": "main-store",
"country_code": "us",
"currency_code": "USD",
"is_tax_included_in_price": true,
"is_tax_exemption_eligible": false,
"created": true
}
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
store_group_id | string | ID of the store group |
store_group_slug | string | Slug of the store group |
country_code | string | Two-letter ISO country code |
currency_code | string | Three-letter ISO currency code |
is_tax_included_in_price | boolean | Whether prices include tax |
is_tax_exemption_eligible | boolean | Whether tax exemption is available |
created | boolean | Whether this is a new market |
Store Group Market Deleted Event
The store_group_market.deleted event is triggered when a market is removed from a store group.
Event Structure
- JSON Example
{
"event_type": "store_group_market.deleted",
"payload": {
"store_group_id": "123e4567-e89b-12d3-a456-426614174000",
"store_group_slug": "main-store",
"country_code": "us"
}
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
store_group_id | string | ID of the store group |
store_group_slug | string | Slug of the store group |
country_code | string | Two-letter ISO country code of the removed market |