Prerequisites: Introduction to webhooks
The Shipment Canceled webhook is used to notify your system when a shipment has been canceled in Fulfill Engine. When this occurs, a POST request will be made to your registered webhook URL with a body describing the event. An example request body is shown below.
{
"accountId": "account-id",
"campaignId": "campaign-id",
"orderId": "order-id",
"customId": "shipment-custom-id",
"shipmentId": "shipment-id",
"webhook": "shipment_canceled",
"cancelReason": "Message explaining why the shipment was canceled",
"url": "https://api.fulfillengine.com/api/accounts/account-id/shipments/shipment-id"
}
Note the customId field is the custom ID provided on the shipment.