Webhooks

Product Events

Event
Description
product-created
Triggers when a new product is created.
product-updated
Triggers when an existing product is updated.
product-removed
Triggers when a product is removed.
product-released
Triggers when a product is made available for sale.
product-expired
Triggers when a product is disabled from being sold.
product-stock-updated
Triggers when the stock of a product is updated.
product-price-updated
Triggers when any of a product's pricing models is updated.
﻿
/
Webhook Payload Examples
﻿
﻿

Event	Description
product-created	Triggers when a new product is created.
product-updated	Triggers when an existing product is updated.
product-removed	Triggers when a product is removed.
product-released	Triggers when a product is made available for sale.
product-expired	Triggers when a product is disabled from being sold.
product-stock-updated	Triggers when the stock of a product is updated.
product-price-updated	Triggers when any of a product's pricing models is updated.

Invoice Events

Shipping Events

Docs powered by Archbee

Webhook Payload Examples

product-created

product-updated

product-removed

product-price-updated

product-stock-updated

product-released

product-expired

{
  "event_id": "whev_o4wpo751jfvy859ko",
  "event_type": "product-created",
  "api_version": 2,
  "endpoint_id": "5dcbcd22-c0e5-4003-8223-e367ce5eb8bf",
  "object": "event",
  "data": {
    "product": {
      "id": "91de2671-199a-459c-a50a-2ad126529a56",
      "object": "product",
      "name": "My Awesome Product",
      "classification": "General",
      "created": "2022-10-22 23:24:43 +0000",
      "created_unix": 1666481083,
      "price": 1200,
      "currency": "EUR",
      "gallery": [],
      "in_stock": true,
      "type": "physical_product",
      "updated": "2022-10-22 23:38:04 +0000",
      "updated_unix": 1666481884,
      "on_sale": true,
      "discount_allowed": true,
      "hide_if_no_stock": true,
      "shown": true,
      "description": null,
      "long_description": null,
      "seo_description": null,
      "seo_title": null,
      "stock": 10,
      "tax_calculation": "exclusive",
      "has_variations": true,
      "unlimited_stock": false,
      "pricing_model": [
        {
          "id": "7a2457d5-f219-4332-b63b-4645cd4b80ae",
          "object": "pricing_model",
          "currency": "EUR",
          "price": 1200,
          "recommended_seller_price": 0,
          "acquisition_price": 0
        }
      ],
      "custom_attributes": null,
      "min_units": null,
      "max_units": null,
      "stock_limit_warning": null,
      "allow_negative_stock": false,
      "related_products": null,
      "additional_information": {
        "sample": false,
        "release_date_unix": null,
        "release_date": null,
        "expiry_date_unix": null,
        "expiry_date": null,
        "new_from_unix": null,
        "new_from": null,
        "new_to_unix": null,
        "new_to": null,
        "exclude_from_feed": false,
        "brand": null,
        "model": null,
        "asin": null,
        "upc": null,
        "mpn": null,
        "isbn": null,
        "ean": null,
        "gtin": null,
        "sku": null,
        "hscode": null
      },
      "languages": {
        "en": {
          "title": "My Awesome Product"
        }
      },
      "packs": [
        {
          "id": "1ec6e373-378c-4655-9d35-23056d753558",
          "label": "Pack of 10",
          "multiples": false,
          "stock": 10,
          "variants": [
            {
              "id": "854e9ede-4e47-4838-924f-8dce1f80b2d8",
              "stock": 10
            }
          ]
        }
      ],
      "weight": null,
      "dimensions": {
        "length": null,
        "width": null,
        "height": null
      },
      "variations": {
        "delta_pricing": true,
        "options": [
          {
            "label": {
              "de": "Größe",
              "en": "Size"
            },
            "type": "dropdown-list",
            "values": [
              {
                "de": "Klein",
                "en": "Large"
              }
            ]
          }
        ],
        "variants": [
          {
            "allow_negative_stock": false,
            "dimensions": {
              "height": 1,
              "length": 1,
              "width": 1
            },
            "gallery": [],
            "hide_if_no_stock": true,
            "id": "854e9ede-4e47-4838-924f-8dce1f80b2d8",
            "options": {
              "en": {
                "Size": "Large"
              },
              "de": {
                "Größe": "Klein"
              }
            },
            "pricing_model": [
              {
                "id": "78805515-8c2b-4fef-b79a-4fe81cd021f2",
                "object": "pricing_model",
                "currency": "EUR",
                "price": 10000,
                "recommended_seller_price": 0,
                "acquisition_price": 0
              }
            ],
            "shown": true,
            "sku": "SKUNUMBER",
            "stock": 10,
            "stock_breakdown": [
              {
                "areas_served": [
                  "au",
                  "ar"
                ],
                "stock": 10,
                "warehouse": "68f5d2ca-0e90-4ed6-9c08-0f0c597b643d"
              }
            ],
            "unlimited_stock": false
          }
        ]
      },
      "is_moss_product": false
    }
  }
}

