Response (Output) Params

Parameter

Description

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 unique Id of this order.

active_way_point_id

Int32

The Id of the way point in this order that is the user's (driver's) next destination.

automatically_assigned

boolean

Indicates whether this order was automatically assigned. The values are:

false or 0 - this order was not automatically assigned
true or 1 - this order was automatically assigned.

created_at

datetime

The date and time this order was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

customer

Object

An object containing detailed information about the customer associated with this order, see Customer.

customer_id

Int32

The Id of the customer associated with this order.

external_id

string

The order's external Id.

fleet_id

Int32

If this order is assigned to an external fleet, this is the Id of that external fleet.

late

Int32

Indicates whether the user (driver) has not arrived at way points in this order on or before the scheduled times. The values are:

false or 0 - the user (driver) is not late
true or 1 - the user (driver) is late

The default value is false.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

priority

Int32

The priority of this order.

ready_to_execute

boolean

Indicates whether this task is in planning phase or has been dispatched to drivers. The values are:

false or 0 - Task appears in Planning tab and is not visible to users (drivers)
true or 1 - Task appears in Dispatch tab and is visible to users (drivers).

status

Int32

This order's status. The values are:

0 - created
1 - assigned
2 - on_the_way
3 - checked_in
4 - done
5 - this status is not in use
6 - accepted
8 - rejected
9 - unacknowledged

scheduled_at

datetime

The date and time this order was scheduled. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

tag_id

Int32

If a tag exists, this is the Bringg tab Id.

task_inventories

Array of Objects

An array of objects containing this order's inventory, see Task Inventories.

task_notes

Array of Objects

An array of objects containing notes added to this order, see Task Notes.

team_ids

Array of Int32

An array of Int32 containing the Ids of all teams assigned to this order.

tip_driver_enabled

Int32

Indicates whether the user (driver) is allowed to be tipped. The values are:

false or 0 - the user (driver) cannot be tipped
true or 1 - the user (driver can be tipped.

title

string

This order's title. The maximum length is 255 characters.

updated_at

datetime

The date and time of the last update for this order. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

user_id

Int32

The Id of the user (driver). The default value is null, if no user (driver) is assigned.

uuid

Int32

The universal unique Id of this order.

way_points

Array of Objects

An array of objects containing way_point information, see Way Point.