Price Events

Documentation for price-related webhook events

This section covers all webhook events related to variant prices.

Event Types

The following price-related events are available:

variant_prices.updated - Triggered when prices for a variant are updated

Variant Prices Updated Event

The variant_prices.updated event is triggered when prices for a variant are modified.

Event Structure

{
  "event_type": "variant_prices.updated",
  "payload": {
    "variant_id": "123e4567-e89b-12d3-a456-426614174000",
    "product_id": "123e4567-e89b-12d3-a456-426614174001",
    "store_group_id": "123e4567-e89b-12d3-a456-426614174002",
    "store_group_slug": "main-store",
    "variant_number": "VAR-123",
    "markets": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174003",
        "market_id": "123e4567-e89b-12d3-a456-426614174004",
        "market_slug": "us",
        "country_codes": ["US"],
        "base_price_amount": 99.99,
        "sale_price_amount": 79.99,
        "reference_price_amount": 79.99,
        "currency": "USD",
        "on_sale": true,
        "status": "active"
      },
      {
        "id": "123e4567-e89b-12d3-a456-426614174005",
        "market_id": "123e4567-e89b-12d3-a456-426614174006",
        "market_slug": "ca",
        "country_codes": ["CA"],
        "base_price_amount": 129.99,
        "sale_price_amount": null,
        "reference_price_amount": null,
        "currency": "CAD",
        "on_sale": false,
        "status": "active"
      }
    ]
  }
}

Field Descriptions

Field	Type	Description
`variant_id`	string	Unique identifier for the variant
`product_id`	string	ID of the parent product
`store_group_id`	string	ID of the store group
`store_group_slug`	string	Slug of the store group
`variant_number`	string	Variant number
`markets`	array	Price information for each market

Market Price Fields

Field	Type	Description
`id`	string	Unique identifier for the price record
`market_id`	string	ID of the market
`market_slug`	string	Slug of the market
`country_code`	string	Two-letter ISO country code
`base_price_amount`	number	Regular price amount
`sale_price_amount`	number\|null	Sale price amount (if applicable)
`reference_price_amount`	number\|null	Reference price amount (if applicable)
`currency`	string	Three-letter ISO currency code
`on_sale`	boolean	Whether the variant is currently on sale
`status`	string	Price status (active, inactive)