Skip to main content

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 modified
  • store_group.deleted - Triggered when a store group is deleted
  • store_group_market.update - Triggered when a store group's market is updated
  • store_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​

{
"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​

FieldTypeDescription
idstringUnique identifier for the store group
slugstringURL-friendly identifier
namestringDisplay name of the store group
country_of_salestringPrimary country of sale
descriptionstringStore group description
channel_typestringType of sales channel
marketsarrayAssociated markets configuration

Store Group Deleted Event​

The store_group.deleted event is triggered when a store group is removed from the system.

Event Structure​

{
"event_type": "store_group.deleted",
"payload": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"slug": "main-store"
}
}

Field Descriptions​

FieldTypeDescription
idstringUnique identifier of the deleted store group
slugstringURL-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​

{
"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​

FieldTypeDescription
store_group_idstringID of the store group
store_group_slugstringSlug of the store group
country_codestringTwo-letter ISO country code
currency_codestringThree-letter ISO currency code
is_tax_included_in_pricebooleanWhether prices include tax
is_tax_exemption_eligiblebooleanWhether tax exemption is available
createdbooleanWhether 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​

{
"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​

FieldTypeDescription
store_group_idstringID of the store group
store_group_slugstringSlug of the store group
country_codestringTwo-letter ISO country code of the removed market