Webhook Payload

{
  "id": "b14d07f7-d8a3-4ac3-b897-69c3845e6c5f",
  "order_id": "66730835-1e59-4a60-83b8-97b8e3f2c496",
  "shipping_account_id": 1111,
  "fulfillment_id": "a5e9d357-9668-4598-9624-785b47a0edcc",
  "merchant_id": 24,
  "service": "On Demand",
  "source_id": "94c333",
  "tracking_number": "567293923024",
  "carrier_reference_number": "ABC-000123",
  "delivery_cost": 1020,
  "customer": {
    "name": "Fulfillment Customer Name 4",
    "email": "[email protected]",
    "allow_email": true,
    "phone": "+12133333334",
    "allow_sms": true,
    "id": "string",
    "merchant_id": 1,
    "created_at": "string",
    "updated_at": "string"
  },
  "packages_count": 3,
  "shipment_events": [
    {
      "id": "849aed78-9d57-4ce7-b9eb-8a7492a53991",
      "shipment_id": "849aed78-9d57-4ce7-b9eb-8a7492a53991",
      "type": "status_update",
      "value": "string",
      "merchant_id": 24
    }
  ],
  "commercial_invoice": "string",
  "created_at": "string",
  "delete_at": "string",
  "recipient_end": "string",
  "recipient_start": "string",
  "sender_end": "string",
  "sender_start": "string",
  "status":"New"
  "type": "delivery",
  "updated_at": "",
  "tracking_url": "https://hub.bringg.com/#/account/track/3fa85f64-5717-4562-b3fc-2c963f66afa6/?region=us",
  "shipments_packages": [
    {
      "id": "b5dc024c-c625-4539-9890-8e43d8334d2e",
      "package_id": "d1dab2a1-df04-4b6f-9424-33d895a0027c",
      "tracking_number": "555444333222111",
      "order_id": "a5e9d357-9668-4598-9624-785b47a0edbb",
      "fulfillment_id": "a5e9d357-9668-4598-9624-785b47a0edcc",
      "shipment_id": "a5e9d357-9668-4598-9624-785b47a0edcc",
      "label": "https://my-site.com/test.jpg"
    }
  ]
}

Parameter	Description
id string	The shipment ID.
order_id string	The ID of the shipment's parent order.
shipping_account_id double	The shipping account used for the quoted booking.
fulfillment_id	Delivery Hub's ID for this fulfillment.
account_id double	The ID of your organization's Delivery Hub account.
source_id string	Your source system's ID for this order.
tracking_number string	The tracking number provided by the carrier.
carrier_reference_number string	The carrier's ID for this shipment.
delivery_cost integer	The amount charged to the customer to deliver this shipment.
customer object	The contact specifications for the customer. Includes: - `name` - `email` - `allow_email` - `phone` - `allow_sms` - `id` - `account_id` - `created_at` - `updated_at`
name string	The customer's first and last name.
email string	The customer's email address.
allow_email boolean	If `allow_email` is `true`, send notifications to customer by email.
phone string	The customer's phone number.
allow_sms boolean	If `allow_sms` is true, send notifications to customer by SMS.
id string	The customer's ID in your external system.
account_id string	The ID of your organization's Delivery Hub account.
created_at string	The date and time when the customer was created in Delivery Hub.
updated_at string	The date and time when the customer was updated in Delivery Hub.
packages_count integer	The number of packages included in this shipment.
shipment_events object	The specifications of the event that triggered this webhook. Includes: - `id` - `shipment_id` - `value` - `account_id`
id string	Delivery Hub's ID for the event.
shipment_id string	Delivery Hub's ID for this shipment.
type string	The trigger type for this webhook.
value string	The name and description of the event that triggered this webhook.
account_id	The ID of your organization's Delivery Hub account.
created_at string	The date and time when this shipment was created in Delivery Hub.
delete_at string	The date and time when this shipment will be deleted from Delivery Hub.
(Coming soon) recipient_start string	The start of the dropoff time window.
(Coming soon) recipient_end string	The end of the dropoff time window.
(Coming soon) sender_start string	The start of the pickup time window.
(Coming soon) sender_end string	The end of the pickup time window.
status string	The shipment's status. Possible values: - `Quoted` - `New` - `PartiallyFulfilled` - `ReadyToShip` - `PickedUp` - `InTransit` - `OutForDelivery` - `Delivered` - `Exception` - `CanceledByCarrier` - `Canceled` Learn more about Delivery Hub statuses.
(Coming soon) type enum	Designates if this shipment is a `delivery` or `return`.
updated_at string	The date and time when this shipment was updated in Delivery Hub.
tracking_url string	The URL that your customer can use to track their order on Delivery Hub's tracking UI.
shipments_packages array of objects	Specifications for each package included in this shipment. Includes: - `id` - `package_id` - `order_id` - `fulfillment_id` - `shipment_id` - `label`
id string	Delivery Hub's ID for this package.
package_id string	Delivery Hub's ID for the package type.
tracking_number string	The tracking number provided by the carrier.
order_id string	Delivery Hub's ID for the parent order of this shipment.
fulfillment_id string	Delivery Hub's ID for the parent fulfillment of this shipment.
shipment_id string	Delivery Hub's ID for this shipment.
label string	The URL of the shipping label.