OAuth 2.0 URLs

Access Bringg's API using either service or OAuth 2.0 URLs. Generate unique service URLs in the Bringg platform, or use the OAuth 2.0 format detailed below.

Before you begin, follow the steps in Bringg API Access Management to obtain an authentication token.


All Bringg OAuth 2.0 URLs are structured as follows:https://< domain >/services/< service name identifier >.

  • < domain > is based on the relevant Bringg distributed server.
  • All Bringg API URLs include/services/ after the domain and before the endpoint-specific identifier.
  • < service name identifier > is unique to each Bringg endpoint. See the complete list below.

For example, the OAuth 2.0 URL for the Create Order endpoint using the US2 server looks like this:
<https://us2-admin-api.bringg.com/services/create_task>

📘

API Domains and Regional Endpoints

Each Bringg merchant (and its associated data) is hosted and managed on one of Bringg's distributed server regions. Each server region is geographically and physically separated from the others, but for most purposes, public access is via a common, security gateway: app.bringg.com.

For some API purposes however - such as for OAuth 2.0 - it may be required to call your own server region's endpoints directly. In these cases, please substitute the domains as follows:

US2: https://us2-admin-api.bringg.com
US3: https://us3-api.bringg.com
EU2: https://eu2-admin-api.bringg.com
EU3: https://eu3-admin-api.bringg.com


NAMESERVICE NAME IDENTIFIER
Create Order (Task)create_task
Update Orderupdate_task
Start Orderstart_task
End Order (Task)end_task
Cancel Order (Task)cancel_task
Get Orderget_task
Get Open Orders (Tasks)get_open_tasks
Create Notecreate_note
Update Noteupdate_note
Arrived to Destination (Check in)checkin
Left Destination (Checkout)checkout
Get Post Optimization Orders (Tasks)get_post_optimization_tasks
Create Customercreate_customer
Update Customerupdate_customer
Create User
(i.e. Driver / Dispatcher/ Admin)
create_user
Update User
(i.e. Driver / Dispatcher/ Admin)
update_user
Get Userget_user
Delete Userdelete_user
Start Shiftstart_shift
End Shiftend_shift
Driver Home Eventsdriver_home_events
Create Teamcreate_team
Update Teamupdate_team
Show All Teamsteam_index
Get Team Detailsget_team
Delete Teamdelete_team
Get Shareget_share
Get Quotesget_quotes
Create Order Configurationcreate_task_configuration
Get Driver Availabilityget_realtime_availability
Generate Driver QR Codegenerate_driver_qr_code
Create Delivery Blockcreate_delivery_block
Get Delivery Blockget_delivery_block
Assign Delivery Block to Driverassign_delivery_block
Unassign Delivery Block from Driverunassign_delivery_block
Update Delivery Blockupdate_delivery_block
Delete Delivery Blockdelete_delivery_block
Get Drivers' Delivery Blocksusers_delivery_blocks
Team Delivery Blocksteam_delivery_blocks
Generate Pickup QR Codegenerate_pickup_qr_code
Create Parking Spotcreate_parking_spot
Update Parking Spotupdate_parking_spot
Get All Parking Spotsget_parking_spot
Get Parking Spot by IDget_by_id_parking_spot
Delete Parking Spotdelete_parking_spot
Create Vehiclecreate_vehicle
Update Vehicleupdate_vehicle
Get Vehicle by IDget_vehicle_by_id
Get All Vehiclesget_all_vehicles
Delete Vehicle by IDdelete_vehicle
Create Order Payment Detailscreate_task_payment_history
Create Delivery Slotcreate_planned_delivery_window
Update Delivery Slotupdate_planned_delivery_window
Generate Undelivered Webhooks Reportget_undelivered_webhooks
Get Reportget_report
Create Order Refundcreate_task_refund