variant/status_updated

Overview

Property	Value
Webhook type	variant/status_updated
Kafka topic	variant.status-updated
Direction	Platform → Your endpoint

Description

Fired when the status of a variant changes. Variant status controls whether it is available for ordering and fulfillment.

Trigger Conditions

• A variant is published (ACTIVE)
• A variant is archived or disabled
• A variant's status is set to HOLD pending review

Status Values

Status	Description
DRAFT	Newly created, not yet published
ACTIVE	Published and orderable
ARCHIVED	Removed from the active catalog
DISABLED	Temporarily disabled
HOLD	On hold pending review

Message Envelope

{
  "header": {
    "organizationId": "org_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "messageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "webhookId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "type": "variant/status_updated",
    "date": "2024-03-15T10:23:45.000Z"
  },
  "body": { ... }
}

The body field contains the full variant object with the updated status.

Body — Property Table

Variant Object

Field	Type	Nullable	Description
id	string (uuid)	No	Unique variant identifier
organizationId	string (uuid)	No	Organization that owns this variant
productId	string (uuid)	No	Parent product identifier
title	string	Yes	Variant display name
reference	string	No	Internal reference code
sku	string	No	Stock keeping unit
model	enum	No	PRODUCT or BUNDLE
status	enum	Yes	Updated status: DRAFT, ACTIVE, ARCHIVED, DISABLED, HOLD
sourceType	enum	No	CMS or APP
virtualProduct	boolean	No	Virtual product flag
publishedAt	string (ISO 8601)	Yes	Timestamp when published
createdAt	string (ISO 8601)	No	Creation timestamp
updatedAt	string (ISO 8601)	No	Last update timestamp

Full JSON Payload Sample

{
  "header": {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "messageId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "variant/status_updated",
    "date": "2024-03-15T10:23:45.000Z"
  },
  "body": {
    "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "productId": "e5f6a7b8-c9d0-1234-efab-345678901234",
    "title": "Classic White T-Shirt — Size M",
    "description": null,
    "reference": "REF-TSHIRT-WHITE-M",
    "sku": "TSHIRT-WHITE-M",
    "barcode": "3760000000001",
    "model": "PRODUCT",
    "status": "ACTIVE",
    "sourceType": "CMS",
    "sourceId": null,
    "position": 1,
    "virtualProduct": false,
    "price": 25.00,
    "vatRate": 0.20,
    "currency": "EUR",
    "height": 2.0,
    "width": 20.0,
    "length": 30.0,
    "distanceUnit": "CM",
    "weight": 0.25,
    "weightUnit": "KG",
    "volume": null,
    "volumeUnit": null,
    "alcoholRate": null,
    "originCountry": "FR",
    "hsCode": "6109100010",
    "customsValue": "12.00",
    "customsDescription": "Cotton T-shirt",
    "publishedAt": "2024-03-15T10:23:45.000Z",
    "createdAt": "2024-03-15T09:00:00.000Z",
    "updatedAt": "2024-03-15T10:23:45.000Z"
  }
}

Related Events

• variant/updated — also fired when the variant is updated
• product/status_updated — product-level status changes

Notes

• The organizationId is read directly from data.organizationId.
• Both variant/status_updated and variant/updated are fired on status changes.
• publishedAt is set when the variant first transitions to ACTIVE.