-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapis.yml
More file actions
332 lines (332 loc) · 13.2 KB
/
Copy pathapis.yml
File metadata and controls
332 lines (332 loc) · 13.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
aid: bringg
url: https://raw.githubusercontent.com/api-evangelist/bringg/refs/heads/main/apis.yml
apis:
- aid: bringg:bringg-delivery-hub-api
name: Bringg Delivery Hub API
tags:
- Last-Mile Delivery
- Orders
- Dispatch
- Routing
- Service Areas
- Service Plans
- Quotes
- Inventory
- Analytics
humanURL: https://developers.bringg.com/reference/welcome-to-bringgs-api-reference
baseURL: https://us2-admin-api.bringg.com
properties:
- url: https://developers.bringg.com/reference/welcome-to-bringgs-api-reference
type: Documentation
- url: https://developers.bringg.com/docs/overview
type: Documentation
- url: https://developers.bringg.com/docs/rest
type: Documentation
- url: https://developers.bringg.com/docs/bringg-api-access-management
type: Authentication
- url: https://developers.bringg.com/docs/oauth-20-urls
type: Authentication
- url: openapi/bringg-delivery-hub-api-openapi.yml
type: OpenAPI
- url: json-schema/bringg-order-schema.json
type: JSONSchema
- url: json-schema/bringg-customer-schema.json
type: JSONSchema
- url: json-schema/bringg-waypoint-schema.json
type: JSONSchema
- url: json-schema/bringg-run-schema.json
type: JSONSchema
- url: json-structure/bringg-order-structure.json
type: JSONStructure
- url: json-ld/bringg-context.jsonld
type: JSONLD
- url: examples/bringg-create-task-example.json
type: Examples
- url: graphql/bringg-graphql.md
type: GraphQL
description: Bringg's REST orchestration API for the Delivery Hub — create and manage
orders (tasks), runs (routes), customers, teams, service areas, service plans,
planned delivery windows (delivery slots), exclusion windows (blackouts), parking
spots, packages, inventory, floating inventory, recurring orders, delivery blocks,
vehicles, and analytics reports. All endpoints use OAuth 2.0 Client Credentials
Grant against region-specific GCP base URLs (US2/US3/US4, EU2/EU3).
- aid: bringg:bringg-drivers-shifts-api
name: Bringg Drivers And Shifts API
tags:
- Drivers
- Shifts
- Users
- Delivery Blocks
- Vehicles
- Fleet
humanURL: https://developers.bringg.com/reference/driver-shifts
baseURL: https://us2-admin-api.bringg.com
properties:
- url: https://developers.bringg.com/reference/driver-shifts
type: Documentation
- url: https://developers.bringg.com/reference/users-3
type: Documentation
- url: https://developers.bringg.com/reference/vehicles
type: Documentation
- url: https://developers.bringg.com/reference/delivery-blocks
type: Documentation
- url: openapi/bringg-drivers-shifts-api-openapi.yml
type: OpenAPI
- url: json-schema/bringg-driver-schema.json
type: JSONSchema
description: Manage Bringg drivers, user roles, shifts, real-time availability,
driver location updates, delivery blocks (shift slots), QR-code-based login, and
vehicles with vehicle profiles. Backs the Bringg Driver App and dispatcher workflows;
uses OAuth 2.0 Client Credentials Grant.
- aid: bringg:bringg-fleet-partners-api
name: Bringg Fleet Partners API
tags:
- Fleet Partners
- Self-Integrated Fleets
- Carrier Integration
- Quotes
- Webhooks
humanURL: https://developers.bringg.com/reference/overview-1
baseURL: https://app.bringg.com
properties:
- url: https://developers.bringg.com/reference/overview-1
type: Documentation
- url: https://developers.bringg.com/reference/how-to-get-started
type: GettingStarted
- url: https://developers.bringg.com/reference/getting-certified
type: Documentation
- url: https://developers.bringg.com/reference/how-to-conduct-and-end-to-end-test
type: Documentation
- url: https://developers.bringg.com/reference/webhooks
type: Documentation
- url: https://developers.bringg.com/reference/webhooks-index
type: Documentation
- url: openapi/bringg-fleet-partners-api-openapi.yml
type: OpenAPI
- url: asyncapi/bringg-webhooks-asyncapi.yml
type: AsyncAPI
description: Integration surface for delivery providers and self-integrated fleets
connecting to the Bringg Delivery Hub. Partners host webhook endpoints Bringg
calls (Delivery Created, Get Quote, Delivery Updated, Delivery Cancelled, Merchant
Registered, Return Delivery Created) and expose endpoints for order acceptance,
status updates, driver location, and proof of delivery. Used by 250+ third-party
carriers and crowdsourced fleets in the Bringg Carrier Network.
name: Bringg
tags:
- Last-Mile Delivery
- Delivery Orchestration
- Fulfillment
- Logistics
- Retail
- Dispatch
- Routing
- Driver App
- Carrier Network
- Fleet Management
- Supply Chain
- E-commerce
- Same-Day Delivery
- Curbside Pickup
- Returns
kind: contract
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
access: 3rd-Party
common:
- type: AgenticAccess
url: agentic-access/bringg-agentic-access.yml
- type: TrustCenter
url: security/bringg-trust-center.yml
- type: DomainSecurity
url: security/bringg-domain-security.yml
- type: Authentication
url: authentication/bringg-authentication.yml
- type: OAuthScopes
url: scopes/bringg-scopes.yml
- type: Portal
url: https://www.bringg.com
- type: Documentation
url: https://developers.bringg.com
- type: Documentation
url: https://developers.bringg.com/reference/welcome-to-bringgs-api-reference
name: Bringg API Reference
- type: Documentation
url: https://developers.bringg.com/v2.0/docs/overview
name: Bringg API Documentation (legacy v2.0)
- type: GettingStarted
url: https://developers.bringg.com/docs/overview
- type: Authentication
url: https://developers.bringg.com/docs/bringg-api-access-management
- type: Authentication
url: https://developers.bringg.com/docs/oauth-20-urls
- type: ErrorCodes
url: https://developers.bringg.com/docs/errors
- type: Webhooks
url: https://developers.bringg.com/docs/bringg-webhooks
- type: Webhooks
url: https://developers.bringg.com/reference/webhooks-index
- type: Documentation
url: https://developers.bringg.com/docs/webhook-authentication-methods
name: Webhook Authentication Methods
- type: Documentation
url: https://developers.bringg.com/docs/data-formatting
name: Data Formatting
- type: Documentation
url: https://developers.bringg.com/docs/bringg-system-requirements
name: Bringg Device Requirements
- type: ChangeLog
url: https://developers.bringg.com/reference/changelog
- type: StatusPage
url: https://status.bringg.com
- type: TermsOfService
url: https://developers.bringg.com/reference/terms-of-service
- type: KnowledgeBase
url: https://help.bringg.com
- type: Blog
url: https://www.bringg.com/resources/blog
- type: Portal
url: https://www.bringg.com/platform/
name: Bringg Platform
- type: Portal
url: https://www.bringg.com/carrier-network/
name: Bringg Carrier Network
- type: Portal
url: https://www.bringg.com/about/
name: About Bringg
- type: SDKs
url: https://developers.bringg.com/docs/dashboard-sdk-resources
name: Bringg Dispatcher SDK (JavaScript)
- type: SDKs
url: https://github.com/bringg/Bringg-iOS-DriverSDK
name: Bringg iOS Driver SDK
- type: GitHubOrganization
url: https://github.com/bringg
- type: LinkedIn
url: https://www.linkedin.com/company/bringg
- type: Twitter
url: https://twitter.com/bringg
- type: Signup
url: https://www.bringg.com/contact-us/
- type: Plans
url: plans/bringg-plans-pricing.yml
- type: RateLimits
url: rate-limits/bringg-rate-limits.yml
- type: FinOps
url: finops/bringg-finops.yml
- type: Features
data:
- Last-mile delivery orchestration across own fleet and third-party fleets in a
single platform
- Modular product suite — Shopping Experience, Plan, Dispatch, Drive, Delivery Experience
- Bringg Connect carrier network with 250+ third-party, crowdsourced, and autonomous
carriers across 70+ countries
- Automation Center for no-code workflow automation
- Intelligence module for dashboards, reporting, and cost/profit/driver-performance
insights
- REST APIs for orders, runs, drivers, vehicles, service areas, service plans, planned
delivery windows, blackouts, packages, inventory, floating inventory
- 50+ outbound webhook event types covering order, driver, run, customer, waypoint,
and inventory lifecycle
- OAuth 2.0 Client Credentials Grant authentication with configurable token TTLs
(default 30 min write, 4 hr read)
- Regional deployments on Google Cloud Platform (US2, US3, US4, EU2, EU3) with per-region
status and billing
- JSONL bulk upload pipeline (prepare/upload/process/results) for large data loads
- Bringg Driver App (iOS, Android) with offline support, geofence-powered visibility,
and configurable workflows
- Bringg Dispatcher web app and JavaScript SDK for embedded dispatch UX
- Bringg Services — tokenless, GUID-based URLs for limited merchant operations without
auth
- Quotes and Availability API for multi-carrier quoting before order placement
- Recurring orders, delivery blocks, vehicle profiles, parking spots, and service-area
polygons
- Statuspage at status.bringg.com with per-region component status across 13 components
(Auth, API, Customer Experience, Delivery Partners, Dispatch, Driver App, Geolocation,
Infrastructure, Inventory, Notifications, Planning, Reporting, Billing)
- Used by enterprise retailers including Best Buy, AutoZone, ASDA, Wegmans, FedEx
Office, Metro, uBreakiFix, and B&Q
- 800+ customers and 200 million annual deliveries
sources:
- https://www.bringg.com/
- https://www.bringg.com/platform/
- https://developers.bringg.com/
- https://developers.bringg.com/llms.txt
- https://developers.bringg.com/docs/oauth-20-urls
- https://status.bringg.com/
updated: '2026-05-25'
- type: Modules
data:
- name: Shopping Experience
description: Optimize delivery options during checkout with dynamic slots and
on-demand options.
- name: Plan
description: Resource management and route optimization across fleets, including
continuous route optimization and carrier selection.
- name: Dispatch
description: Single-pane monitoring of order progress with real-time fleet visibility,
exception handling, and automated dispatch.
- name: Drive
description: iOS and Android driver applications with customized workflows, task
management, and geofence-powered delivery visibility.
- name: Delivery Experience
description: Customer-facing notifications, tracking, ETAs, and branded communication
throughout the delivery process.
- name: Automation Center
description: No-code workflow automation across the Bringg platform.
- name: Intelligence
description: Dashboards, reporting, and insights on cost, profit, and driver performance.
- name: Connect
description: REST APIs, webhooks, and integrations with OMS, ERP, eCommerce, WMS,
and TMS systems plus the Bringg Carrier Network.
- type: Solutions
data:
- name: Retail Same-Day Delivery
description: Enable same-day, scheduled, and curbside fulfillment for enterprise
retailers.
- name: Returns
description: Orchestrate return pickups and reverse logistics.
- name: Carrier Network Access
description: Plug into 250+ pre-integrated third-party fleets through a single
integration.
- name: Driver Productivity
description: Equip drivers with the Bringg Driver App, optimized routes, and geofence-aware
workflows.
- type: Integrations
data:
- category: Carriers and crowdsourced fleets
examples:
- DoorDash
- Postmates
- Uber
- Lyft
- Glovo
- Bringg Carrier Network 250+
- category: OMS / ERP
description: REST APIs and webhooks for OMS/ERP synchronization.
- category: eCommerce
description: Order intake and shopping-experience integration.
- category: WMS / TMS
description: Warehouse and transportation system integration.
created: '2026-05-25T00:00:00.000Z'
modified: '2026-05-25'
position: Consuming
description: Bringg is a last-mile delivery and fulfillment orchestration platform
headquartered in Tel Aviv (founded 2013, CEO Guy Bloch). The Bringg platform combines
modular software (Shopping Experience, Plan, Dispatch, Drive, Delivery Experience,
Automation Center, Intelligence, Connect) with the Bringg Carrier Network — 250+
pre-integrated third-party, crowdsourced, and autonomous carriers across 70+ countries
— to give enterprise retailers and logistics providers a single integration point
for orchestrating own-fleet and partner-fleet deliveries. Bringg's developer surface
exposes a REST Delivery Hub API for orders/runs/customers/teams/service areas/service
plans/delivery slots/blackouts/inventory/packages, a Drivers & Shifts API for users/shifts/delivery-blocks/vehicles,
a Fleet Partners API for self-integrated carriers, 50+ outbound webhook event types,
and JavaScript/iOS/Android SDKs powering the Dispatcher and Driver apps. All HTTP
APIs use OAuth 2.0 Client Credentials Grant against region-specific GCP base URLs
(US2/US3/US4, EU2/EU3) — visible on status.bringg.com. Bringg counts 800+ customers
including Best Buy, AutoZone, ASDA, Wegmans, FedEx Office, Metro, uBreakiFix, and
B&Q, and processes 200 million annual deliveries.
maintainers:
- FN: Kin Lane
email: info@apievangelist.com
X: apievangelist
url: https://apievangelist.com
specificationVersion: '0.16'