Products update

Webhookproducts/update

Triggered when a product is updated.

Requires the product access scope. Minimum supported version: 202007.

Request headers

X-Shoplazza-Topicstring

The event that triggered this delivery, e.g. orders/create

Example: orders/create

X-Shoplazza-Hmac-Sha256string

Base64-encoded HMAC-SHA256 signature of the request body, generated with your app's Client Secret. Use it to verify the request comes from Shoplazza

X-Shoplazza-Shop-Domainstring

The domain of the store that generated the event

Example: example.myshoplaza.com

X-Shoplazza-Api-Versionstring

The API version used to serialize the payload

Example: 2025-06

X-Shoplazza-Deduplication-IDstring

Deduplication ID for this delivery. It stays the same across retries of the same event—use it for idempotency

Request body

Schema
Example

product object
briefstring
Short product summary
created_atstring
Time when the product was created
descriptionstring
Product description
handlestring
Product handle (URL-friendly alias)
has_only_default_variantboolean
Whether the product has only the default variant (i.e. no multiple variants)
idstring
Product ID
image object
The product's main image
altstring
Image alt text
heightinteger
Image height (in pixels)
pathstring
Image storage path
srcstring
Image URL
watermark_srcstring
Watermarked image URL
watermark_template_idstring
Watermark template ID
widthinteger
Image width (in pixels)
images object[]
List of product images
Array [
altstring
Image alt text
heightinteger
Image height (in pixels)
idstring
Image ID
pathstring
Image storage path
srcstring
Image URL
widthinteger
Image width (in pixels)
]
inventory_policystring
Inventory policy. One of continue (keep selling when out of stock), deny (stop selling when out of stock), or auto_unpublished (auto-unpublish when out of stock); required when inventory_tracking is true
inventory_quantityinteger
Inventory quantity
inventory_trackingboolean
Whether inventory tracking is enabled
meta_descriptionstring
SEO description
meta_keywordstring
SEO keyword list, values separated by commas, e.g. key1,key2
meta_titlestring
SEO title
need_variant_imageboolean
Whether an image must be set for each variant; required when has_only_default_variant is false
notestring
Custom note, e.g. "This is a customizable product"
options object[]
List of product option attributes (such as color or size)
Array [
idstring
Option attribute ID
namestring
Option attribute name, e.g. "color", "size"
positioninteger
Sort position of the option attribute
product_idstring
ID of the product this option belongs to
valuesundefined[]
List of available values for the option attribute, e.g. ["red", "black"], ["small", "large"]
]
publishedboolean
Whether the product is published (listed)
published_atstring
Time when the product was listed
requires_shippingboolean
Whether the product requires shipping
spustring
Product SPU (Standard Product Unit)
tagsstring
Product tag list
taxableboolean
Whether the product is taxable
titlestring
Product name
updated_atstring
Time when the product was last updated
variants object[]
List of product variants
Array [
barcodestring
Barcode
compare_at_pricestring
Compare-at price
cost_pricestring
Cost price
created_atstring
Time when the variant was created
idstring
Variant ID
image object
Variant image
altstring
Image alt text
heightinteger
Image height (in pixels)
pathstring
Image storage path
srcstring
Image URL
watermark_srcstring
Watermarked image URL
watermark_template_idstring
Watermark template ID
widthinteger
Image width (in pixels)
inventory_quantityinteger
Inventory quantity
notestring
Variant note
option1string
The variant's value for the 1st product option
option2string
The variant's value for the 2nd product option
option3string
The variant's value for the 3rd product option
positioninteger
Sort position of the variant within the product
pricestring
Variant selling price
product_idstring
ID of the product this variant belongs to
skustring
SKU
titlestring
Variant title
updated_atstring
Time when the variant was last updated
weightstring
Weight
weight_unitstring
Weight unit. One of kg, g, lb, oz
]
vendorstring
Vendor name
vendor_urlstring
Vendor URL

{
  "product": {
    "brief": "string",
    "created_at": "string",
    "description": "string",
    "handle": "string",
    "has_only_default_variant": true,
    "id": "string",
    "image": {
      "alt": "string",
      "height": 0,
      "path": "string",
      "src": "string",
      "watermark_src": "string",
      "watermark_template_id": "string",
      "width": 0
    },
    "images": [
      {
        "alt": "string",
        "height": 0,
        "id": "string",
        "path": "string",
        "src": "string",
        "width": 0
      }
    ],
    "inventory_policy": "string",
    "inventory_quantity": 0,
    "inventory_tracking": true,
    "meta_description": "string",
    "meta_keyword": "string",
    "meta_title": "string",
    "need_variant_image": true,
    "note": "string",
    "options": [
      {
        "id": "string",
        "name": "string",
        "position": 0,
        "product_id": "string",
        "values": [
          null
        ]
      }
    ],
    "published": true,
    "published_at": "string",
    "requires_shipping": true,
    "spu": "string",
    "tags": "string",
    "taxable": true,
    "title": "string",
    "updated_at": "string",
    "variants": [
      {
        "barcode": "string",
        "compare_at_price": "string",
        "cost_price": "string",
        "created_at": "string",
        "id": "string",
        "image": {
          "alt": "string",
          "height": 0,
          "path": "string",
          "src": "string",
          "watermark_src": "string",
          "watermark_template_id": "string",
          "width": 0
        },
        "inventory_quantity": 0,
        "note": "string",
        "option1": "string",
        "option2": "string",
        "option3": "string",
        "position": 0,
        "price": "string",
        "product_id": "string",
        "sku": "string",
        "title": "string",
        "updated_at": "string",
        "weight": "string",
        "weight_unit": "string"
      }
    ],
    "vendor": "string",
    "vendor_url": "string"
  }
}

Request headers​

Request body​

Request headers

Request body