Product Stock Update Webhook

Triggered when a product's stock updated.

Event Name

product.stock.update

Payload Example

{
  "event": "product.stock.update",
  "created_at": "2026-07-13T22:44:23+03:00",
  "data": {
    "product": {
      "id": 230,
      "identifier": 230,
      "slug": "nike-sports-ssshoe-01",
      "name": {
        "ar": "حذاء رياضي نايك",
        "en": "Nike Sports Shoe"
      },
      "summary": {
        "ar": "حذاء رياضي مريح وأنيق",
        "en": "Comfortable and stylish sports shoe"
      },
      "description": {
        "ar": "<p>وصف تفصيلي للحذاء الرياضي بمواد عالية الجودة</p>",
        "en": "<p>Detailed description of the sports shoe with high quality materials</p>"
      },
      "type": "physical",
      "type_id": 1,
      "price": 79.99,
      "sale_price": 49.99,
      "is_refundable": true,
      "min_purchase": 1,
      "max_purchase": 5,
      "image": "https://example.com/assets/img/no-image.jpg",
      "is_published": true,
      "stock": 120,
      "is_unlimited": false,
      "ratings": null,
      "video": {
        "video_source": "youtube",
        "video_id": "dQw4w9WgXcQ",
        "video": "dQw4w9WgXcQ"
      },
      "created_at": "2026-06-29 15:37:53",
      "updated_at": "2026-06-29 15:37:53",
      "product_options": [
        {
          "type": "number",
          "title": { "ar": "المقاس", "en": "Size" },
          "sub_title": { "ar": "", "en": "" },
          "options": null,
          "is_required": false,
          "multi_select": false
        }
      ],
      "brand": {
        "id": 1,
        "title": "",
        "name": { "ar": "Brand A", "en": "Brand A" },
        "description": { "ar": "Brand A", "en": "Brand A" },
        "logo": "https://example.com/assets/img/no-image.jpg",
        "banner": "https://example.com/assets/img/no-image.jpg"
      },
      "badge": {
        "id": 2,
        "name": "اكثر مبيعآ",
        "image": "https://example.com/assets/img/no-image.jpg"
      },
      "tags": [
        { "id": 603, "tag_name": "Nike" },
        { "id": 604, "tag_name": "Sports" },
        { "id": 605, "tag_name": "Shoes" },
        { "id": 606, "tag_name": "Running" }
      ],
      "categories": [
        {
          "id": 1,
          "name": { "ar": "Elektronik", "en": "Elektronik" },
          "description": { "ar": "Elektronik", "en": "Elektronik" },
          "image": "https://example.com/assets/img/no-image.jpg"
        },
        {
          "id": 1,
          "name": { "ar": "Elektronik", "en": "Elektronik" },
          "description": { "ar": "Elektronik", "en": "Elektronik" },
          "image": "https://example.com/assets/img/no-image.jpg"
        }
      ],
      "sub_categories": [
        {
          "id": 1,
          "name": { "ar": "Ebook", "en": "Ebook" },
          "description": { "ar": "Ebook", "en": "Ebook" },
          "image": "https://example.com/assets/img/no-image.jpg"
        },
        {
          "id": 2,
          "name": { "ar": "Video Tutorial", "en": "Video Tutorial" },
          "description": { "ar": "", "en": "" },
          "image": "https://example.com/assets/img/no-image.jpg"
        }
      ],
      "child_categories": [
        {
          "id": 1,
          "name": { "ar": "Pengetahuan Umum", "en": "Pengetahuan Umum" },
          "description": "",
          "image": "https://example.com/assets/img/no-image.jpg"
        }
      ],
      "inventory": {
        "id": 217,
        "sku": "NIKE-SHOssE-01",
        "stock_count": 120,
        "sold_count": 0,
        "inventory_details": [
          {
            "id": 341,
            "color": { "id": 1, "code": "#ff3838", "name": { "ar": "Red", "en": "Red" } },
            "size": null,
            "image": "https://example.com/assets/img/no-image.jpg",
            "additional_price": 0,
            "additional_cost": 0,
            "stock_count": 30,
            "sold_count": 0,
            "attributes": [
              { "id": 661, "name": "Material", "value": "Leather" },
              { "id": 662, "name": "Season", "value": "Summer" }
            ]
          },
          {
            "id": 342,
            "color": { "id": 4, "code": "#ffffff", "name": { "ar": "White", "en": "White" } },
            "size": null,
            "image": "https://example.com/assets/img/no-image.jpg",
            "additional_price": 5,
            "additional_cost": 2,
            "stock_count": 25,
            "sold_count": 0,
            "attributes": [
              { "id": 663, "name": "Material", "value": "Leather" },
              { "id": 664, "name": "Season", "value": "Summer" }
            ]
          },
          {
            "id": 343,
            "color": { "id": 5, "code": "#0984e3", "name": { "ar": "Blue", "en": "Blue" } },
            "size": null,
            "image": "https://example.com/assets/img/no-image.jpg",
            "additional_price": 0,
            "additional_cost": 0,
            "stock_count": 40,
            "sold_count": 0,
            "attributes": [
              { "id": 665, "name": "Material", "value": "Mesh" },
              { "id": 666, "name": "Season", "value": "Summer" }
            ]
          },
          {
            "id": 344,
            "color": { "id": 5, "code": "#0984e3", "name": { "ar": "Blue", "en": "Blue" } },
            "size": null,
            "image": "https://example.com/assets/img/no-image.jpg",
            "additional_price": 5,
            "additional_cost": 2,
            "stock_count": 35,
            "sold_count": 0,
            "attributes": [
              { "id": 667, "name": "Material", "value": "Mesh" },
              { "id": 668, "name": "Season", "value": "Summer" }
            ]
          }
        ]
      },
      "delivery_options": [
        {
          "id": 1,
          "icon": "las la-gift",
          "title": { "ar": "التسليم المقدر", "en": "التسليم المقدر" },
          "sub_title": { "ar": "خلال 4 أيام", "en": "خلال 4 أيام" }
        },
        {
          "id": 2,
          "icon": "las la-gift",
          "title": { "ar": "الشحن مجاني", "en": "الشحن مجاني" },
          "sub_title": { "ar": "عند الطلب بأكثر من 100 ريال", "en": "عند الطلب بأكثر من 100 ريال" }
        }
      ],
      "return_policy": {
        "id": 145,
        "shipping_return_description": "Return within 30 days with original packaging"
      },
      "gallery": [
        { "image": "https://example.com/assets/img/no-image.jpg" },
        { "image": "https://example.com/assets/img/no-image.jpg" },
        { "image": "https://example.com/assets/img/no-image.jpg" },
        { "image": "https://example.com/assets/img/no-image.jpg" }
      ],
      "meta_data": {
        "id": 222,
        "title": "Nike Sports Shoe | Best Price",
        "description": "Buy the best Nike sports shoes at unbeatable prices",
        "image": "https://example.com/assets/img/no-image.jpg",
        "fb_title": "Nike Sports Shoe — Great Deal",
        "fb_description": "Premium Nike sports shoes at the best prices. Shop now!",
        "fb_image": "https://example.com/assets/img/no-image.jpg",
        "tw_title": "Nike Sports Shoe",
        "tw_description": "Get your Nike sports shoes today at amazing prices!",
        "tw_image": "https://example.com/assets/img/no-image.jpg"
      },
      "digital_meta_data": null,
      "booking_meta_data": null,
      "service_meta_data": null,
      "uom": {
        "id": 83,
        "product_id": 230,
        "unit_id": 1,
        "unit": { "id": 1, "name": "Kg" },
        "uom": 10,
        "length": 30,
        "width": 12,
        "height": 10
      }
    }
  }
}

