API Reference

Update Delivery Block

Make changes to an existing delivery block e.g. change capacity

recurring

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.

break_end_time

datetime

For a delivery block that includes a break, this is the ending time of the break.

break_start_time

datetime

For a delivery block that includes a break, this is the starting time of the break.

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.

ical

string

A string representing the iCal object for this delivery block. iCal is used for Internet Calendaring and Scheduling. For example, an iCal value is: FREQ=DAILY;INTERVAL=1;UNTIL=20181115T210000Z. For information about iCal, see the RFC for the Internet Calendaring and Scheduling Core Object Specification (iCalendar).

original_capacity

Int32

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

recurring

string

Indicates whether the delivery block is a recurring delivery block. The values are:

  • all - All delivery blocks in that series from the current time stamp forward.
  • future - All delivery blocks in that series from that delivery block forward.

Note: If future is specified for the recurring parameter, an iCal object is returned as a string in the iCal parameter.

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.
Language
Credentials
OAuth2