Skip to main content
WEBHOOK
PRODUCT_UPDATED
{
  "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "webhookId": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "shopId": "sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb",
  "type": "PRODUCT_UPDATED",
  "apiVersion": "V1",
  "createdAt": "2020-08-13T09:05:36.939+00:00",
  "testMode": false,
  "data": {
    "product": {
      "results": [
        {
          "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
          "name": "My t-shirt",
          "slug": "my-t-shirt",
          "description": "My t-shirt description",
          "type": "STANDARD",
          "state": {
            "type": "<string>"
          },
          "access": {
            "type": "<string>"
          },
          "images": [
            {
              "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
              "url": "https://fourthwall.com/image.png",
              "width": 800,
              "height": 600,
              "transformedUrl": "https://fourthwall.com/image.png"
            }
          ],
          "variants": [
            {
              "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
              "name": "My t-shirt - Black, L",
              "sku": "WDEK-DRE200L",
              "unitPrice": {
                "value": 10,
                "currency": "USD"
              },
              "attributes": {
                "description": "Black, L",
                "color": {
                  "name": "Black",
                  "swatch": "#000000"
                },
                "size": {
                  "name": "L"
                }
              },
              "stock": {
                "type": "<string>",
                "inStock": 5
              },
              "weight": {
                "value": 1,
                "unit": "kg"
              },
              "dimensions": {
                "length": 1,
                "width": 2,
                "height": 3,
                "unit": "cm"
              },
              "images": [
                {
                  "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
                  "url": "https://fourthwall.com/image.png",
                  "width": 800,
                  "height": 600,
                  "transformedUrl": "https://fourthwall.com/image.png"
                }
              ],
              "compareAtPrice": {
                "value": 10,
                "currency": "USD"
              },
              "unitCost": {
                "value": 10,
                "currency": "USD"
              },
              "thumbnailImage": {
                "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
                "url": "https://fourthwall.com/image.png",
                "width": 800,
                "height": 600,
                "transformedUrl": "https://fourthwall.com/image.png"
              }
            }
          ],
          "createdAt": "2020-08-13T09:05:36.939Z",
          "updatedAt": "2020-08-13T09:05:36.939Z",
          "thumbnailImage": {
            "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
            "url": "https://fourthwall.com/image.png",
            "width": 800,
            "height": 600,
            "transformedUrl": "https://fourthwall.com/image.png"
          },
          "additionalInformation": {
            "sizeAndFit": "<string>",
            "guaranteeAndReturns": "<string>",
            "moreDetails": "<string>"
          },
          "sizeGuide": {
            "fitGuideUrls": [
              "<string>"
            ],
            "previewUrl": "<string>",
            "fileUrl": "<string>",
            "description": "<string>",
            "fitGuideDescription": "<string>"
          }
        }
      ],
      "total": 123,
      "page": 123,
      "size": 123,
      "totalPages": 123
    }
  }
}

Body

application/json
id
string
required

Unique identifier for this webhook event

Example:

"00aa4abd-5778-4199-8161-0b49b2f212e5"

webhookId
string
required

ID of the webhook configuration that triggered this event

Example:

"00aa4abd-5778-4199-8161-0b49b2f212e5"

shopId
string
required

ID of the shop that generated this event

Example:

"sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb"

type
string
required

The event type

Example:

"PRODUCT_UPDATED"

apiVersion
string
required

API version of the webhook payload

Example:

"V1"

createdAt
string<date-time>
required

When this event was created

Example:

"2020-08-13T09:05:36.939+00:00"

testMode
any
required

Whether this event was sent in test mode

Example:

false

data
Offer Updated · object
required

Response

200

Event received successfully