Bringg API Calls
You Need Your Authentication KeysAfter you Join as a Developer, use your access_token and secret_key for Signing a Bringg API Request.
Response Codes
200 - SuccessNOTE: An error response may be 200 and the error is described in the response.
400 - Bad Request
Paging
Bringg API Calls listing objects (Customers, Users, and Way_Points, for example) list 50 objects by default (the first page).
To see more objects, append the page parameter to your query string using an integer for the page number.
Timestamps
All timestamps in Bringg use the UNIX Epoch UTC timestamp format.
Current Time (Human Readable): "Wed, 07 Feb 2018 14:11:37 GMT"
UNIX Timestamp in Bringg: "2018-02-07T14:11:37Z"NOTE: "T" and "Z" - "2018-02-07T14:11:37Z "
Bringg Signature Tester
Bringg API Call List
Application
| Bringg API Call | Description |
|---|---|
| Add Application To Company | This Bringg API Call description is pending an update. |
| Update Company Application Configuration | This Bringg API Call description is pending an update. |
| Update User Configuration | This Bringg API Call description is pending an update. |
| Update Customer Configuration | This Bringg API Call description is pending an update. |
| Auto Dispatch Application | This Bringg API Call description is pending an update. |
| Auto Dispatch with inventory flow | This Bringg API Call description is pending an update. |
Companies
| Bringg API Call | Description |
|---|---|
| Companies | List companies in Bringg. |
| Get Company | Get the details of a company in Bringg. |
| Create Company | Add a new company to Bringg. |
| Update Company | Update the details of a company in Bringg. |
| Delete Company | Delete a company in Bringg. |
| Upload Company Delivery Pin | This Bringg API Call description is pending an update. |
| Upload Company Logo | This Bringg API Call description is pending an update. |
| Upload Company Destination Pin | This Bringg API Call description is pending an update. |
| Reset Company Delivery Pin | This Bringg API Call description is pending an update. |
| Reset Company Destination Pin | This Bringg API Call description is pending an update. |
Customers
| Bringg API Call | Description |
|---|---|
| Customers | List all customers. |
| Get Customer | Get the details of a customer by the customer Id. |
| Get By Phone | Show the details of a customer by the customer phone number. |
| Create Customer | Add a new customer. |
| Update Customer | Update a customer's details. |
| Delete Customer | Delete a customer. |
| Customer Count | Get the total number of customers. |
Inventories
| Bringg API Call | Description |
|---|---|
| Inventories | This Bringg API Call description is pending an update. |
| Get Inventory | This Bringg API Call description is pending an update. |
| Create Inventory | This Bringg API Call description is pending an update. |
| Update Inventory | This Bringg API Call description is pending an update. |
| Delete Inventory | This Bringg API Call description is pending an update. |
| Set Quantity | This Bringg API Call description is pending an update. |
| Get Quantity | This Bringg API Call description is pending an update. |
| Delete Quantity | This Bringg API Call description is pending an update. |
Place
| Bringg API Call | Description |
|---|---|
| Create Place | Add a new place. |
Tasks (Orders)
| Bringg API Call | Description |
|---|---|
| Get Task | Get the details of a order (task). |
| Opened Tasks | List opened (not completed or cancelled) orders (tasks). |
| Create Task | Add a new order (task). |
| Create Task with Way Points | Add a new order (task) with way points (more than one stop). |
| Create Task From CSV | This Bringg API Call description is pending an update. |
| Update Task | Update the details of an order (task). |
| Add Task To Team | Assign an order (task) to a team of users (drivers). |
| Cancel Task | Cancel an open order (Task). |
| Start Task | Start a order (task). |
| Get Task Locations | This Bringg API Call description is pending an update. |
| Get Share | This Bringg API Call description is pending an update. |
Teams
| Bringg API Calls | Description |
|---|---|
| Teams | List the teams. |
| Create Team | Add a new team. |
| Update Team | Update the details of a team. |
| Delete Team | Delete a team. |
| Add User To Team | Add a user (driver) to a team. |
| Remove User From Team | Remove a user (driver) from a team. |
Users
| Bringg API Call | Description |
|---|---|
| Users | List the users (drivers, dispatchers, admins). |
| Get User | Get the details of a user. |
| Create User | Add a new user. |
| Add User To Team | Add a user to a team. |
| Update User | Update the details of a user. |
| Delete User | Delete a user. |
| Upload User Profile Image | Upload an image to the user profile. |
| Update User Location | Update a user's location. |
| User Count | Get the total number of users. |
| Schedule | This Bringg API Call description is pending an update. |
Way Points
| Bringg API Call | Description |
|---|---|
| Create Way Point | Add a new way point in an order (task). |
| Update Way Point | Update a way point in an order (task). |
| Get Way Point | Get the details of a way point in an order (task). |
| Create Route | Add a route to a task. |
| Add extra customers to way point | Add customers to way points in an order (task). |
| Create Note | Add a note to a way point in an order (task). |
| Update Note | Update a note in a way point in an order (task). |
Updated about 1 year ago
Did this page help you?

