variant/tag/added

Overview

Property	Value
Webhook type	variant/tag/added
Kafka topic	variant.tag-added
Direction	Platform → Your endpoint

Description

Fired when a tag is added to a variant. Tags are used to classify and filter variants in the catalog.

Trigger Conditions

• A tag is added to a variant via the API

Message Envelope

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

The body field contains the tag object with the parent variant nested.

Note on organizationId resolution: This event uses an organizationIdAccessor pattern — the organizationId is read from data.variant.organizationId.

Body — Property Table

Root Object (VariantTag)

Field	Type	Nullable	Description
id	string (uuid)	No	Unique tag identifier
name	string	No	Tag name
description	string	Yes	Tag description
level	string	No	Tag classification level
variant	Variant	No	The parent variant (see Variant table)
createdAt	string (ISO 8601)	No	Creation timestamp
updatedAt	string (ISO 8601)	No	Last update timestamp

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	DRAFT, ACTIVE, ARCHIVED, DISABLED, HOLD
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/tag/added",
    "date": "2024-03-15T10:23:45.000Z"
  },
  "body": {
    "id": "f7a8b9c0-d1e2-3456-fabc-789012345678",
    "name": "organic",
    "description": "Organically produced items",
    "level": "PRODUCT",
    "createdAt": "2024-03-15T10:23:45.000Z",
    "updatedAt": "2024-03-15T10:23:45.000Z",
    "variant": {
      "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",
      "reference": "REF-TSHIRT-WHITE-M",
      "sku": "TSHIRT-WHITE-M",
      "model": "PRODUCT",
      "status": "ACTIVE",
      "createdAt": "2024-03-15T09:00:00.000Z",
      "updatedAt": "2024-03-15T10:23:45.000Z"
    }
  }
}

Related Events

• variant/tag/removed — fired when a tag is removed from a variant

Notes

• This event uses organizationIdAccessor: (data) => data.variant.organizationId.
• Tags can be used for catalog filtering, reporting, and WMS routing rules.