Create Delivery Block (Resource-based Optimization)

post https://developer-api.bringg.com/services/36d766db/{service_uuid1}/{service_uuid2} (COPY)

Create a new delivery block that considers resource availability, and allows you to add and pair drivers and vehicles within a block. A delivery block is a work time slot for drivers and vehicles in a team. Note: The ability to add and pair drivers and vehicles through delivery blocks is available only to users of Bringg's resource-based optimization.

📘
Recurring Delivery Blocks
Blocks can only be created up to 3 months in the future.

Response (Output) Params

Parameter	Description
`success` _boolean	Indicates whether the service completed successfully. false - the service failed. true - the service succeeded
`message` _string	If an error occurred, a message indicating the error is included.
`rc` _integer	If an error occurred, the return code is included.
`break_end_time` _datetime	The ending date and time of the break in this delivery block. This is in UTC in the format "%Y-%m-%dT%H:%M:%S%z".
`break_start_time` _datetime	The starting date and time of the break in this delivery block. This is in UTC in the format "%Y-%m-%dT%H:%M:%S%z".
`capacity` _integer	The number of drivers assigned to this delivery block.
`description` _string	The description of this delivery block.
`delivery_block_breaks` _{array of objects}	An array of Delivery Blocks Breaks objects, where each object contains a delivery block breaks object.
`delivery_block_recharges` _{array of objects}	An array of Delivery Blocks Recharge objects, where each object contains a delivery block recharge object.
`delivery_block_resources` _{array of objects}	An array of Delivery Blocks Resources objects, where each object contains a delivery block resources object.
`delivery_block_schedule_id` _integer
`end_time` _datetime	The ending date and time of this delivery block. This is in UTC in the format "%Y-%m-%dT%H:%M:%S%z".
`ical` _string	The recurring rule for the delivery blocks.
`id` _integer	The Bringg ID for the delivery block.
`name` _string	The name of this delivery block.
`original_capacity` _integer	The number of drivers that should be working in this delivery block.
`resources_capacity` _integer	The number of resource (vehicles and/or drivers) that are currently assigned to this individual delivery block.
`start_time` _datetime	The starting date and time of this delivery block. This is in UTC in the format "%Y-%m-%dT%H:%M:%S%z".
`team_id` _integer	The Bringg ID of the team to which to this delivery block is assigned.
`user_ids` _array	An array containing the IDs of the drivers assigned to this delivery block.
`users` _array	An array of objects containing the ID, name, and email of the drivers assigned to this delivery block.

Body Params

team_id

int32

required

The ID of the team for which this new delivery block is created.

name

string

The name of this new delivery block.

description

string

The description of this new delivery block.

start_time

date

required

The starting date and time of this new delivery block.

end_time

date

required

The ending date and time of this new delivery block.

ical

string

Set delivery block to be recurring according to a rule. MUST BE IN UPPERCASE. See https://tools.ietf.org/html/rfc5545 to generate rule.

original_capacity

int32

required

The number of drivers that should work this delivery block.

resources_capacity

int32

(Resource-based optimization only) Used together with orignal_capacity to determine the number of resources available to assign to the delivery block.

users

object

(Driver-based optimization only) An array of objects containing the Id, name, and email of the drivers assigned to this new delivery block.

user_ids

array of int32s

(Driver-based optimization only) The IDs of the drivers assigned to this delivery block.

user_ids

delivery_blocks_resources

array of objects

(Resource-based optimization only) An array of objects used to add resource details such as driver, vehicle or trailer IDs, and start location type.

delivery_blocks_resources

delivery_block_breaks

array of objects

An array of objects used to add breaks, including break start and end times, locations, and durations when applicable.

delivery_block_breaks

delivery_block_recharges

array of objects

(Resource-based optimization only) An array of objects used to add reload times to a delivery block. Required only when drivers or vehicles need to reload at a specific time. If they can reload multiple times based on the creation of new routes, this array is not needed.

delivery_block_recharges

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://developer-api.bringg.com/services/36d766db/service_uuid1/service_uuid2%20(COPY)' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
23
 
1
{
2
  "success": true,
3
  "delivery_block": {
4
    "id": 3419865,
5
    "name": "Monday",
6
    "description": "A shell delivery block with no resources preassigned",
7
    "start_time": "2025-01-01T13:00:00.000Z",
8
    "end_time": "2025-01-01T22:00:00.000Z",
9
    "break_start_time": null,
10
    "break_end_time": null,
11
    "capacity": 0,
12
    "resources_capacity": 0,
13
    "original_capacity": 10,
14
    "delivery_block_schedule_id": null,
15
    "team_id": 4248,
16
    "users": [],
17
    "user_ids": [],
18
    "ical": null,
19
    "delivery_block_breaks": [],
20
    "delivery_block_resources": [],
21
    "delivery_block_recharges": []
22
  }
23
}

📘Recurring Delivery Blocks

200200

400400

📘
Recurring Delivery Blocks