The Shipped webhook is used to notify your system when a shipment has been completed in Fulfill Engine, with the shipment updated to a Label generated status in most cases. 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",
"customId": "shipment-custom-id",
"orderCustomId": "order-custom-id",
"orderId": "order-id",
"orderItemGroupIds": ["order-item-group-id-1", "order-item-group-id-2"],
"shipmentId": "shipment-id",
"shippingCarrier": "UPS",
"shippingCarrierCode": "ups",
"shippingService": "ups_ground",
"trackingNumber": "tracking-number",
"trackingUrl": "tracking-url",
"webhook": "shipped",
"url": "https://api.fulfillengine.com/api/accounts/account-id/shipments/shipment-id"
}Most orders in Fulfill Engine have a single shipment, in which case the Shipped webhook will coincide with the order being completed and updated to a Shipped status. In the rare cases of a multi-shipment order, the Shipped webhook will notify your system for each completed shipment. For all but the final shipment, the related order will be in a Partially fulfilled status.
The shipped webhook will include a shippingCarrierCode indicating the carrier that was used. This can be one of the following values:
- dpd_local
- mail_innovations
- fedex
- ups
- usps
- royal_mail
- australia_post