{
  "event_id": "whev_o4wpo751jfvy859ko",
  "event_type": "product-created",
  "api_version": 2,
  "endpoint_id": "5dcbcd22-c0e5-4003-8223-e367ce5eb8bf",
  "object": "event",
  "data": {
    "product": {
      "id": "91de2671-199a-459c-a50a-2ad126529a56",
      "object": "product",
      "name": "My Awesome Product",
      "classification": "General",
      "created": "2022-10-22 23:24:43 +0000",
      "created_unix": 1666481083,
      "price": 1200,
      "currency": "EUR",
      "gallery": [],
      "in_stock": true,
      "type": "physical_product",
      "updated": "2022-10-22 23:38:04 +0000",
      "updated_unix": 1666481884,
      "on_sale": true,
      "discount_allowed": true,
      "hide_if_no_stock": true,
      "shown": true,
      "description": null,
      "long_description": null,
      "seo_description": null,
      "seo_title": null,
      "stock": 10,
      "tax_calculation": "exclusive",
      "has_variations": true,
      "unlimited_stock": false,
      "pricing_model": [
        {
          "id": "7a2457d5-f219-4332-b63b-4645cd4b80ae",
          "object": "pricing_model",
          "currency": "EUR",
          "price": 1200,
          "recommended_seller_price": 0,
          "acquisition_price": 0
        }
      ],
      "custom_attributes": null,
      "min_units": null,
      "max_units": null,
      "stock_limit_warning": null,
      "allow_negative_stock": false,
      "related_products": null,
      "additional_information": {
        "sample": false,
        "release_date_unix": null,
        "release_date": null,
        "expiry_date_unix": null,
        "expiry_date": null,
        "new_from_unix": null,
        "new_from": null,
        "new_to_unix": null,
        "new_to": null,
        "exclude_from_feed": false,
        "brand": null,
        "model": null,
        "asin": null,
        "upc": null,
        "mpn": null,
        "isbn": null,
        "ean": null,
        "gtin": null,
        "sku": null,
        "hscode": null
      },
      "languages": {
        "en": {
          "title": "My Awesome Product"
        }
      },
      "packs": [
        {
          "id": "1ec6e373-378c-4655-9d35-23056d753558",
          "label": "Pack of 10",
          "multiples": false,
          "stock": 10,
          "variants": [
            {
              "id": "854e9ede-4e47-4838-924f-8dce1f80b2d8",
              "stock": 10
            }
          ]
        }
      ],
      "weight": null,
      "dimensions": {
        "length": null,
        "width": null,
        "height": null
      },
      "variations": {
        "delta_pricing": true,
        "options": [
          {
            "label": {
              "de": "Größe",
              "en": "Size"
            },
            "type": "dropdown-list",
            "values": [
              {
                "de": "Klein",
                "en": "Large"
              }
            ]
          }
        ],
        "variants": [
          {
            "allow_negative_stock": false,
            "dimensions": {
              "height": 1,
              "length": 1,
              "width": 1
            },
            "gallery": [],
            "hide_if_no_stock": true,
            "id": "854e9ede-4e47-4838-924f-8dce1f80b2d8",
            "options": {
              "en": {
                "Size": "Large"
              },
              "de": {
                "Größe": "Klein"
              }
            },
            "pricing_model": [
              {
                "id": "78805515-8c2b-4fef-b79a-4fe81cd021f2",
                "object": "pricing_model",
                "currency": "EUR",
                "price": 10000,
                "recommended_seller_price": 0,
                "acquisition_price": 0
              }
            ],
            "shown": true,
            "sku": "SKUNUMBER",
            "stock": 10,
            "stock_breakdown": [
              {
                "areas_served": [
                  "au",
                  "ar"
                ],
                "stock": 10,
                "warehouse": "68f5d2ca-0e90-4ed6-9c08-0f0c597b643d"
              }
            ],
            "unlimited_stock": false
          }
        ]
      },
      "is_moss_product": false
    }
  }
}