Webhook Event: Price Deleted
Event Name: price_deleted
HTTP Method: POST
Webhook URL: Your specified endpoint URL
Test Key: is_test
(boolean): Indicates whether the webhook event is a test (true
) or a real event (false
).
Description
This event is triggered when a price associated with a product is deleted from the store. The webhook payload provides the identifier of the deleted price, allowing the store to update its records accordingly.
Payload Structure
The webhook payload for the price_deleted
event includes the following fields:
event_name
(string): The name of the webhook event, in this case,price_deleted
.is_test
(boolean): Indicates if the webhook event is a test.id
(string): The unique identifier for the price that was deleted.store_id
(string): The identifier of the store from which the price was deleted.
Example Payload
{
"event_name": "price_deleted",
"is_test": false,
"id": "price123",
"store_id": "store789"
}
Handling the Event
Upon receiving a price_deleted
webhook, remove the corresponding price from your system to ensure it no longer affects the product's pricing. The is_test
key allows for differentiation between actual deletions and test events.