Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.
OAuth 2.0 · Connector Profile
Requires creating an OAuth2 API app in Bringg. Access is limited to the scopes selected on that app, and tokens are re-i…
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
OAuth 2.0 · Link Account
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
55 actions
Action
Description
Generate Undelivered Webhooks Report
This API retrieves a list of webhooks which Bringg sent without receiving a confirmation during a specified time period…
Get Report
Use this API to get the latest version of a scheduled analytics report. This method redirects requests to a data file.
Create Customer
Use to create a new customer.
Update Customer
Use to update a customer’s details.
Create Delivery Block (Resource-based Optimization)
Create a new delivery block that considers resource availability, and allows you to add and pair drivers and vehicles wi…
Get Delivery Block
Get the details of a delivery block by delivery block Id.
Assign Delivery Block To Driver
Assign a driver or drivers to a delivery block by driver ID(s) and delivery block ID.
Unassign Delivery Block From Driver
Unassign a delivery block from a driver or drivers by driver Id(s) and delivery block Id.
Update Delivery Block (Resource-based)
Make updates to an existing delivery block, including adding or removing resources.
Delete Delivery Block
Delete a delivery block by its Bringg delivery block ID, removing its driver and vehicle resource assignments.
Get Drivers’ Delivery Blocks
Gets a list of delivery blocks assigned to specified drivers by time range.
Get Team Delivery Blocks
Gets a list of delivery blocks assigned to a specific team by time range.
Create Delivery Slot
Create delivery slots (previously known as Planned Delivery Windows) to represent fulfillment availability by time and d…
Update Delivery Slot
Update delivery slots (previously known as Planned Delivery Windows) to allow customers to schedule their orders.
Check-in (Arrived To Destination)
Use to indicate that the driver arrived at a destination in the order.
Checkout (Left Destination)
Use to indicate the driver left a destination. If the driver checks out of the last destination, then this API call will…
Initiate Driver Home Events
Use to determine whether a driver is at or has departed their “home” base.
Get Driver Availability
Use to get the driver availability details of drivers in the teams you specify.
Start Shift
Use to start a driver’s shift.
End Shift
Use to end a driver’s shift.
Generate Driver QR Code
Use to generate an access token and secret key for the Driver App QR Code login of a specified driver.
Create Note
Use to create a note for a waypoint.
Update Note
Make text updates to an existing note
Create Order Configuration
Use to create task configurations which are sets of operational capabilities you can apply to specific sets of tasks usi…
Create Order (Task)
Send the details of a new order to Bringg from your Order Management System (OMS).
Update Order
Update the details of an order (also known in Bringg as a task).
Start Order
Use to start an order (task).
End Order
Use to end an order (task).
Cancel Order (Task)
Use to cancel an active order (task).
Get Order
Get the details of an order using its id or external_id. The response also includes details of any linked orders.
Get Open Orders (Tasks)
Use to get a list of open orders.
Get Post Optimization Orders (Tasks)
Get a list of post-optimization orders.
Create Order Refund
Use this API to create an order refund in Bringg. This is used in Analytics reports only.
Generate Pickup QR Code
Use to generate QR Code for a task to be scanned by the driver
Create Parking Spot
Use this endpoint to create a parking spot in Bringg and associate it with a specified team and address.
Update Parking Spot
Update a parking spot using either the ID created by Bringg or your external ID.
Get All Parking Spots
Get the details of all parking spots.
Get Parking Spot By ID
Get a parking spot using either the ID created by Bringg or your external ID.
Delete Parking Spot
Delete a parking spot using either the ID created by Bringg or your external ID.
Get Quotes
The quotes service check when, who, and at what cost an order can be delivered, considering the order’s requirements. Th…
Create Team
Create a new team (fleet, store or warehouse group) in Bringg with its address, contact details and dispatch settings.
Update Team
Update the details of a team using its Bringg ID or your system’s ID (external_id).
Show All Teams
Use to return all the teams for a merchant.
Get Team Details
Get the details of a team using its Bringg id.
Delete Team
Delete a team from Bringg using its Bringg team ID.
Create User
Create a new driver or dispatcher in Bringg.
Update User
Update a user’s details by external_id or Bringg id.
Get User
Get the details of a user (driver, dispatcher, or admin) using their external_id or Bringg id.
Delete User
Use to delete a user (driver, dispatcher, or admin).
Create Vehicle
Use to create a vehicle or trailer in Bringg.
Get Vehicle
Get the details of a specific vehicle using its external_id or the id generated by Bringg.
Get All Vehicles
Get the details of all vehicles in Bringg.
Update Vehicle
Update the details of a vehicle or trailer in Bringg, for example to assign a team or parking spot.
Delete Vehicle
Delete a specific vehicle using its external_id or the id generated by Bringg.
Get All Vehicle Profiles
Retrieve a list of all vehicle profiles (vehicle types) for your merchant.