API Reference

Create Delivery Block (Resource-based Optimization)

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.

OUTPUT PARAMS

tr>

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The Id of the new delivery block.

capacity

Int32

The number of drivers assigned to this new delivery block.

description

string

The description of this new delivery block.

end_time

datetime

The ending date and time of this new delivery block.

name

string

The name of this new delivery block.

original_capacity

Int32

The number of drivers that should work to this new delivery block.

resources_capacity

Int32

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 new delivery block.

user_ids

array of integers

An array containing the Ids of the drivers assigned to this delivery block.

users

array of objects

An array of objects where each object contains the following:

  • id - the Id a driver assigned to this delivery block.
  • name - the name of a driver assigned to this delivery block.
  • email - the email address of a driver assigned to this delivery block.

delivery_block_resources

array of objects

An array of Delivery Blocks Resources objects, where each object contains a delivery block resources 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_breaks

array of objects

An array of Delivery Blocks Breaks objects, where each object contains a delivery block resources object.

Language