API Reference

Order Accepted by Carrier

This webhook is triggered when the carrier returns a success:true response after Bringg sends an order to them.

📘

Register Your URL for this Webhook

To start receiving webhooks from Bringg, you must first register a URL. Detailed guidance on setting up and managing Bringg webhooks is available in the following resources:


Webhook Example

{
  "task": {
    "id": 84953222,
    "title": "782542792992-1626349317",
    "external_id": "1626349317-R0",
    "fleet_delivery_external_id": "ABCD1234",
    "fleet": {
      "id": 270,
      "name": "Acme Fleet"
    }
  },
  "webhook_type": "order_accepted_by_fleet",
  "merchant_id": 49,
  "task_fleet_mapping": {
    "shared_extras": {
      "external_carrier_tracking_url": "https://www.example.com/track?waybill=123456789012345678901234"    }
  }
}
{
   "task": {
      "id": 10010001,
      "updated_at": "2024-08-30T10:36:32.898Z",
      "pudo_partner_id": "5678",
      "tracking_number": "ABC987654321"
   },
   "active_way_point_id": 21000001,
   "fleet_delivery_external_id": "ABC987654321",
   "title": "Order 105-303-123456",
   "external_id": "105-303-123456",
   "fleet": {
      "id": 3001,
      "external_id": "5678",
      "name": "Fast Track Logistics"
   },
   "way_points": [
      {
         "id": 21000001,
         "position": 1,
         "pickup_dropoff_option": 0,
         "extras": {},
         "customer": {
            "external_id": "401"
         }
      },
      {
         "id": 21000002,
         "position": 2,
         "pickup_dropoff_option": 1,
         "extras": {},
         "customer": {
            "external_id": "6000002"
         }
      }
   ],
   "task_inventories": [
      {
         "way_point_id": 21000001,
         "external_id": "91000001"
      },
      {
         "way_point_id": 21000002,
         "external_id": "91000001"
      }
   ],
   "service_plan": {
      "name": "Standard Delivery",
      "external_id": "88888888"
   },
   "task_fleet_mapping": {
      "merchant_id": 80001,
      "task_id": 10010001,
      "id": 3100001,
      "fleet_delivery_mapping_id": "ABC987654321",
      "fleet_id": 3001,
      "data": {
         "merchant_id": 80001,
         "task_id": 10010001,
         "fleet_id": 3001,
         "fleet_type_id": 32,
         "fleet_delivery_external_id": "ABC987654321",
         "delivery_id": "ABC987654321",
         "team_id": 5001,
         "way_points": [
            {
               "id": 21000001,
               "pickup_dropoff_option": 0,
               "position": 1,
               "merchant_id": 80001
            },
            {
               "id": 21000002,
               "pickup_dropoff_option": 1,
               "position": 2,
               "merchant_id": 80001
            }
         ],
         "cache_fields": null,
         "packages": [
            {
               "id": 5100001,
               "external_id": "234567890123456789",
               "fleet_external_id": null,
               "label_url": null,
               "name": null,
               "description": "Express Shipping Box",
               "notes": null,
               "sequence_number": null,
               "merchant_id": 80001,
               "weight_value": 90,
               "weight_unit": "g",
               "volume_value": 450,
               "volume_unit": "cm3",
               "width_value": 240,
               "width_unit": "mm",
               "height_value": 35,
               "height_unit": "mm",
               "length_value": 55,
               "length_unit": "mm",
               "extras": {},
               "created_at": "2024-08-30T10:36:32.068Z",
               "updated_at": "2024-08-30T10:36:32.068Z",
               "delete_at": null,
               "generating_duration_ms": null,
               "fleet_package_label_id": null,
               "label_base64": null
            }
         ]
      },
      "created_at": "2024-08-30T10:36:32.826Z",
      "updated_at": "2024-08-30T10:36:32.826Z",
      "delete_at": null,
      "shared_extras": {
         "external_carrier_tracking_url": "https://www.example.com/track/ABC987654321"
      }
   },
   "webhook_type": "order_accepted_by_fleet",
   "merchant_id": 80001
}

Output Params

fleet_delivery_external_id

string

ID of the order/delivery in the fleet's system. Use this field to map your orders to the fleet's orders.

shared_extras

object

The content of 'fleet_extras' received from the interactions with the fleet above.