Create Delivery Block

Create a new delivery block. A delivery block is a work time slot for drivers in a team.

📘

Recurring Delivery Blocks

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

OUTPUT PARAMS

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.

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.
Body Params
string

The name of this new delivery block.

string

The description of this new delivery block.

int32
required

The number of drivers that should work this delivery block.

date
required

The starting date and time of this new delivery block.

date
required

The ending date and time of this new delivery block.

int32
required

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

users
object

An array of objects containing the Id, name, and email of the drivers assigned to this new delivery block.

user_ids
array of int32s

The Ids of the drivers assigned to this delivery block.

user_ids
date

The starting date and time of the break

date

The ending date and time of the break

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.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json