API Reference

Changelog

# December 23, 2024

Removed the password field from the Create User and Update User APIs as passwords are now set by the users themselves.

# December 3, 2024

Notes sent in the Update Order API will now be added as new notes to the order. Payload example added.

November 12, 2024

API pages for Fleet Self-Integration now include the API endpoint URL and Method.

October 7, 2024

You can now manage planned route identifiers using Bringg's API:

September 10, 2024

You can now set driver-specific costs to improve route optimization by favoring drivers based on their specific skills and associated costs. The driver_cost object is available in the Create User, Update User, and Get User endpoints.

July 31, 2024

You can now use OAuth 2.0 to access the Get Report and Generate Undelivered Webhooks Report endpoints:

EndpointOAuth 2.0 URLRequired scopes
Get Report/services/get_reportlegacy_report_read
Generate Undelivered Webhooks/services/get_undelivered_webhooksreport_read

July 30, 2024

The following parameters are now available for the Optimization Applied webhook:

  • origin: The system or action that initiated route optimization.
    This parameter is available for flexible webhooks. To include it in your webhooks, go to Settings > Platform Integrations > Webhooks, select Edit or Add Webhook, then select the field under Webhook Data.
  • reason: If an order could not be assigned by route optimization, the reason it could not be assigned is included.
  • reason_code: Bringg's error code for an order that could not be assigned.

Note that reasons are not included for orders that have already been manually assigned post-optimization.

July 4, 2024

  • Introducing new vehicle endpoints! Using Bringg's API, you can now perform the following actions:
  • The kind parameter now includes business as an additional enum option. When business is selected, Bringg retains the business's data beyond 45 days after its last order is fulfilled, in line with Bringg's data privacy policy.

June 2, 2024

You can now use the Bringg API to manage parking spots!

Visit Parking Spot Object to learn more.

May 30, 2024

Webhooks and API responses that include the order (task) object can now include the external_carrier_tracking_url parameter.

This parameter provides a link that your customers can use to track their orders via the carrier's tracking platform and can be included in flexible webhooks by selecting the task_fleet_mapping > shared_extras field.

Learn more about configuring webhooks in Bringg.

May 28, 2024

Responses to the Get User endpoint now include the team_external_ids array, making it easier to determine which team a user is associated with in Bringg.

May 20, 2024

Responses to Create Package and Update Package now include the fleet_package_label_id parameter. This parameter specifies the package's unique barcode ID, which can be included on carrier labels and used to match packages with their orders if the main label is lost or if the carrier sends updates using their own barcode.

May 15, 2024

The default logic for the kind parameter has been updated:

  • For orders with a single waypoint, the waypoint kind is defined as Customer.
  • For orders with two waypoints, the first waypoint (pickup) kind is defined as Warehouse, and the second waypoint (drop off) is defined as "Customer".

You can still define a waypoint as a different type by including an integer value with the kind parameter:

  • 0 - Customer
  • 1 - Warehouse
  • 2 - Store
  • 3 - Locker
  • 4 - Fulfillment center

May 8, 2024

We are rolling out a change to the task_inventories object:

The inventory_change_details object is now only populated when there are rejected inventory items to report. If no rejections occur, the object is included as an empty array. To ensure seamless integration, we recommend updating your systems to effectively handle empty arrays in API responses and webhooks.
​
Example of inventory_change_details with no rejections:

"task_inventories": \[  
  {  
    "id": 334343988,  
    "quantity": 5,  
    "scanned": false,  
    "original_quantity": 5,  
    "rejected_quantity": 0,  
    "external_id": "2145",  
    "name": "Icebox Fridge 32'",  
    "inventory_change_details": \[]  
  }  
]

📘

Best Practice

As inventory_change_details will show up as an empty array when there are no inventory rejections to report, we recommend ensuring your external systems can handle an empty array.

April 3, 2024

The Order (Task) Object now includes the planned_distance_from_prev_task parameter in webhooks and responses related to orders planned using Route Optimization or the route planner. The parameter indicates the distance to the order in question from the location of the preceding order in the route.

March 14, 2024

The Get Quotes endpoint now includes the fill_ratio parameter, which indicates the percentage of each delivery slot that is already booked. This can be used to determine pricing or the need for additional resources.

Examples of values:

  • 0 - the slot is empty
  • 0.36 - the slot is 36% full
  • 1 - the slot is full

March 4, 2024

You can now set delivery terms as hard constraints to prevent Bringg from requesting quotes from carriers that do not meet the requirements of an order.

  • When a delivery term is set as a hard constraint, carriers that do not meet an order's requirements do not appear in the Get Quotes response.
  • When a delivery term is not set as a hard constraint, it is considered a soft constraint. When a carrier with a soft constraint does not meet the requirements of an order, the carrier is included in the Get Quotes response with "delivery_terms_supported": false.

    📘

    Best Practice

    As hard constraints do not provide results that include "delivery_terms_supported": false, we recommend updating the way your external systems listen to responses from Bringg so that they do not rely on the existence of this field.

February 20, 2024

As part of Bringg's upgraded secured onboarding, new users receive an email prompting them to set up their initial password. As user passwords are now created by the user themselves, the password parameter in the Create User and Update User requests have been deprecated.

February 5, 2024

Failed delivery attempts of webhooks that were eventually delivered successfully in final attempts will no longer be logged as failed webhooks and won't be reported in the "Generate Undelivered Webhooks Report" API.

January 22, 2024

You can now view which system or user initiated a change in scheduling for an order. The Destination Rescheduled webhook now includes the following parameters:

  • time_window_change_origin: The system, process, or user action that initiated a change in the time window for a waypoint.
  • workflow_id: When a change was triggered by an automation, the ID of that automation.

January 8, 2024

The coordinates in the polygon array should now be ordered by [latitude, longitude] when added to service areas via CSV upload, entry in the UI, and creation or update via API.

December 17, 2023

  • You can now send driver skills to Bringg as part of the Create User and Update User payloads.
    For example: 
      "external_id": "ABC123",
  "name": "Steve",
  "skills": [
    "Electrician",
    "TV Installation"
  ]
  • Welcome to the Bringg API changelog!