Create delivery slots (previously known as Planned Delivery Windows) to represent fulfillment availability by time and day ranges.
The Create Delivery Slot API allows you to define a team's delivery availability for specific dates and durations so you can offer customers a variety of delivery options during their shopping experience. Use this endpoint to establish slots that meet your operational requirements, factoring in considerations like delivery destination, driver availability, service level, and inventory. Note that a delivery slot is returned in responses as planned_delivery_window
.
Bringg provides flexibility in defining delivery slots, enabling you to reserve slots until checkout, specify durations as narrow as 30 minutes, and display slots up to a month in advance.
To set up a weekly delivery cadence, create delivery slots for an entire organization or specific teams. Adjust this schedule using the Update Delivery Slot endpoint.
After creating the slots:
- Use the Create Blackout endpoint to block off time when for when your team or organization are not available, such as on holidays.
- Send a Get Quotes request to check availability for specific orders or display delivery slots for your customers so they can schedule a time to receive their orders.
- Reserve a delivery slot while the customer shops by creating an order with the Create Order (Task) endpoint. Use the
reserved_until
field to limit how long the slot is held. If the customer does not finalize the purchase, the order is automatically canceled at the time specified byreserved_until
. - After checkout, use the Update Order endpoint to add inventory items and finalize the order details.
- If the customer cancels their order, release the reserved slot with the Cancel Order (Task) endpoint.
Learn more about the Delivery Slot Object, including more details about parameter formatting and validations.
Response (Output) Params
Parameter | Description |
---|---|
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 empty0.36 - the slot is 36% full1 - 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. |