Prerequisites: Introduction to webhooks
The Order Shipped webhook is used to notify your system when an order has been completed and is shipped by 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",
"customId": "shipment-custom-id",
"orderCustomId": "order-custom-id",
"orderId": "order-id",
"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"
}Note the customId field is the custom ID provided on the shipment.
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