Payload Schema

Root Object

Field	Type	Description
event	string	Webhook event name
created_at	datetime	Event creation timestamp
data	object	Event payload

Product Object

Field	Type	Description
id	integer	Product ID
identifier	integer	Product identifier
slug	string	URL slug
name	object	Localized name (`ar`, `en`)
summary	object	Localized short summary (`ar`, `en`)
description	object	Localized full description (HTML, `ar`, `en`)
type	string	Product type (e.g. `physical`, `digital`)
type_id	integer	Numeric product type code
price	decimal	Regular price
sale_price	decimal	Discounted/sale price
is_refundable	boolean	Whether product supports refunds
min_purchase	integer	Minimum purchasable quantity
max_purchase	integer	Maximum purchasable quantity
image	string	Product image URL
is_published	boolean	Publish status
stock	integer	Current stock count
is_unlimited	boolean	Whether stock is unlimited
ratings	object\|null	Product rating summary, if available
video	object\|null	`{video_source, video_id, video}`
created_at	datetime	Product creation date
updated_at	datetime	Last product update date
product_options	array	Configurable options for the product
brand	object	Product brand
badge	object	Product badge
tags	array	Product tags, each `{id, tag_name}`
categories	array	Product categories
sub_categories	array	Product subcategories
child_categories	array	Product child categories
inventory	object	Inventory details (see below)
delivery_options	array	Delivery option messages
return_policy	object	Return policy details
gallery	array	Product gallery images, each `{image}`
meta_data	object	SEO/social meta data
digital_meta_data	object\|null	Digital product metadata, if applicable
booking_meta_data	object\|null	Booking product metadata, if applicable
service_meta_data	object\|null	Service product metadata, if applicable
uom	object	Unit of measure / dimensions

