API Reference

Get Quotes

The quotes service check when, who, and at what cost an order can be delivered, considering the order's requirements. This has many uses, including calculating delivery slots for an order, choosing the fastest or cheapest carrier to deliver each order, and sending each order to the team that can deliver it.
Learn more about the Quotes object.

Potential Errors
Error MessageResolution
No quote configuration found.- Check if carriers have been configured correctly.
- Check if delivery slots have been set up for each day of the week.
- Confirm that the service plan listed has been configured correctly.
Failed to find external team id.Check the team's ID and confirm that it has been configured correctly:

- Go to Resources > Teams, or
- Send the Show All Teams API request.
Could not find teams by area, and no given zipcode on waypoint.Confirm that the team's location is configured correctly.

- Go to Resources > Teams, or
- Send the Get Team Details API request, then send Update Team with the correct location information.
No constrains supplied in request, need at least one time constraint.Confirm that time windows have been included in the payload and that they are correct.
Possible issues may include:

- Start date in the past
- More than four days between start and end dates
Invalid end date.Confirm that an end date has been included in the payload and that it is correct.
Possible issues may include:

- End date in the past
- More than four days between start and end dates
No quotes found.- Check if carriers have been configured correctly.
- Check if delivery slots have been set up for each day of the week.
- Confirm that the service plan listed has been configured correctly.
Failed to get available quotes.This may mean that there was an internal error. Send the payload again and contact your Bringg support representative if you continue to receive this error.

Response (Output) Params
ParameterDescription
available
boolean
Indicates whether a time window is available for this quote. This parameter is included in the top level of the response, above the quotes object.
Possible values:
false or 0 - time windows are not available for this quote.
true or 1 - time windows are available for this quote.
The default value is false.
availability_windows
array of objects
An array of window objects containing the details of the time windows that are available for this quote.
currency_code
string
The 3-letter code for the currency used in the quote. For example, USD.
delivery_window
object
Represents a team's availability window. Delivery windows are also known in Bringg as delivery slots. Learn more about the Delivery Window Object.
delivery_terms_supported
boolean
🔗
Indicates whether the carrier is qualified to deliver the order according to your “soft constraint” delivery terms.
Carriers that do not meet order requirements for “hard constraint” delivery terms are not quoted for that order.
Possible values:
false or 0 - the carrier is not qualified to deliver the order.
true or 1 - the carrier is qualified to deliver the order.
The default value is false.
dropoff_window
object
The timeframe in which an order should be delivered. When included in Get Quotes, this indicates a potential timeframe. Each dropoff_window includes a start_time and end_time.
For example:
"dropoff_window": { "start_time": "2024-02-16T15:44:00.000Z", "end_time": "2024-02-16T15:45:00.000Z" },
expiry_time
datetime
The date and time when a quoted window expires, after which it cannot be booked.
fee
double
The delivery price quoted by the carrier.
fill_ratio
double
Indicates the percentage of the delivery slot that is already booked. This can be used to determine pricing or the need for additional resources.
Example values:
0 - the slot is empty
0.36 - the slot is 36% full
1 - the slot is full
fleet
object
🔗
An object containing detailed information about the carrier for this time window, including name, type, and ID.
green
boolean
🔗
Indicates whether the carrier can perform an eco-friendly fulfillment.
id
int32
🔗
Bringg's ID for an individual quote. To confirm the use of this quote, include it in your Create Order (Task) request as the quote_id value.
pickup_window
object
The timeframe in which an order should be picked up. When included in Get Quotes, this indicates a potential timeframe. Each pickup_window includes a start_time and end_time.
For example:
"pickup_window": { "start_time": "2024-02-16T15:40:00.000Z", "end_time": "2024-02-16T15:41:00.000Z" },
priority
int32
Indicates the prioritization level of each quoted carrier based on its ETA or cost, depending on the sorting rule specified by the Carrier Selector. The carrier with the priority value of 1 is the most recommended, with subsequent numbers (2, 3, etc.) indicating lower prioritization in descending order.

When using the team sourcing use case, priority appears on the team level. When assigning to carriers, priority appears on the quote level.
quote_errors
array
If carriers returned errors in response to Bringg's quote request, those error messages are included here.
team
array of objects
An object including details of a team that can fulfill a specified quote.
team_id
Int32
Bringg's ID for a team quoted for the order.
team_external_id
string
An array of your external system's IDs for the quoted teams.
window_start
datetime
The date and time the delivery, pickup, or delivery and pickup window starts.
window_end
datetime
The date and time the delivery, pickup, or delivery and pickup window ends.

Learn more about the Quotes object.


Language