Delivery Slot Object

Delivery Slots are also known as Planned Delivery Windows.

About Delivery Slots

Delivery Slots, also known as Delivery Windows, can be used to present real-time delivery options to your customers directly from your e-commerce platform.

You can offer different delivery slots depending on the order waypoint or service plan, and even offer recurring delivery slots for customers who want a delivery on a regularly repeating basis.

Using the Get Quotes request, you can display your availability up to 30 days in the future.

A delivery slot can be a minimum of 30 minutes.

Learn more about setting up delivery slots in Bringg.

📘

Enable Timezones

To send start and end times using only hours and minutes in a 24 hour format (for example, "19:00"), speak with your Bringg representative to enable the necessary configurations.

Delivery Slot Details

Below is a list of parameters you can send to Bringg as part of the planned_delivery_window object, for example, when sending the Create Delivery Slot or Update Delivery Slot requests.

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

ParameterDescriptionValidation & Notes
cutoff
int32
Last time to place an order that can be fulfilled in this delivery slot.Include if cutoff_day and cutoff_time are not included.
Formatted as a number of minutes before the delivery slot start_time.
For example:
"cutoff":-60
cutoff_day
int32
The last day to place an order that can be fulfilled in this delivery slot.Include if cutoff is not included.
Counted as number of days from Monday.
For example,
1 - Monday
7 - Sunday
cutoff_time
datetime
The last time to place an order that can be fulfilled in this delivery slot.Include if cutoff is not included.
Formatted as a set daily cutoff time.
For example:
"cutoff_time":"06:00"
end_day
int32
The last day this delivery slot is offered.Counted as number of days from Monday.
For example,
1 - Monday
7 - Sunday
end_time
datetime
The time this delivery slot begins.Uses the local time of the team or company.
effective_end_date
datetime
The last date when this delivery slot occurs.
effective_start_date
datetime
The first date when this delivery slot occurs.
fee
double
Fees associated with fulfilling an order in this time slot.
name
string
The delivery slot's display name.
service_area_ids
array of int32s
Indicates the service areas that are applicable for this time slot.For example, you can offer delivery once a week to specific rural areas.
Must be IDs generated by Bringg.
Learn more about creating service areas in the Bringg UI or via the Create Service Area endpoint.
start_day
array of int32s
The first day this delivery slot is offered.Counted as number of days from Monday.
For example,
1 - Monday
7 - Sunday
start_time
datetime
The time this delivery slot begins.Uses the local time of the team or company.
team_external_id
string
Your external system's ID for the associated team.When neither team_external_id or team_id is included, the slot is created as a company-wide slot and applies to all teams.
Learn more about managing teams in the Bringg UI or via the Create Team endpoint.
service_plan_external_id
array of strings
Your external system's ID for the associated service plans or SLAs.For example, offer VIP members 30-minute windows instead of 2-hour windows.
Learn more about setting up service plans in the Bringg UI or via the Create Service Plan endpoint.

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.


ParameterDescription
id
integer
Bringg's ID for the delivery slot.
end_time
datetime
The date and time by which the associated order should be delivered. Counted as minutes from midnight Monday UTC. Format 00:00.
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
team_id
integer
Bringg's ID for the associated team.
planned_delivery_window_id
integer
Bringg's ID for the delivery slot.
start_time
datetime
The date and time at which the associated order can begin to be delivered. Counted as minutes from midnight Monday UTC. Format 00:00.