Supported Webhook Events

Events Topics Response Example
Collection collections/create,
collections/update
{
  "collection": {
    "id": "0097cfc8-6ec3-40ed-ab9f-6f2231b705a6",
    "title": "Collection",
    "handle": "Collection
",
    "description": "",
    "meta_title": "xxx",
    "meta_description": "xxx",
    "meta_keyword": "tag1,tag2,tag3",
    "image": {
      "src": "https://cdn.shoplazza.com/example.png",
      "width": 480,
      "height": 360,
      "alt": "Image"
    },
    "sort_order": "alpha-asc",
    "created_at": "2018-10-31T13:02:19-04:00",
    "updated_at": "2018-10-31T13:02:19-04:00"
  }
}
collections/delete

{ "collection": { "id": "0097cfc8-6ec3-40ed-ab9f-6f2231b705a6" } }

Product products/create,
products/update
{
  "product":{
    "id":"0510dace-34da-4555-a896-495e0cb1ed6e",
    "title":"title1",
    "brief": "title2",
    "description": "product desc",
    "vendor": "vendor 01",
    "vendor_url": "http://www.baidu.com",
    "has_only_default_variant":true,
    "requires_shipping": true,
    "taxable": true,
    "inventory_tracking": true,
    "inventory_policy": "inventory policy 1",
    "inventory_quantity": 100,
    "published": true,
    "published_at": "2019-10-01 10:00:00 xxxx",
    "created_at": "2019-10-01 10:00:00 xxxx",
    "updated_at": "2019-10-01 10:00:00 xxxx",
    "note": "xxx",
    "meta_title": "xxx",
    "meta_description": "xxx",
    "meta_keyword": "tag1,tag2,tag3",
    "handle": "title1",
    "need_variant_image": true,
    "image": {
      "src":"https://oss.ali.com/abc.jpg",
      "width":100,
      "height":100,
      "alt":""
    },
    "images": [
      {
        "id": "0510dace-34da-4555-a896-495e0cb1ed6e",
        "product_id": "123456",
        "position": 1,
        "src": "https://cdn.shoplazza.com/example.png",
        "width": 480,
        "height": 360,
        "alt": "Image",
        "created_at": "2018-10-31T13:02:19-04:00",
        "updated_at": "2018-10-31T13:02:19-04:00"
      }
    ],
    "options":[
      {
        "id":"0510dace-34da-4555-a896-495e0cb1ed6e",
        "product_id": "123456",
        "name":"color",
        "position":1,
        "values": ["red", "black"]
      },
      {
        "id":"0510dace-34da-4555-a896-495e0cb1kkd8",
        "product_id": "123456",
        "name":"size",
        "position":2,
        "values":["32", "33"]
      }
    ],
    "variants":[
      {
        "id":"0510dace-34da-4555-a896-495e0cb1ed6e",
        "product_id": "123456",
        "position":1,
        "title":"variants title",
        "image":{
          "src":"https://oss.ali.com/abc.jpg",
          "width":100,
          "height":100,
          "alt":""
        },
        "price": 32,
        "compare_at_price": 45,
        "weight": 0.1,
        "weight_unit":"kg",
        "inventory_quantity": 33,
        "sku": "20182002154567873574",
        "barcode": "201213112",
        "note": "xxx",
        "option1": "red",
        "option2": "M",
        "option3": "",
        "created_at": "2018-10-31T13:02:19-04:00",
        "updated_at": "2018-10-31T13:02:19-04:00"
      }
    ]
  }
}
products/delete
{
  "product": {
    "id": "0510dace-34da-4555-a896-495e0cb1ed6e"
  }
}
Order orders/cancelled,
orders/create,
orders/fulfilled,
orders/finished,
orders/paid,
orders/partially_fulfilled,
orders/refunded,
orders/update
{
  "order":{
    "id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
    "created_at": "2014-04-25T16:15:47-04:00",
    "updated_at": "2014-04-25T16:15:47-04:00",
    "note": "abc",
    "number": "ASD01245",
    "total_price": "16.99",
    "sub_total": "15.00",
    "currency": "USD",
    "financial_status": "waiting",
    "status": "opened",
    "canceled_at": null,
    "cancel_reason": null,
    "payment_method": "online",
    "fulfillment_status": "waiting",
    "customer_deleted_at": "2014-04-25T16:15:47-04:00",
    "deleted_at": "2014-04-25T16:15:47-04:00",
    "placed_at": "2014-04-25T16:15:47-04:00",
    "tags": "a, b",
    "discount_code": "",
    "buyer_accepts_marketing": false,
    "code_discount_total": "1.00",
    "line_item_discount_total": "1.00",
    "customer_note": "note",
    "total_discount": "100.00",
    "total_tax": "10.00",
    "total_shipping": "1.00",
    "line_items": [
      {
        "id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
        "product_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
        "product_title": "abc",
        "variant_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
        "variant_title": "XXX",
        "quantity": 10,
        "note": "red",
        "image": "http://www.a.com/xxx.jpg",
        "price": 12.34,
        "compare_at_price": 12.34,
        "total": "12.34 USD",
        "fulfillment_status": "waiting",
        "sku": "xxx",
        "weight": 1.23,
        "weight_unit": "g",
        "vendor": "XXX",
        "product_handle": "abc",
        "product_url": "http://www.a.com/abc",
        "properties": [
          {
            "name": "color",
            "value": "red"
          }
        ]
      }
    ],
    "shipping_line": {
      "name": "free"
    },
    "billing_address": {
      "first_name": "Bob",
      "last_name": "Norman",
      "address1": "Chestnut Street 92",
      "address2": "",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY",
      "email": "[email protected]",
      "area": "sz"
    },
    "shipping_address": {
      "first_name": "Bob",
      "last_name": "Norman",
      "address1": "Chestnut Street 92",
      "address2": "",
      "phone": "555-625-1199",
      "city": "Louisville",
      "zip": "40202",
      "province": "Kentucky",
      "country": "United States",
      "company": null,
      "latitude": 45.41634,
      "longitude": -75.6868,
      "name": "Bob Norman",
      "country_code": "US",
      "province_code": "KY",
      "phone_area_code": "80",
      "area": "sz",
      "email": "[email protected]"
    },
    "fulfillments": [
      {
        "id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
        "order_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
        "status": "waiting",
        "created_at": "2018-11-02T12:30:10-04:00",
        "updated_at": "2018-11-02T12:30:10-04:00",
        "tracking_company": null,
        "tracking_number": "1Z2345",
        "tracking_company_code": "3306",
        "line_items": [
          {
            "id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
            "product_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
            "product_title": "abc",
            "variant_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
            "variant_title": "XXX",
            "quantity": 10,
            "note": "red",
            "image": "http://www.a.com/xxx.jpg",
            "price": 12.34,
            "compare_at_price": 12.34,
            "total": "12.34 USD",
            "fulfillment_status": "waiting",
            "sku": "xxx",
            "weight": 1.23,
            "weight_unit": "g",
            "vendor": "XXX",
            "product_handle": "abc",
            "product_url": "http://www.a.com/abc",
            "properties": [
              {
                "name": "color",
                "value": "red"
              },
              {
                "name": "color",
                "value": "red"
              }
            ]
          }
        ]
      }
    ],
    "customer":{
      "email": "[email protected]",
      "created_at": "2018-11-02T12:30:10-04:00",
      "updated_at": "2018-11-02T12:30:10-04:00",
      "first_name": "Bob",
      "last_name": "Norman",
      "orders_count": 1,
      "total_spent": "41.94",
      "phone": "",
    }
  }
}
orders/delete
{
  "order": {
    "id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5"
  }
}
Fulfillment fulfillments/create,
fulfillments/update
{
  "fulfillment": {
    "id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
    "order_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
    "status": "waiting",
    "created_at": "2018-11-02T12:30:10-04:00",
    "updated_at": "2018-11-02T12:30:10-04:00",
    "tracking_company": "",
    "tracking_number": "1Z2345",
    "tracking_company_code": "3306",
    "line_items": [
      {
        "id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
        "product_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
        "product_title": "abc",
        "variant_id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5",
        "variant_title": "XXX",
        "quantity": 10,
        "note": "red",
        "image": "http://www.a.com/xxx.jpg",
        "price": 12.34,
        "compare_at_price": 12.34,
        "total": "12.34 USD",
        "fulfillment_status": "waiting",
        "sku": "xxx",
        "weight": 1.23,
        "weight_unit": "g",
        "vendor": "XXX",
        "product_handle": "abc",
        "product_url": "http://www.a.com/abc",
        "properties": [
          {
            "name": "color",
            "value": "red"
          },
          {
            "name": "color",
            "value": "red"
          }
        ]
      }
    ]
  }
}
Customer customers/create,
customers/update
{
  "customer": {
    "id":"1dfa86e9-f3f4-4684-8eb6-05399ef19705",
    "first_name":"Lee",
    "last_name":"Le",
    "name":"Lee Le",
    "email":"[email protected]",
    "phone":"15323233434",
    "phone_area_code": "+86",
    "accepts_marketing":false,
    "orders_count": 10,
    "total_spent": "100.10",
    "tags": "",
    "created_at": "2018-10-23T15:29:24-04:00",
    "updated_at": "2018-10-23T15:29:24-04:00",
    "default_address": {
      "id": "2ffa86e9-f3f4-4684-84b6-05399ef19709",
      "customer_id": "1dfa86e9-f3f4-4684-8eb6-05399ef19705",
      "first_name": null,
      "last_name": null,
      "company": null,
      "address1": "Chestnut Street 92",
      "address2": "",
      "city": "Louisville",
      "province": "Kentucky",
      "country": "United States",
      "zip": "40202",
      "phone": "555-625-1199",
      "phone_area_code": "+86",
      "name": "",
      "province_code": "KY",
      "country_code": "US",
      "country_name": "United States",
      "default": true
    },
    "addresses": [
      {
        "id": "2ffa86e9-f3f4-4684-84b6-05399ef19709",
        "customer_id": "1dfa86e9-f3f4-4684-8eb6-05399ef19705",
        "first_name": null,
        "last_name": null,
        "company": null,
        "address1": "Chestnut Street 92",
        "address2": "",
        "city": "Louisville",
        "province": "Kentucky",
        "country": "United States",
        "zip": "40202",
        "phone": "555-625-1199",
        "phone_area_code": "+86",
        "name": "",
        "province_code": "KY",
        "country_code": "US",
        "country_name": "United States",
        "default": true
      }
    ]
  }
}
customers/delete
{
  "customer": {
    "id": "1dfa86e9-f3f4-4684-8eb6-05399ef19705"
  }
}
Store app/uninstalled ,
app/expired
{
    "app": {
        "id": 1,
        "name": "enquiry",
        "uid": "yAQSUe8l3hT8YFHNAZBIAnQ58HAWZ9FEf5ofELvLE0s",
        "redirect_uri": "https://enquiry.apps.shoplazza.com/callback/shoplazza/oauth",
        "scopes": "read_script_tags write_script_tags read_shop",
        "icon": "/oss/operation/9ea4e43d0be77b367d3a6f403d10b6e3.svg",
        "webhook_api_version": "2020-01",
        "created_at": "2020-01-15T02:33:27Z",
        "updated_at": "2020-01-15T02:33:27Z"
    }
}