Jump to Content

Guides API Reference

API Reference

Guides API Reference

About

Welcome to Bringg's API Reference
Changelog

Order APIs

Orders
Recurring Orders
Packages
Inventory
- Create Inventorypost
- Update Inventorypost

order scheduling apis

Get Quotespost
Delivery Slots
Blackouts

resource apis

Get Companies
Teams
Users
Vehicles
Vehicle Profiles
Parking Spots
Delivery Blocks
Delivery Block Assignments
JSONL Bulk Import

management apis

Preset Route Identifiers
- Create Preset Route Identifierpost
- Update Preset Route Identifierpatch
Order Configurations
- Create Order Configurationpost
- Update Order Configurationpost
Customers
- Create Customerpost
- Update Customerpost
Service Areas
Service Plans
Blacklisted Driver Assignments

driver action apis

Start Orderpost
End Orderpost
Floating Inventory
Notes
- Create Notepost
- Update Notepost
Driver Location
Driver Shifts

Assignment APIs

Assign Driver to Routepost
Unassign Driver from Routepost
Assign Order to Driverpost
Assign Vehicle to Routepost
Release Orderspost
Unassign Vehicle from Routepost

analytics apis

Generate Undelivered Webhooks Reportpost
Get Reportget
Get Analytics Reportget

other APIs

Obtain Oauth Credentialsget
Async Process Statusget
Create Order Payment Detailspost
Generate Pickup QR Codepost

Webhooks

Webhooks Index
Customer Events
Driver Events
Order Events
Route (Run) Events
Waypoint Events

Objects

Customer Object
Delivery Slot Object
Order (Task) Object
Order Cancellation Reasons Object
Order Inventories Object
Order Notes Object
Order Status
Package Object
Parking Spot Object
Quotes object
Run Object
User Object
Vehicle Object
Waypoint Object

Fleet Self-Registration

Bringg API Terms of Service
Overview
Get Started With Sandbox
Conducting End-To-End Test
Getting Certified
Merchant Adds Your Fleet
Webhooks
API Calls
Troubleshooting

About

Welcome to Bringg's API Reference
Changelog

Order APIs

Orders
Recurring Orders
Packages
Inventory
- Create Inventorypost
- Update Inventorypost

order scheduling apis

Get Quotespost
Delivery Slots
Blackouts

resource apis

Get Companies
Teams
Users
Vehicles
Vehicle Profiles
Parking Spots
Delivery Blocks
Delivery Block Assignments
JSONL Bulk Import

management apis

Preset Route Identifiers
- Create Preset Route Identifierpost
- Update Preset Route Identifierpatch
Order Configurations
- Create Order Configurationpost
- Update Order Configurationpost
Customers
- Create Customerpost
- Update Customerpost
Service Areas
Service Plans
Blacklisted Driver Assignments

driver action apis

Start Orderpost
End Orderpost
Floating Inventory
Notes
- Create Notepost
- Update Notepost
Driver Location
Driver Shifts

Assignment APIs

Assign Driver to Routepost
Unassign Driver from Routepost
Assign Order to Driverpost
Assign Vehicle to Routepost
Release Orderspost
Unassign Vehicle from Routepost

analytics apis

Generate Undelivered Webhooks Reportpost
Get Reportget
Get Analytics Reportget

other APIs

Obtain Oauth Credentialsget
Async Process Statusget
Create Order Payment Detailspost
Generate Pickup QR Codepost

Webhooks

Webhooks Index
Customer Events
Driver Events
Order Events
Route (Run) Events
Waypoint Events

Objects

Customer Object
Delivery Slot Object
Order (Task) Object
Order Cancellation Reasons Object
Order Inventories Object
Order Notes Object
Order Status
Package Object
Parking Spot Object
Quotes object
Run Object
User Object
Vehicle Object
Waypoint Object

Fleet Self-Registration

Bringg API Terms of Service
Overview
Get Started With Sandbox
Conducting End-To-End Test
Getting Certified
Merchant Adds Your Fleet
Webhooks
API Calls
Troubleshooting

Floating Inventory

Floating inventory are items that are not connected with a specific order in Bringg, such as items that travel with the driver to be used as spare parts or for upsell.