POST request body
OptionalxPfStoreId: stringUse this to specify which store you want to use (required only for account level token).
The store IDs can be retrieved with the Get basic information about stores endpoint.
any OK
Set up event configuration Use this endpoint to create or replace specific event configuration for a store.
Setting up the Catalog stock updated webhook requires passing products (currently only IDs are taken into account).
Stock update webhook will only include information for the products specified in the products param.
Event type
POST request body
OptionalxPfStoreId: stringUse this to specify which store you want to use (required only for account level token).
The store IDs can be retrieved with the Get basic information about stores endpoint.
any OK
Disable webhook support Removes the webhook URL and all event types from the store.
OptionalxPfStoreId: stringUse this to specify which store you want to use (required only for account level token).
The store IDs can be retrieved with the Get basic information about stores endpoint.
void
Disable support for event Disables the event for a store and clears its configuration, leaving other webhooks intact.
Event type
OptionalxPfStoreId: stringUse this to specify which store you want to use (required only for account level token).
The store IDs can be retrieved with the Get basic information about stores endpoint.
void
Get event configuration Returns event configuration for store
Event type
OptionalxPfStoreId: stringUse this to specify which store you want to use (required only for account level token).
The store IDs can be retrieved with the Get basic information about stores endpoint.
OptionalshowExpired: booleanIf this parameter is passed with value true, expired settings will be returned instead of a 404 warning.
any OK
Get webhook configuration Returns a configured webhook URL and a list of webhook event types enabled for the store
OptionalxPfStoreId: stringUse this to specify which store you want to use (required only for account level token).
The store IDs can be retrieved with the Get basic information about stores endpoint.
OptionalshowExpired: booleanIf this parameter is passed with value true, expired settings will be returned instead of a 404 warning.
any OK
Set up webhook configuration Use this endpoint to enable a webhook URL for a store and select webhook event types that will be sent to this URL.
Note that only one webhook configuration can be active for each private OAuth token or app, calling this method will disable the previous webhook configuration.
Setting up the Catalog stock updated webhook requires passing products (currently only IDs are taken into account).
Stock update webhook (
catalog_stock_updated) will only include information for the products specified in theproductsparam.Configuring all other events require the same set of fields with no parameters.