product/created
Overview
| Property | Value |
|---|---|
| Webhook type | product/created |
| Kafka topic | product.created |
| Direction | Platform → Your endpoint |
Description
Fired when a new product is created in the catalog. A product is the parent entity that groups one or more variants.
Trigger Conditions
- A product is created via the HappyColis GraphQL API
- A product is imported from a third-party application (e.g., Shopify)
modelwill bePRODUCTfor standard products orBUNDLEfor bundle products
Message Envelope
json
{
"header": {
"organizationId": "org_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"messageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"webhookId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "product/created",
"date": "2024-03-15T10:23:45.000Z"
},
"body": { ... }
}The body field contains the full product object.
Body — Property Table
Product Object
| Field | Type | Nullable | Description |
|---|---|---|---|
id | string (uuid) | No | Unique product identifier |
organizationId | string (uuid) | No | Organization that owns this product |
title | string | Yes | Product display name |
description | string | Yes | Product description text |
slug | string | Yes | URL-friendly identifier (unique per organization) |
status | enum | Yes | Product status: DRAFT, ACTIVE, ARCHIVED, DISABLED, HOLD |
scope | enum | No | Visibility scope: GLOBAL or LOCAL |
model | enum | No | Product model: PRODUCT or BUNDLE |
fragile | boolean | No | Whether the product requires fragile handling (default false) |
suspended | boolean | No | Whether the product is suspended from catalog (default false) |
heatSensitive | boolean | No | Whether the product requires cold-chain handling (default false) |
parcels | integer | No | Number of parcels required to ship this product (default 1) |
price | float | Yes | Base price (tax-exclusive) |
vatRate | float | Yes | VAT rate as decimal (e.g., 0.20 for 20%) |
currency | string | Yes | ISO 4217 currency code |
supplierId | string (uuid) | Yes | Supplier identifier |
vendorId | string (uuid) | Yes | Vendor identifier |
preparationProfileId | string (uuid) | Yes | Preparation profile for warehouse handling |
createdAt | string (ISO 8601) | No | Creation timestamp |
updatedAt | string (ISO 8601) | No | Last update timestamp |
Full JSON Payload Sample
json
{
"header": {
"organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"messageId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"type": "product/created",
"date": "2024-03-15T10:23:45.000Z"
},
"body": {
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"title": "Classic White T-Shirt",
"description": "100% cotton unisex t-shirt, available in multiple sizes.",
"slug": "classic-white-t-shirt",
"status": "ACTIVE",
"scope": "GLOBAL",
"model": "PRODUCT",
"fragile": false,
"suspended": false,
"heatSensitive": false,
"parcels": 1,
"price": 25.00,
"vatRate": 0.20,
"currency": "EUR",
"supplierId": null,
"vendorId": "e5f6a7b8-c9d0-1234-efab-345678901234",
"preparationProfileId": null,
"createdAt": "2024-03-15T10:23:45.000Z",
"updatedAt": "2024-03-15T10:23:45.000Z"
}
}Related Events
product/updated— fired when any product field changesproduct/status_updated— fired when the product status transitionsvariant/created— fired when a variant is added to this product
Notes
- The
organizationIdis read directly fromdata.organizationId. - The
bodydoes not includevariants— variant data is delivered via separatevariant/*events. slugis unique per organization and used for catalog URL routing.