Skip to main content

Supported Webhook Events

Topic

Scope

Minimum Version

Description

products/create

product

202007

Triggered when a product is created.

products/update

product

202007

Triggered when a product is updated.

products/delete

product

202007

Triggered when a product is deleted.

suppliers/create

product

202007

Triggered when a supplier is created.

suppliers/update

product

202007

Triggered when a supplier is updated.

suppliers/delete

product

202007

Triggered when a supplier is deleted.

procurements/create

product

202007

Triggered when a procurement is created.

procurements/update

product

202007

Triggered when a procurement is updated.

collections/create

collection

202007

Triggered when a collection is created.

collections/update

collection

202007

Triggered when a collection is updated.

collections/delete

collection

202007

Triggered when a collection is deleted.

cart/create

order

202201

Triggered when an item is added to the cart.

cart/update

order

202201

Triggered when a shopping cart item is updated.

orders/create

order

202007

Triggered when an order is created.

orders/update

order

202007

Triggered for any update to the order information.

orders/paid

order

202007

Triggered when an order is successfully placed (except for COD, which represents successful payment).

orders/partially_fulfilled

order

202007

Triggered each time an item is shipped, but not all items are shipped.

orders/fulfilled

order

202007

Triggered after all items in an order are shipped.

orders/finished

order

202007

Triggered when a paid order enters the after-sales process, when all items are received, when all refunds and returns are completed, or when the order is fully refunded and all items are also returned (returning orders and returning products are two options in the refund process).

orders/partially_refunded

order

202007

Triggered each time a refund is made, and it is determined that the order amount has not been fully refunded.

orders/refunded

order

202007

Triggered when the full amount is refunded.

orders/cancelled

order

202007

Triggered when an incomplete order is canceled.

orders/delete

order

202007

Triggered when an order is deleted.

fulfillments/create

order

202007

Triggered for any shipping action.

fulfillments/update

order

202007

Triggered when logistics information is updated.

customers/create

customer

202007

Triggered when a C-end customer is created.

customers/update

customer

202007

Triggered when a C-end customer is updated.

customers/delete

customer

202007

Triggered when a C-end customer is deleted.

customers/segment_create

customer

202007

Triggered when a C-end customer segment is created.

customers/segment_update

customer

202007

Triggered when a C-end customer segment is updated.

customers/segment_delete

customer

202007

Triggered when a C-end customer segment is deleted.

app/uninstalled

shop

202201

Triggered when the app is uninstalled.

app/expired

shop

202007

Triggered when the app is expired.

app/purchases_one_time_update

shop

202207

Triggered when the one-time charge status update.

app/subscriptions_update

shop

202207

Triggered when the recurring charge status update.

app/subscriptions_approaching_capped_amount

shop

202207

Triggered when the usage fee reaches 90% of the capped amount.

shop/update

shop

202007

Triggered when shop information is updated.

stores/subscribe

shop

202007

Triggered when a store subscribes.