Webhooks are sent when a shipment in Delivery Hub receives a new status. Webhook payloads include all data from the Create Shipment response as well as the shipment's status, notes from the carrier, a tracking number, tracking URL (based on your plan), and a carrier reference number.
{
"created_at": "2023-08-21T10:15:54.441Z",
"updated_at": "2023-08-21T10:15:55.508Z",
"old_id": "aba4e826-5bc8-40c2-9a86-18d55b783773",
"id": 171,
"source_id": null,
"order_id": 449,
"fulfillment_id": 452,
"service": null,
"tracking_number": null,
"deliver_by": null,
"carrier_reference_number": null,
"carrier": null,
"label_type": "ZPL",
"last_updated_by": null,
"commercial_invoice": null,
"shipping_account_id": 128365518,
"delivery_cost": 1298,
"estimated_delivery_cost": 1900,
"net_charge": null,
"taxes": null,
"surcharges": null,
"discounts": null,
"status": "New",
"accepted_by_carrier_at": null,
"picked_up_at": null,
"done_at": null,
"cancelled_at": null,
"cancelled_by_carrier_at": null,
"order": {
"created_at": "2023-08-21T10:14:59.898Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 449,
"last_updated_by": null,
"source_id": null,
"name": "Order_368167",
"notes": [
"Service with a smile"
],
"customer_id": 1600,
"billing_address_id": 2382,
"custom": {
"key": "CR",
"value": "1234567890"
},
"currency": "CAD",
"tip": null,
"tag_name": null,
"total_price": 22000,
"status": "New",
"started_at": null,
"done_at": null,
"customer": {
"created_at": "2023-08-21T10:14:59.898Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 1600,
"name": "John Martin",
"language": null,
"email": "[email protected]",
"phone": "+12125550197",
"allow_sms": false,
"allow_email": false
},
"billing_address": {
"created_at": "2023-08-21T10:14:59.898Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 2382,
"street1": "Order billing address",
"street2": "string",
"street3": "string",
"city": "Napa",
"postal_code": "77024",
"state": "CA",
"country": "US",
"phone": null,
"email": null,
"address_type": "residential",
"company": null
},
"fulfillments": [
{
"created_at": "2023-08-21T10:14:59.933Z",
"updated_at": "2023-08-21T10:15:51.724Z",
"id": 452,
"source_id": "ff_src_id_368167",
"order_id": 449,
"sender_id": 1602,
"recipient_id": 1601,
"last_updated_by": 10220175,
"shipping_account_id": 177446041,
"service": "express_9",
"sender_address_id": 2383,
"recipient_address_id": 2384,
"sender_location_id": null,
"recipient_location_id": null,
"quote_id": null,
"status": "New",
"fulfillment_type": "delivery",
"fulfillment_method": "direct",
"pudo_location_id": null,
"sender_address": {
"created_at": "2023-08-21T10:14:59.933Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 2383,
"street1": "416 Water St.",
"street2": null,
"street3": null,
"city": "New York",
"postal_code": "10002",
"state": "NY",
"country": "US",
"phone": "+12125550197",
"email": null,
"address_type": "residential",
"company": null
},
"recipient_address": {
"created_at": "2023-08-21T10:14:59.933Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 2384,
"street1": "30 S Halsted St",
"street2": null,
"street3": null,
"city": "Chicago",
"postal_code": "60661",
"state": "IL",
"country": "US",
"phone": "+12125550197",
"email": null,
"address_type": "residential",
"company": null
},
"name": "Order_368167",
"deliver_by": null,
"items_count": 3
}
],
"products": [
{
"created_at": "2023-08-21T10:14:59.908Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 994,
"order_id": 449,
"name": "Double Hoop Clip On Earring 3",
"source_id": "src_prod_10434355",
"sku": "su2143",
"country_of_origin": "CH",
"image_url": "https://image.url",
"description": "Some order description here",
"special_services": {
"fragile": true
},
"harmonized_code": null,
"count": 3,
"price": 1121,
"weight_units": "kg",
"dim_units": "cm",
"length": 55.22,
"width": 32.77,
"weight": 20,
"height": 22.99,
"barcode": null
}
],
"integration": null,
"total_weight": 60,
"items_count": 3,
"deliver_by": null
},
"shipments_packages": [
{
"created_at": "2023-08-21T10:15:54.441Z",
"updated_at": "2023-08-21T10:15:54.441Z",
"id": 201,
"order_id": 449,
"package_id": 10,
"fulfillment_id": 452,
"shipment_id": 171,
"tracking_number": null,
"label": null,
"return_label": null,
"package_weight": null,
"weight_units": null,
"status":"New",
"package": {
"created_at": "2023-05-25T10:16:56.171Z",
"updated_at": "2023-05-25T10:16:56.171Z",
"id": 10,
"name": "BigPack",
"carrier_package_type": null,
"length": 100,
"width": 100,
"height": 100,
"active": true,
"dim_units": "cm",
"weight": 10,
"weight_units": "g"
},
"shipments_products": [
{
"created_at": "2023-08-21T10:15:54.441Z",
"updated_at": "2023-08-21T10:15:54.441Z",
"id": 269,
"product_id": 994,
"shipment_id": 171,
"shipments_package_id": 201,
"count": 1,
"product": {
"created_at": "2023-08-21T10:14:59.908Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 994,
"order_id": 449,
"name": "Double Hoop Clip On Earring 3",
"source_id": "src_prod_10434355",
"sku": "su2143",
"country_of_origin": "CH",
"image_url": "https://image.url",
"description": "Some order description here",
"special_services": {
"fragile": true
},
"harmonized_code": null,
"count": 3,
"price": 1121,
"weight_units": "kg",
"dim_units": "cm",
"length": 55.22,
"width": 32.77,
"weight": 20,
"height": 22.99,
"barcode": null
}
}
]
}
],
"shipments_products": [
{
"created_at": "2023-08-21T10:15:54.441Z",
"updated_at": "2023-08-21T10:15:54.441Z",
"old_id": "467e1842-c912-42ca-941c-46bee20ad512",
"id": 269,
"product_id": 994,
"shipment_id": 171,
"shipments_package_id": 201,
"count": 1,
"product": {
"created_at": "2023-08-21T10:14:59.908Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 994,
"order_id": 449,
"name": "Double Hoop Clip On Earring 3",
"source_id": "src_prod_10434355",
"sku": "su2143",
"country_of_origin": "CH",
"image_url": "https://image.url",
"description": "Some order description here",
"special_services": {
"fragile": true
},
"harmonized_code": null,
"count": 3,
"price": 1121,
"weight_units": "kg",
"dim_units": "cm",
"length": 55.22,
"width": 32.77,
"weight": 20,
"height": 22.99,
"barcode": null
}
}
],
"fulfillment": {
"created_at": "2023-08-21T10:14:59.933Z",
"updated_at": "2023-08-21T10:15:51.724Z",
"id": 452,
"source_id": "ff_src_id_368167",
"order_id": 449,
"sender_id": 1602,
"recipient_id": 1601,
"last_updated_by": 10220175,
"shipping_account_id": 177446041,
"service": "express_9",
"sender_address_id": 2383,
"recipient_address_id": 2384,
"sender_location_id": null,
"recipient_location_id": null,
"quote_id": null,
"status": "New",
"fulfillment_type": "delivery",
"fulfillment_method": "direct",
"pudo_location_id": null,
"recipient": {
"created_at": "2023-08-21T10:14:59.933Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 1601,
"name": "Fulfilment Customer Name",
"language": null,
"email": "[email protected]",
"phone": "+12125550197",
"allow_sms": true,
"allow_email": true
},
"sender": {
"created_at": "2023-08-21T10:14:59.933Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 1602,
"name": "Fulfilment Customer Name",
"language": null,
"email": "[email protected]",
"phone": "+12125550197",
"allow_sms": true,
"allow_email": true
},
"fulfillments_products": [
{
"created_at": "2023-08-21T10:14:59.933Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 1012,
"fulfillment_id": 452,
"product_id": 994,
"count": 3,
"product": {
"created_at": "2023-08-21T10:14:59.908Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 994,
"order_id": 449,
"name": "Double Hoop Clip On Earring 3",
"source_id": "src_prod_10434355",
"sku": "su2143",
"country_of_origin": "CH",
"image_url": "https://image.url",
"description": "Some order description here",
"special_services": {
"fragile": true
},
"harmonized_code": null,
"count": 3,
"price": 1121,
"weight_units": "kg",
"dim_units": "cm",
"length": 55.22,
"width": 32.77,
"weight": 20,
"height": 22.99,
"barcode": null
}
}
],
"sender_address": {
"created_at": "2023-08-21T10:14:59.933Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 2383,
"street1": "416 Water St.",
"street2": null,
"street3": null,
"city": "New York",
"postal_code": "10002",
"state": "NY",
"country": "US",
"phone": "+12125550197",
"email": null,
"address_type": "residential",
"company": null
},
"recipient_address": {
"created_at": "2023-08-21T10:14:59.933Z",
"updated_at": "2023-08-21T10:14:59.933Z",
"id": 2384,
"street1": "30 S Halsted St",
"street2": null,
"street3": null,
"city": "Chicago",
"postal_code": "60661",
"state": "IL",
"country": "US",
"phone": "+12125550197",
"email": null,
"address_type": "residential",
"company": null
},
"recipient_location": null,
"name": "Order_368167",
"deliver_by": null,
"items_count": 3,
"total_weight": 60
},
"webhook_type": "shipment:created"
}
{
"id": "6f23a780-56ca-448b-91cb-4652d252d1a0",
"created_at": "2023-06-12T20:14:13.503Z",
"updated_at": "2023-06-13T08:24:46.921Z",
"source_id": null,
"order_id": "12d351d2-e759-4d75-9cb7-2b4c71d48ef6",
"fulfillment_id": "56fc447a-7af4-4551-858d-a06417b637fb",
"service": "chrono_marchandises_dangereuses_13",
"customer_id": "9985f8bf-37ce-4805-aa2c-440cf51f5b09",
"tracking_number": "XV238719389FR",
"deliver_by": null,
"carrier_reference_number": "0004e82fc8544c999e5614c9e5752feb",
"carrier": "chrono_post",
"label_type": "PDF",
"type": "delivery",
"commercial_invoice": null,
"shipping_account_id": 123456789,
"delivery_cost": null,
"net_charge": null,
"taxes": null,
"surcharges": null,
"discounts": null,
"status": "Delivered",
"order": {
"id": "12d351d2-e759-4d75-9cb7-2b4c71d48ef6",
"created_at": "2023-06-12T20:14:10.953Z",
"updated_at": "2023-06-13T08:24:46.940Z",
"source_id": null,
"name": "Chrono_Order_260300",
"notes": [
"Service with a smile"
],
"customer_id": "d26ce054-40d7-42a0-a64f-85aaa9800ce5",
"billing_address_id": "b55ffa06-35fd-4c18-9059-77c400600323",
"custom": {
"fragile": true,
"hazzard": true
},
"currency": "CAD",
"tip": null,
"tag_name": null,
"total_price": 22000,
"status": "New",
"integration": null,
"items_count": 1,
"deliver_by": null
},
"fulfillments": {
"id": "56fc447a-7af4-4551-858d-a06417b637fb",
"created_at": "2023-06-12T20:14:10.953Z",
"updated_at": "2023-06-12T20:14:10.953Z",
"source_id": "260300",
"order_id": "12d351d2-e759-4d75-9cb7-2b4c71d48ef6",
"customer_id": "4018a19c-6d5a-48c2-8d62-272a2bbdf420",
"shipping_account_id": 123456789,
"service": "chrono_marchandises_dangereuses_13",
"sender_address_id": "0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p",
"recipient_address_id": "67454b0b-9ac3-4671-bd04-4e914adca3bd",
"quote_id": null,
"fulfillment_type": "delivery",
"fulfillment_method": "direct",
"pudo_location_id": null,
"sender_address": {
"id": "0a1b2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p",
"created_at": "2023-06-12T20:14:10.953Z",
"updated_at": "2023-06-12T20:14:10.953Z",
"street1": "Rue de la Paix",
"street2": null,
"street3": null,
"city": "Paris",
"postal_code": "75002",
"state": null,
"country": "France",
"phone": "33123456789",
"email": "[email protected]",
"address_type": null,
"company": "Example Company"
},
"recipient_address": {
"id": "67454b0b-9ac3-4671-bd04-4e914adca3bd",
"created_at": "2023-06-12T20:14:10.953Z",
"updated_at": "2023-06-12T20:14:10.953Z",
"street1": "34 rue Henri Barbusse",
"street2": null,
"street3": null,
"city": "GENNEVILLIERS",
"postal_code": "92230",
"state": null,
"country": "FR",
"phone": "33987654321",
"email": "[email protected]",
"address_type": null,
"company": "company"
},
"name": "Chrono_Order_260300",
"deliver_by": null,
"items_count": 1,
"status": "Delivered"
},
"shipment_events": [
{
"id": "150478d8-fcb2-4460-ac16-8d44dca334d3",
"created_at": "2023-06-13T08:24:46.940Z",
"updated_at": "2023-06-13T08:24:46.940Z",
"type": "checkpoint",
"value": "Livraison effectuée",
"shipping_account_id": 123456789,
"with_shipping_rules": false
},
{
"id": "868cffb8-c076-4301-823c-98c4a960d297",
"created_at": "2023-06-13T08:24:46.929Z",
"updated_at": "2023-06-13T08:24:46.929Z",
"type": "status_update",
"value": "Delivered",
"shipping_account_id": 123456789,
"with_shipping_rules": false
},
{
"id": "d3934013-7db8-42ea-87f6-187dbfb5b7d3",
"created_at": "2023-06-13T08:24:27.221Z",
"updated_at": "2023-06-13T08:24:27.221Z",
"type": "checkpoint",
"value": "out for delivery",
"shipping_account_id": 123456789,
"with_shipping_rules": false
},
{
"id": "c1955895-5ea3-4fb6-b2fb-ac5bb85b7b0b",
"created_at": "2023-06-13T08:24:27.212Z",
"updated_at": "2023-06-13T08:24:27.212Z",
"type": "status_update",
"value": "OutForDelivery",
"shipping_account_id": 123456789,
"with_shipping_rules": false
},
{
"id": "393d9f72-995f-486f-8740-7775ef086564",
"created_at": "2023-06-13T08:14:30.807Z",
"updated_at": "2023-06-13T08:14:30.807Z",
"type": "checkpoint",
"value": "Tri effectué dans lagence de départ",
"shipping_account_id": 123456789,
"with_shipping_rules": false
},
{
"id": "fbbcfcac-78a9-4de2-b31f-00963827c477",
"created_at": "2023-06-13T08:14:30.798Z",
"updated_at": "2023-06-13T08:14:30.798Z",
"type": "status_update",
"value": "InTransit",
"shipping_account_id": 123456789,
"with_shipping_rules": false
},
{
"id": "0f9c5d79-94d5-419e-bb8e-3630ba8815df",
"created_at": "2023-06-13T08:11:23.100Z",
"updated_at": "2023-06-13T08:11:23.100Z",
"type": "checkpoint",
"value": "Envoi prêt chez lexpéditeur",
"shipping_account_id": 123456789,
"with_shipping_rules": false
},
{
"id": "dc3d4511-0768-492e-93d9-21f69ee37d0c",
"created_at": "2023-06-13T08:11:23.088Z",
"updated_at": "2023-06-13T08:11:23.088Z",
"type": "status_update",
"value": "PickedUp",
"shipping_account_id": 123456789,
"with_shipping_rules": false
},
{
"id": "d02e509e-0582-49c0-a812-b25767122537",
"created_at": "2023-06-13T08:02:46.814Z",
"updated_at": "2023-06-13T08:02:46.814Z",
"type": "status_update",
"value": "ReadyToShip",
"shipping_account_id": 123456789,
"with_shipping_rules": false
},
{
"id": "57d7fd0f-b194-4cb5-a45f-3ba23e469c6d",
"created_at": "2023-06-13T07:49:45.165Z",
"updated_at": "2023-06-13T07:49:45.165Z",
"type": "checkpoint",
"value": "Envoi pris en charge chez l'expéditeur",
"shipping_account_id": 123456789,
"with_shipping_rules": false
},
{
"id": "34fab1da-deec-4cf5-8784-280eef9a94b8",
"created_at": "2023-06-13T07:49:45.151Z",
"updated_at": "2023-06-13T07:49:45.151Z",
"type": "status_update",
"value": "ReadyToShip",
"shipping_account_id": 123456789,
"with_shipping_rules": false
}
],
"packages_count": 1,
"tracking_url": "https://hub.bringg.com/#/track/authorization-code",
"webhook_type": "shipment:updated"
}
{
"created_at": "2023-08-29T08:33:37.944Z",
"updated_at": "2023-08-29T08:33:41.680Z",
"id": 220,
"source_id": null,
"order_id": 488,
"fulfillment_id": 488,
"service": "express_24",
"tracking_number": "ER4353198",
"deliver_by": null,
"carrier_reference_number": "e79a61e7ab9f431b0977166ee255a2173",
"carrier": "parcelforce",
"label_type": "PDF",
"last_updated_by": null,
"commercial_invoice": null,
"shipping_account_id": 123456789,
"delivery_cost": null,
"net_charge": null,
"taxes": null,
"surcharges": null,
"discounts": null,
"status": "Exception",
"accepted_by_carrier_at": null,
"picked_up_at": "2023-08-29T08:45:20.614Z",
"done_at": null,
"cancelled_at": null,
"cancelled_by_carrier_at": null,
"order": {
"created_at": "2023-08-29T08:33:32.895Z",
"updated_at": "2023-08-29T08:57:26.824Z",
"id": 488,
"last_updated_by": null,
"source_id": null,
"name": "Order 93554",
"notes": [
"Service with a smile"
],
"customer_id": 1234,
"billing_address_id": 5678,
"custom": {
"fragile": true,
"hazzard": true
},
"currency": "CAD",
"tip": null,
"tag_name": null,
"total_price": 22000,
"status": "PartiallyFulfilled",
"started_at": "2023-08-29T08:33:41.725Z",
"done_at": null,
"customer": {
"created_at": "2023-08-29T08:33:32.895Z",
"updated_at": "2023-08-29T08:33:32.921Z",
"id": 1711,
"name": "John Martin",
"language": null,
"email": "[email protected]",
"phone": "12125550197",
"allow_sms": false,
"allow_email": false
},
"billing_address": {
"created_at": "2023-08-29T08:33:32.895Z",
"updated_at": "2023-08-29T08:33:32.921Z",
"id": 2494,
"street1": "Order billing address",
"street2": "string",
"street3": "string",
"city": "Napa",
"postal_code": "77024",
"state": "CA",
"country": "US",
"phone": null,
"email": null,
"address_type": "residential",
"company": null
},
"integration": null,
"items_count": 30,
"deliver_by": null
},
"shipments_packages": [
{
"created_at": "2023-08-29T08:33:37.944Z",
"updated_at": "2023-08-29T08:33:41.664Z",
"id": 289,
"order_id": 488,
"package_id": 10,
"fulfillment_id": 488,
"shipment_id": 220,
"tracking_number": "ER4353198",
"package_weight": null,
"weight_units": null,
"package": {
"created_at": "2023-05-25T10:16:56.171Z",
"updated_at": "2023-08-25T13:16:55.457Z",
"id": 10,
"name": "BigPack",
"carrier_package_type": null,
"length": 100,
"width": 100,
"height": 100,
"active": false,
"dim_units": "cm",
"weight": 10,
"weight_units": "g"
},
"shipments_products": [
{
"created_at": "2023-08-29T08:33:37.944Z",
"updated_at": "2023-08-29T08:33:37.944Z",
"id": 461,
"product_id": 1120,
"shipment_id": 220,
"shipments_package_id": 289,
"count": 1,
"product": {
"created_at": "2023-08-29T08:33:32.903Z",
"updated_at": "2023-08-29T08:33:32.921Z",
"id": 1120,
"order_id": 488,
"name": "Double Hoop Clip On Earring 3",
"source_id": "src_prod_93554",
"sku": "su2143",
"country_of_origin": "CH",
"image_url": "https://image.url",
"description": "Some order description here",
"special_services": {
"fragile": true
},
"harmonized_code": "60754107",
"count": 30,
"price": 1121,
"weight_units": "kg",
"dim_units": "cm",
"length": 55,
"width": 32,
"weight": 20,
"height": 22,
"barcode": null
}
}
]
}
],
"fulfillment": {
"created_at": "2023-08-29T08:33:32.921Z",
"updated_at": "2023-08-29T08:33:41.705Z",
"id": 488,
"source_id": "ff_src_id_93554",
"order_id": 488,
"sender_id": 1713,
"recipient_id": 1712,
"last_updated_by": null,
"shipping_account_id": null,
"service": null,
"sender_address_id": 2495,
"recipient_address_id": 2496,
"sender_location_id": null,
"recipient_location_id": null,
"quote_id": null,
"status": "PartiallyFulfilled",
"fulfillment_type": "delivery",
"fulfillment_method": "direct",
"pudo_location_id": null,
"sender_address": {
"created_at": "2023-08-29T08:33:32.921Z",
"updated_at": "2023-08-29T08:33:32.921Z",
"id": 2495,
"street1": "22 Main Street",
"street2": null,
"street3": null,
"city": "London",
"postal_code": "EC2V 7RS",
"state": "",
"country": "GB",
"phone": "1234567890",
"email": "[email protected]",
"address_type": "residential",
"company": "ZK"
},
"recipient_address": {
"created_at": "2023-08-29T08:33:32.921Z",
"updated_at": "2023-08-29T08:33:32.921Z",
"id": 2496,
"street1": "22 Main Street",
"street2": null,
"street3": null,
"city": "London",
"postal_code": "EC2V 7RS",
"state": "",
"country": "GB",
"phone": "+12125550197",
"email": "[email protected]",
"address_type": "residential",
"company": "ZK"
},
"name": "Order 93554",
"deliver_by": null,
"items_count": 30
},
"shipment_events": [
{
"created_at": "2023-08-29T09:25:44.360Z",
"updated_at": "2023-08-29T09:25:44.360Z",
"id": 530,
"type": "checkpoint",
"value": "Something happened to your shipment",
"shipping_account_id": 123456789,
"with_shipping_rules": false,
"timestamp": "2023-08-29T15:25:44.000Z"
},
{
"created_at": "2023-08-29T09:25:44.349Z",
"updated_at": "2023-08-29T09:25:44.349Z",
"id": 529,
"type": "status_update",
"value": "Exception",
"shipping_account_id": 123456789,
"with_shipping_rules": false,
"timestamp": "2023-08-29T09:25:44.347Z"
},
{
"created_at": "2023-08-29T08:54:01.700Z",
"updated_at": "2023-08-29T08:54:01.700Z",
"id": 526,
"type": "checkpoint",
"value": "Your Shipment is in transit!",
"shipping_account_id": 123456789,
"with_shipping_rules": false,
"timestamp": "2023-07-13T15:25:44.000Z"
},
{
"created_at": "2023-08-29T08:54:01.689Z",
"updated_at": "2023-08-29T08:54:01.689Z",
"id": 525,
"type": "status_update",
"value": "InTransit",
"shipping_account_id": 123456789,
"with_shipping_rules": false,
"timestamp": "2023-08-29T08:54:01.687Z"
},
{
"created_at": "2023-08-29T08:45:20.739Z",
"updated_at": "2023-08-29T08:45:20.739Z",
"id": 524,
"type": "checkpoint",
"value": "Your Shipment was picked up!",
"shipping_account_id": 123456789,
"with_shipping_rules": false,
"timestamp": "2023-06-26T15:25:44.000Z"
},
{
"created_at": "2023-08-29T08:45:20.730Z",
"updated_at": "2023-08-29T08:45:20.730Z",
"id": 523,
"type": "status_update",
"value": "PickedUp",
"shipping_account_id": 123456789,
"with_shipping_rules": false,
"timestamp": "2023-08-29T08:45:20.728Z"
}
],
"packages_count": 1,
"tracking_url": "https://hub.bringg.com/#/track/a27db0?region=us-east-4-gcp",
"webhook_type": "shipment:updated"
}
{
"created_at": "2023-09-25T09:04:56.116Z",
"updated_at": "2023-09-26T10:19:02.915Z",
"id": 207,
"source_id": null,
"order_id": 122,
"fulfillment_id": 122,
"service": "standard",
"tracking_number": "123456789874",
"deliver_by": null,
"carrier_reference_number": "7e183db0323f5d5f3abb4ae79079ea81a3",
"carrier": "custom",
"shipping_account_name": "Shipping Account 1",
"label_type": "ZPL",
"last_updated_by": 10,
"commercial_invoice": null,
"shipping_account_id": 123456789,
"delivery_cost": null,
"estimated_delivery_cost": null,
"quote_id": null,
"net_charge": null,
"taxes": null,
"surcharges": null,
"discounts": null,
"status": "Canceled",
"accepted_by_carrier_at": null,
"picked_up_at": null,
"done_at": null,
"canceled_at": null,
"canceled_by_carrier_at": null,
"order": {
"created_at": "2023-09-22T23:11:54.673Z",
"updated_at": "2023-09-22T23:13:51.235Z",
"id": 122,
"last_updated_by": null,
"source_id": "1695424314580",
"name": "Order for John",
"notes": [
"Service with a smile"
],
"customer_id": 364,
"billing_address_id": 364,
"custom": {
"fragile": false,
"hazzard": false
},
"currency": "USD",
"tip": null,
"tag_name": null,
"total_price": 220,
"status": "PartiallyFulfilled",
"started_at": "2023-09-22T23:13:51.235Z",
"done_at": null,
"customer": {
"created_at": "2023-09-22T23:11:54.673Z",
"updated_at": "2023-09-22T23:11:54.673Z",
"id": 364,
"name": "John Snow",
"language": "en",
"email": "[email protected]",
"phone": "+123456789",
"allow_sms": false,
"allow_email": false
},
"deliver_by": null
},
"shipments_packages": [
{
"created_at": "2023-09-25T09:04:56.116Z",
"updated_at": "2023-09-25T09:04:56.973Z",
"id": 235,
"order_id": 122,
"package_id": 1,
"fulfillment_id": 122,
"shipment_id": 207,
"tracking_number": "123456789",
"label": "Xlh[....]",
"return_label": null,
"package_weight": null,
"weight_units": null
}
],
"shipments_products": [
{
"created_at": "2023-09-25T09:04:56.116Z",
"updated_at": "2023-09-25T09:04:56.116Z",
"id": 262,
"product_id": 272,
"shipment_id": 207,
"shipments_package_id": 235,
"count": 1
}
],
"fulfillment": {
"created_at": "2023-09-22T23:11:54.718Z",
"updated_at": "2023-09-25T09:04:53.040Z",
"id": 122,
"source_id": "123456789",
"order_id": 122,
"sender_id": 366,
"recipient_id": 365,
"last_updated_by": 10,
"shipping_account_id": 123456789,
"service": "standard",
"sender_address_id": 365,
"recipient_address_id": 366,
"sender_location_id": null,
"recipient_location_id": null,
"quote_id": null,
"status": "PartiallyFulfilled",
"fulfillment_type": "delivery",
"fulfillment_method": "direct",
"pudo_location_id": null,
"sender_address": {
"created_at": "2023-09-22T23:11:54.718Z",
"updated_at": "2023-09-22T23:11:54.718Z",
"id": 365,
"street1": "10 N Washington",
"street2": null,
"street3": null,
"city": "Chicago",
"postal_code": "60608",
"state": "IL",
"country": "US",
"phone": null,
"email": null,
"address_type": "residential",
"company": null
},
"recipient_address": {
"created_at": "2023-09-22T23:11:54.718Z",
"updated_at": "2023-09-22T23:11:54.718Z",
"id": 366,
"street1": "1234 S Bell",
"street2": null,
"street3": null,
"city": "Chicago",
"postal_code": "60608",
"state": "IL",
"country": "US",
"phone": null,
"email": null,
"address_type": "residential",
"company": null
},
"name": "Order for John",
"deliver_by": null,
"items_count": 16
},
"shipment_events": [
{
"created_at": "2023-09-26T10:19:02.888Z",
"updated_at": "2023-09-26T10:19:02.888Z",
"id": 1117,
"type": "status_update",
"value": "Canceled",
"shipping_account_id": 12345678,
"with_shipping_rules": false,
"timestamp": "2023-09-26T10:19:02.882Z",
"service": "standard"
},
{
"created_at": "2023-09-26T10:19:02.888Z",
"updated_at": "2023-09-26T10:19:02.888Z",
"id": 2511,
"type": "checkpoint",
"value": "The package caught fire, and then a bird grabbed it and tried to carry it away, and it also caught fire",
"shipping_account_id": 12345678,
"with_shipping_rules": false,
"assignment_type": null,
"timestamp": "2023-09-26T10:19:02.882Z",
"user_id": 13,
"shipment_id": 305,
"proof_of_delivery": [],
"service": "same_day",
"data": null
},
{
"created_at": "2023-09-25T09:04:57.049Z",
"updated_at": "2023-09-25T09:04:57.049Z",
"id": 1068,
"type": "webhook_sent",
"value": "shipment:created",
"shipping_account_id": 854855458,
"with_shipping_rules": false,
"timestamp": "2023-09-25T09:04:57.049Z",
"service": "standard"
},
{
"created_at": "2023-09-25T09:04:57.044Z",
"updated_at": "2023-09-25T09:04:57.044Z",
"id": 1067,
"type": "webhook_sent",
"value": "shipment:created",
"shipping_account_id": 854855458,
"with_shipping_rules": false,
"timestamp": "2023-09-25T09:04:57.039Z",
"service": "standard"
},
{
"created_at": "2023-09-25T09:04:57.014Z",
"updated_at": "2023-09-25T09:04:57.014Z",
"id": 1066,
"type": "status_update",
"value": "ReadyToShip",
"shipping_account_id": 854855458,
"with_shipping_rules": false,
"timestamp": "2023-09-25T09:04:57.013Z",
"service": "standard"
},
{
"created_at": "2023-09-25T09:04:57.014Z",
"updated_at": "2023-09-25T09:04:57.014Z",
"id": 1065,
"type": "carrier_assignment_success",
"value": null,
"shipping_account_id": 854855458,
"with_shipping_rules": false,
"timestamp": "2023-09-25T09:04:57.013Z",
"service": "standard"
},
{
"created_at": "2023-09-25T09:04:56.116Z",
"updated_at": "2023-09-25T09:04:56.116Z",
"id": 1064,
"type": "created",
"value": null,
"shipping_account_id": null,
"with_shipping_rules": false,
"timestamp": "2023-09-25T09:04:56.195Z",
"service": null
}
],
"packages_count": 1,
"tracking_url": "https://hub.bringg.com/#/track/b477ba?region=us-east-1",
"webhook_type": "shipment:cancelled"
}
| Parameter | Description |
|---|---|
delivery_costinteger | The amount charged to the customer to deliver this shipment. |
carrier_reference_numberstring | The carrier's ID for this shipment. |
discounts | Service discounts based on your contract with the carrier. |
fulfillment_id | Delivery Hub's ID for this fulfillment. |
idstring | The shipment ID. |
order_idstring | The ID of the shipment's parent order. |
service | The service level for the quoted or assigned booking, such as Standard or Express. |
shipping_account_iddouble | The shipping account used for the quoted or actual booking. |
source_idstring | Your source system's ID for this order. |
net_chargedouble | The shipment's base cost plus taxes and surcharges, as charged by the carrier. |
billing_address_id | Delivery Hub's ID for the order's billing address. |
tracking_numberstring | The tracking number provided by the carrier. |
surcharges | Extra costs charged by the carrier, such as for fuel or special handling. |
customerobject | The contact specifications for the customer. Includes: - name- email- allow_email- phone- allow_sms- id- account_id- created_at- updated_at |
taxes | Taxes attached to charges from carrier. |
quote_idstring | ID for the quote selected at checkout. |
namestring | The customer's first and last name. |
emailstring | The customer's email address. |
allow_emailboolean | If allow_email is true, send notifications to customer by email. |
phonestring | The customer's phone number. |
allow_smsboolean | If allow_sms is true, send notifications to customer by SMS. |
idstring | The customer's ID in your external system. |
account_idstring | The ID of your organization's Delivery Hub account. |
created_atstring | The date and time when the customer was created in Delivery Hub. |
updated_atstring | The date and time when the customer was updated in Delivery Hub. |
packages_countinteger | The number of packages included in this shipment. |
shipment_eventsobject | The specifications of the event that triggered this webhook. Includes: - id- shipment_id- value- account_id |
idstring | Delivery Hub's ID for the event. |
shipment_idstring | Delivery Hub's ID for this shipment. |
typestring | The trigger type for this webhook. Possible values: - status_update- checkpoint- carrier_assignment_failure- carrier_cancellation_failure- created- updated- carrier_assignment_success- carrier_cancellation_success- webhook_sent- print_job_created |
valuestring | The name and description of the event that triggered this webhook. |
account_id | The ID of your organization's Delivery Hub account. |
created_atstring | The date and time when this shipment was created in Delivery Hub. |
delete_atstring | The date and time when this shipment will be deleted from Delivery Hub. |
(Coming soon) recipient_startstring | The start of the dropoff time window. |
(Coming soon) recipient_endstring | The end of the dropoff time window. |
(Coming soon) sender_startstring | The start of the pickup time window. |
(Coming soon) sender_endstring | The end of the pickup time window. |
statusstring | The shipment's status. Possible values: - Quoted- New- PartiallyFulfilled- ReadyToShip- PickedUp- InTransit- OutForDelivery- Delivered- Exception- CanceledByCarrier- CanceledLearn more about Delivery Hub statuses. |
(Coming soon)typeenum | Designates if this shipment is a delivery or return. |
updated_atstring | The date and time when this shipment was updated in Delivery Hub. |
tracking_urlstring | The URL that your customer can use to track their order on Delivery Hub's tracking UI. |
shipments_packagesarray of objects | Specifications for each package included in this shipment. Includes: - id- package_id- order_id- fulfillment_id- shipment_id- label |
idstring | Delivery Hub's ID for this package. |
package_idstring | Delivery Hub's ID for the package type. |
tracking_numberstring | The tracking number provided by the carrier. |
order_idstring | Delivery Hub's ID for the parent order of this shipment. |
fulfillment_idstring | Delivery Hub's ID for the parent fulfillment of this shipment. |
shipment_idstring | Delivery Hub's ID for this shipment. |
labelstring | The URL of the shipping label. |