Supported Webhook Events

Topic	Trigger Timing	Minimum Supported Version	Response Example
products/create	Triggered when a product is created	202007	{ "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/update	Triggered when a product is updated	202007
products/delete	Triggered when a product is deleted	202007	{ "product": { "id": "0510dace-34da-4555-a896-495e0cb1ed6e" } }
orders/create	Triggered when an order is created	202007	{ "order": { "id": "124791144633646482197", "note": null, "number": "5555MJK026409999", "financial_status": "waiting", "status": "opened", "cancel_reason": null, "payment_method": "none", "fulfillment_status": "initialled", "discount_code": "", "discount_applications": "[{\"type\":\"cycle_subscribe\",\"subtype\":\"\",\"title\":\"Subscription\",\"discount_amount\":3.33,\"discount_amount_value\":\"\",\"message\":\"\",\"discount_message\":\"\",\"discount_id\":\"388592557195531383\",\"value_type\":\"\",\"target_type\":\"line_item\",\"apply_method\":\"\",\"target_selection\":\"\",\"entitled_product_list\":null,\"properties\":null,\"discount_text\":\"\",\"is_free_gift\":false}]", "customer_note": "", "buyer_accepts_marketing": false, "currency": "USD", "tags": "", "sub_total": "111.00", "total_discount": "3.33", "total_tax": "0.00", "total_shipping": "5.99", "total_price": "113.66", "code_discount_total": "0.00", "line_item_discount_total": "0.00", "total_tip_received": "0.00", "created_at": "2024-07-20T00:00:46Z", "updated_at": "2024-07-20T00:00:46Z", "canceled_at": null, "customer_deleted_at": null, "deleted_at": null, "placed_at": null, "shipping_line": { "name": "Standard Shipping", "desc": "", "delivery_method": 1, "extra_info": "{\"id\":\"bb2ca1a1-d836-468f-a67f-5b563de32c14\",\"name\":\"Standard Shipping\",\"desc\":\"\",\"support_cod\":1,\"shipping_price\":\"5.99\",\"delivery_method\":1,\"location_id\":\"0\"}" }, "customer": { "id": "c8d19714-4aa1-4cce-a8b0-bc4e9de6c91d", "first_name": "夜露死苦", "last_name": "林", "email": "[email protected]", "phone": "+8613111111111", "created_at": "2024-06-05T06:11:22Z", "updated_at": "2024-06-06T07:11:28Z", "order_count": 24, "total_spent": "3798.76" }, "shipping_address": { "first_name": "123", "last_name": "321", "address1": "www", "address2": "eee", "phone": "+8613111111111", "city": "南宁", "zip": "123456", "province": "Guangxi", "country": "China", "company": "", "latitude": null, "longitude": null, "name": "123 321", "country_code": "CN", "province_code": "CN-GX", "email": "[email protected]", "phone_area_code": "CN_86", "area": "", "extra_info": { "addition": { "124791_key_2": { "name": "golden", "val": "123" }, "124791_key_3": { "name": "ku", "val": "2" } }, "cpf": "22", "tax_text": "Tax ID" } }, "billing_address": { "first_name": "123", "last_name": "321", "address1": "www", "address2": "eee", "phone": "+8613111111111", "city": "南宁", "zip": "123456", "province": "Guangxi", "country": "China", "company": "", "latitude": null, "longitude": null, "name": "123 321", "country_code": "CN", "province_code": "CN-GX", "email": "[email protected]", "area": "" }, "payment_line": null, "payment_lines": [], "browser_ip": "10.8.74.137", "landing_site": "", "line_items": [ { "id": "92d87800-1db4-4f69-9629-3e2eb99f0388", "product_id": "9cba2a5a-5a32-4dfa-9135-06d7cbe300e9", "variant_id": "a76de694-1b62-47b4-8774-2455ad89104f", "variant_title": "", "product_title": "周期购踢商品猫", "product_handle": "周期购踢商品猫", "quantity": 1, "note": "", "fulfillment_status": "waiting", "sku": "", "weight_unit": "kg", "vendor": "", "product_url": "/products/周期购踢商品猫", "price": "111.00", "compare_at_price": "111.00", "total": "111.00", "weight": "0.00", "image": "//img.staticdj.com/free/ca2c63875af0cb7cca65ce338c8cbe13.jpg", "properties": [], "custom_properties": { "_shoplazza_product_extends": "{\"custom_discounts\":[{\"name\":\"Subscription\",\"fixed_type\":\"fixed_percentage\",\"fixed_value\":\"3\",\"type\":\"cycle_subscribe_discount\",\"count\":11,\"discount_id\":\"388592557195531383\",\"business_custom_data\":\"\"}]}" }, "main_currency_prices": { "compare_at_price": "111", "price": "111", "total": "111", "actual_rate": "1" }, "discount_applications": "[{\"type\":\"cycle_subscribe\",\"subtype\":\"\",\"discount_id\":\"388592557195531383\",\"title\":\"Subscription\",\"value\":\"\",\"discount_type\":\"\",\"value_type\":\"\",\"allocation_method\":\"\",\"target_selection\":\"\",\"target_type\":\"line_item\",\"total_discount_amount\":\"3.33\",\"discount_amount\":\"3.33\",\"is_free_gift\":false,\"discount_quantity\":1,\"is_need_split\":false,\"discount_text\":\"\"}]" } ], "fulfillments": [], "test": false, "closed_at": null, "total_paid": null, "real_total_paid": null, "last_landing_url": "", "applied_gift_cards": "[]", "main_currency_prices": { "sub_total": "111", "total_discount": "3.33", "total_tax": "0", "total_shipping": "5.99", "total_price": "113.66", "actual_rate": "1", "primary_market_currency": "USD" }, "sales_platform": "shoplazza", "order_type": 0, "shipping_tax_total": "0.00", "shipping_tax_type": 0, "location_line": { "location_id": "362080656559179781", "location_name": "亚洲仓库", "first_name": "T_T", "last_name": "huang", "phone": "13566668888", "email": "[email protected]", "country": "中国大陆", "country_code": "CN", "province": "广东省", "province_code": "CN-GD", "area": "深圳市", "city": "深圳市", "address": "彩讯科技大厦", "address1": "27", "company": "shoplazza", "latitude": "22.53", "longitude": "113.95", "zip": "518063" }, "product_tax_included": false, "additional_total": "0.00", "checkout_url": "/checkout/124791144633646482197?key=3f3655b07ecbb67db51bd124e1d52f", "refer_info": "{\"address_check\":false,\"country\":\"\",\"customer_session\":\"\",\"domain\":\"\",\"fbc\":\"\",\"fbp\":\"\",\"inventory_deduction\":\"order_created\",\"ip\":\"10.8.74.137\",\"source\":\"buy_now\",\"user_agent\":\"grpc-go/1.57.2\"}", "config": "{\"page_type\":\"three_step\",\"requires_shipping\":true,\"checkout_business_type\":0,\"product_tax_included\":false,\"checkout_template_type\":0,\"market_setting\":{\"primary_market_lang\":\"en-US\",\"market_lang\":\"en-US\",\"market_id\":\"326199623930618487\",\"market_currency\":\"USD\",\"market_currency_symbol\":{\"code\":\"USD\",\"val\":\"$\",\"left\":\"$\",\"right\":\"\"},\"market_base_currency\":\"USD\",\"market_base_currency_symbol\":{\"code\":\"USD\",\"val\":\"$\",\"left\":\"$\",\"right\":\"\"},\"primary_market_id\":\"326199623930618487\",\"primary_market_currency\":\"USD\",\"primary_market_currency_symbol\":{\"code\":\"USD\",\"val\":\"$\",\"left\":\"$\",\"right\":\"\"},\"market_price_setting\":{\"local_currency_enabled\":false,\"custom_rate_enabled\":false,\"custom_rate\":0,\"rate\":1,\"back_rate\":1,\"actual_rate\":1,\"base_to_local\":0,\"local_to_base\":0,\"adjust\":0,\"price_round_enabled\":true}}}" } }
orders/update	Triggered for any update to the order information	202007
orders/paid	Triggered when an order is successfully placed (except for COD, which represents successful payment)	202007
orders/partially_fulfilled	Triggered each time an item is shipped, but not all items are shipped	202007
orders/fulfilled	Triggered after all items in an order are shipped	202007
orders/finished	Triggered when a paid order enters the after-sales process Triggered when all items are received Triggered when all refunds and returns are completed Triggered when the order is fully refunded and all items are also returned (returning orders and returning products are two options in the refund process)	202007
orders/partially_refunded	Triggered each time a refund is made, and it is determined that the order amount has not been fully refunded	202007
orders/refunded	Triggered when the full amount is refunded	202007
orders/cancelled	Triggered when an incomplete order is canceled	202007
orders/delete	Triggered when an order is deleted	202007	{ "order": { "id": "db4469f3-5e56-4c69-a2b6-03e81d24d5b5" } }
cart/create	Triggered when an item is added to the cart	202201	{ "user_id": "f12245c0-7aa4-4cb2-9608-16032b08e72e", "user_sign": null, "currency_code": "USD", "discount_applications": [ { "type": "discount_rebate", "title": "100-99", "discount_amount": 99, "message": "", "discount_message": "", "discount_id": "53609819-f7ae-41c1-8fb1-e5f0ca1b6329", "value_type": "fixed_amount", "target_type": "line_item", "apply_method": "", "target_selection": "all", "discount_type": "discount_rebate", "entitled_product_list": [ { "product_id": "e0854d57-4da2-4538-b7bf-d24dfefa884f", "variant_id": "2f193d62-ab46-49c3-b415-77b3bb895ca5", "price": "111", "trunk_price": "0", "compare_at_price": "0", "total_price": "111", "quantity": 1, "inventory_tracking": false, "inventory_policy": "", "inventory_quantity": 0, "discount_applications": null, "properties": "" }, { "product_id": "15c7c703-d418-47ad-afbd-12790f4559b0", "variant_id": "9460470a-059a-47d2-a6f4-fbad19ff809e", "price": "1", "trunk_price": "0", "compare_at_price": "0", "total_price": "2", "quantity": 2, "inventory_tracking": false, "inventory_policy": "", "inventory_quantity": 0, "discount_applications": null, "properties": "" }, { "product_id": "ed9ccd32-ca60-4d08-975a-2c7d41e5f708", "variant_id": "af2ca87b-169a-4dc3-b3ab-499733714f31", "price": "49.99", "trunk_price": "0", "compare_at_price": "0", "total_price": "49.99", "quantity": 1, "inventory_tracking": false, "inventory_policy": "", "inventory_quantity": 0, "discount_applications": null, "properties": "" } ] } ], "line_items": [ { "id": "1063741801_d41d8cd98f00b204e9800998ecf8427e", "item_id": "1063741801", "properties": "", "product_id": "e0854d57-4da2-4538-b7bf-d24dfefa884f", "variant_id": "2f193d62-ab46-49c3-b415-77b3bb895ca5", "quantity": 1, "price": "111.00", "trunk_price": "0", "custom": false, "parts_price": null, "variant_title": "long", "product_title": "2", "product_handle": "2", "discount_applications": [], "taxable": false, "requires_shipping": true, "wholesale_price": [ { "min_quantity": 1, "price": "111.00" } ] }, { "id": "1063741749_d41d8cd98f00b204e9800998ecf8427e", "item_id": "1063741749", "properties": "", "product_id": "15c7c703-d418-47ad-afbd-12790f4559b0", "variant_id": "9460470a-059a-47d2-a6f4-fbad19ff809e", "quantity": 2, "price": "1.00", "trunk_price": "0", "custom": false, "parts_price": null, "variant_title": "hotpink", "product_title": "Solid Ruffle Neck Bubble Sleeve Pleated Top", "product_handle": "solid-ruffle-neck-bubble-sleeve-pleated-top", "discount_applications": [], "taxable": false, "requires_shipping": true, "wholesale_price": [ { "min_quantity": 1, "price": "1.00" } ] }, { "id": "1063741581_d41d8cd98f00b204e9800998ecf8427e", "item_id": "1063741581", "properties": "", "product_id": "ed9ccd32-ca60-4d08-975a-2c7d41e5f708", "variant_id": "af2ca87b-169a-4dc3-b3ab-499733714f31", "quantity": 1, "price": "49.99", "trunk_price": "0", "custom": false, "parts_price": null, "variant_title": "", "product_title": "Jabra Move Wireless Stereo Headphones", "product_handle": "maternity-rainbow-stripe-skinny-bodycon-dress_5027", "discount_applications": [], "taxable": false, "requires_shipping": true, "wholesale_price": [ { "min_quantity": 1, "price": "49.99" } ] } ], "total_price": "63.99", "total_discount": "99.00", "created_at": "2023-06-14T08:17:30Z", "updated_at": "2023-06-14T08:17:30Z" }
cart/update	Triggered when a shopping cart item is updated	202201
fulfillments/create	Triggered for any shipping action	202007	{ "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" } ] } ] } }
fulfillments/update	Triggered when logistics information is updated	202007
collections/create	Triggered when a collection is created	202007	{ "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/update	Triggered when a collection is updated	202007
collections/delete	Triggered when a collection is deleted	202007	{ "collection": { "id": "0097cfc8-6ec3-40ed-ab9f-6f2231b705a6" } }
customers/create	Triggered when a C-end customer is created	202007	{ "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/update	Triggered when a C-end customer is updated	202007
app/uninstalled	Triggered when the app is uninstalled	202201	{ "app": { "id": 1, "name": "enquiry", "uid": "yAQSUe8l3hT8YFHNAZBIAnQ58HAWZ9FEf5ofELvLE0s", "redirect_uri": "https://apps.example.com/oauth_callback/", "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" } }
app/expired	-	202007
app/purchases_one_time_update	Triggered when the one-time charge status update	202207	{ "application_id": "ITK6sdTeyZuxIoxHpNfxXPMe6BRx5mT8I1SUpBvi6i4", "id": "404385691100624", "name": "30yuan once order", "price": "30", "status": "active", "store_id": 64434, "test": false, "updated_at": "2023-04-07T10:29:49Z" }
app/subscriptions_update	Triggered when the recurring charge status update	202207	{ "activated_on": "2023-04-07T00:00:00Z", "application_id": "ITK6sdTeyZuxIoxHpNfxXPMe6BRx5mT8I1SUpBvi6i4", "billing_on": "2023-05-07T00:00:00Z", "cancelled_on": null, "capped_amount": "30", "id": "404385691100624", "name": "30yuan per month", "price": "30", "status": "active", "store_id": 64434, "test": false, "trial_days": 0, "trial_ends_on": null, "updated_at": "2023-04-07T10:29:49Z" }
app/subscriptions_approaching_capped_amount	Triggered when the usage fee reaches 90% of the capped amount	202207	{ "activated_on": "2023-04-07T00:00:00Z", "application_id": "ITK6sdTeyZuxIoxHpNfxXPMe6BRx5mT8I1SUpBvi6i4", "billing_on": "2023-05-07T00:00:00Z", "cancelled_on": null, "capped_amount": "30", "id": "404385691100624", "name": "30yuan per month", "stord_id": 64434, "trial_ends_on": null, "updated_at": "2023-04-07T10:29:49Z" }