Product Option Object

Field	Type	Description
type	string	Input type (`text`, `number`, `textarea`, `checkbox`, `radio`)
title	object	Localized title (`ar`, `en`)
sub_title	object	Localized subtitle (`ar`, `en`)
options	object\|null	Selectable choices with cost, keyed by locale then label
is_required	boolean	Whether the option is required
multi_select	boolean	Whether multiple selections are allowed

Brand Object

Field	Type	Description
id	integer	Brand ID
title	string	Brand title
name	object	Localized name (`ar`, `en`)
description	object	Localized description (`ar`, `en`)
logo	string	Brand logo URL
banner	string	Brand banner URL

Badge Object

Field	Type	Description
id	integer	Badge ID
name	string	Badge name
image	string	Badge image URL

Tag Object

Field	Type
id	integer
tag_name	string

Category / Sub-category / Child-category Object

Field	Type	Description
id	integer	Category ID
name	object	Localized name (`ar`, `en`)
description	object\|string	Localized description (`ar`, `en`)
image	string	Category image URL

Inventory Object

Field	Type	Description
id	integer	Inventory record ID
sku	string	Stock keeping unit
stock_count	integer	Total units in stock
sold_count	integer	Total units sold
inventory_details	array	Per-variant stock breakdown (see below)

Inventory Detail Object (`inventory_details[]`)

Field	Type	Description
id	integer	Inventory detail ID
color	object\|null	`{id, code, name}` variant color
size	object\|null	Variant size, if applicable
image	string	Variant image URL
additional_price	decimal	Extra price for this variant
additional_cost	decimal	Extra cost for this variant
stock_count	integer	Stock count for this variant
sold_count	integer	Sold count for this variant
attributes	array	Variant attributes, each `{id, name, value}`

Delivery Option Object

Field	Type	Description
id	integer	Delivery option ID
icon	string	Icon class
title	object	Localized title (`ar`, `en`)
sub_title	object	Localized subtitle (`ar`, `en`)

Return Policy Object

Field	Type	Description
id	integer	Return policy ID
shipping_return_description	string	Return policy description text

Meta Data Object

Field	Type	Description
id	integer	Meta data record ID
title	string	SEO title
description	string	SEO description
image	string	SEO image URL
fb_title	string	Facebook share title
fb_description	string	Facebook share description
fb_image	string	Facebook share image URL
tw_title	string	Twitter share title
tw_description	string	Twitter share description
tw_image	string	Twitter share image URL

UOM Object

Field	Type	Description
id	integer	UOM record ID
product_id	integer	Related product ID
unit_id	integer	Unit ID
unit	object	`{id, name}` unit info
uom	decimal	Weight/measure value
length	decimal	Product length
width	decimal	Product width
height	decimal	Product height

Response

Your endpoint should return:

Product Stock Update

Product Stock Update Webhook#

Event Name#

Payload Example#

Payload Schema#

Root Object#

Product Object#

Product Option Object#

Brand Object#

Badge Object#

Tag Object#

Category / Sub-category / Child-category Object#

Inventory Object#

Inventory Detail Object (inventory_details[])#

Delivery Option Object#

Return Policy Object#

Meta Data Object#

UOM Object#

Response#

Product Stock Update Webhook

Event Name

Payload Example

Payload Schema

Root Object

Product Object

Product Option Object

Brand Object

Badge Object

Tag Object

Category / Sub-category / Child-category Object

Inventory Object

Inventory Detail Object (`inventory_details[]`)

Delivery Option Object

Return Policy Object

Meta Data Object

UOM Object

Response