Quotes object

The Quote object is included in the Get Quotes endpoint, which are both used in Bringg's Quotes and Availability service.

The Quotes object is used in the Get Quotes endpoint. There are many use cases for the Quotes in Bringg, including:

Determining which teams and carriers are available and most effective for an order.
Rate shopping by comparing carrier rates based on parameters like shipment dimensions, weight, destination, and desired delivery times.
Embedding real-time quotes in your e-commerce platform to offer delivery options to your customers. Note: You can embed up to 4 carrier-provided slots or 30 own-fleet availability slots.

See the Get Quotes endpoint for sample response and request payloads and more information about using quotes to achieve different business goals.

Best Practices

Since asap can mean different things to different carriers (different time spans, for example), including this parameter isn't always enough to signal an order's urgency or required delivery time to carriers. For this reason, we recommend including a pickup_window as well. This pickup_window can be set for one minute after the order creation time.
Depending on your use case, it may be best to avoid including different pickup_window and dropoff_window durations in carrier quotes, as this can add unnecessary constraints for carriers. Instead, set the same, longer duration for each, allowing the carrier to complete the pickup and dropoff within that longer time frame at a pace that works best for them.

Request Data

Below is a list of all parameters that you can send to Bringg for this object. If there are attributes that you want to include but are not listed here, you can create custom attributes that can be displayed and used throughout Bringg.

For more details about how different parameter types such as datetime are formatted and used in Bringg, read our Data Formatting article.

📘
Best practice
We recommend using external IDs, which you define, in your requests. This reduces the need for you to map entities that already exist in your other systems.
For example, after creating a service plan in the Bringg UI or with the Create Service Plan endpoint, use the service_plan_external_id parameter when creating orders instead of mapping and sending tag_id and task_configuration_id.

Parameter	Description	Validations & Notes
asap _boolean	Indicates whether the destination is an ASAP waypoint for an on-demand order that should be prioritized before planned orders. In a Get Quotes request, this parameter instructs carriers to provide only a single delivery ETA that represents the earliest possible delivery time. By default, the delivery time is set for 30 minutes from receipt of the payload.	Possible values: `false` or `0` - This is not an ASAP waypoint. `true` or `1` - This is an ASAP waypoint. The default value is `false`. **For example, this could be used for an order for a VIP customer or the delivery of a replacement part to a mechanic who is in the middle of fulfilling a service request for a customer. `asap` can also mean that an order is due in the next hour.
create_linked_tasks _boolean	When both the pickup and dropoff location for an order are destinations on a route (neither are located at the route origin), `true` creates two linked orders for individual optimization.
required_skills _{array of strings}	An array of driver skills or vehicle capabilities required to carry out this order, such as "fridge installation".
service_plan_external_id _string	The ID in your system for the Service Plan applied to this order. Service Plans are used to set SLAs and driver actions.	You can also use different service plans to send different types of quote requests, for example to quote only your own fleet for specific order types. Reach out to your Bringg representative for configuration.
task_type_id _int32	Indicates the order type. Can also be automatically generated when inventory or waypoint objects indicate the order type.	This parameter should only be included for the team sourcing use case. Possible values: `2`: Pickup `3`: Return `4`: Dropoff `5`: Pickup and dropoff
team_external_ids _{array of srings}	An array of your external system's IDs for the quoted teams.	If multiple teams are listed, Bringg will check for quotes from all teams in list.
teams _{array of integers}	An array of the Bringg IDs for the quoted teams.
total_weight _integer	The total weight of the order. Used to ensure order does not exceed vehicle capacity even if customers add last-minute items to their order. Bringg calculates according to the higher value, total_weight or the aggregated weight of all inventory items in the order.
total_handling_units _string	Used to ensure that the vehicle does not exceed capacity even if a customer adds last-minute items to their order. When omitted, Bringg calculates the aggregated handling_units from the inventory object.
way_points _object	An array of one or two objects containing destination information. Read more about the Way Point Object.	At least one `address`is required for the Get Quotes request. If an order has already been created and includes an address, the order's `task_id` or `task_external_id`is sufficient. Depending on your use case, we recommend also including each waypoint's `zipcode` and `no_later_than` fields.

Response and Webhook Data

Below is a list of the data returned in webhooks and responses to your API requests. The inclusion of specific parameters may depend on your use case, your API request, and the webhook fields you have subscribed to.