Get Order

Get the details of an order using its id or external_id. The response also includes details of any linked orders.

Response (Output) Params

This list of output parameters includes all of the fields that Bringg adds to an order once it is received. For more details, including a table of body parameters, see the Order (Task) Object.

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.

accept_time
datetime

The date and time when the driver accepted this order.

acknowledged_at
datetime

The time at which the order was acknowledged by a dispatcher. If orders are auto-acknowledged, then this time is set upon creation.

active_way_point_id
integer

The ID for the incomplete waypoint associated with this order.

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.

automatically_cancelled
integer

Indicates the method used to cancel this order. Possible values:
0 - manually using the Driver App
1 - automatic check-in or check-out via geofence
2 - driver's action when prompted by the Driver App
3 - from linked task
4 - updated via the Cancel Order API request
5 - updated by the carrier
6 - automated by activity trigger
7 - updated using the Bringg platform
8 - updated using the store app
9 - updated from Run End
10 - automatic by server

automatically_ended
integer

Indicates the method used to end this order. Possible values:
0 - manually using the Driver App)
1 - automatic check-in or check-out via geofence
2 - driver's action when prompted by the Driver App
3 - from linked task
4 - updated via the Cancel Order API request
5 - updated by the carrier
6 - automated by activity trigger
7 - updated from a child task
8 - from the store app
9 - from run end
10 - updated by Bringg automation
11- updated via API

automatically_started
integer

Indicates the method used to start this order. Possible values:
0 - manually using the Driver App
1 - automatic check-in or check-out via geofence
2 - driver's action when prompted by the Driver App
4 - auto_corrected_by_client
5 - auto_corrected_by_server
6 - automated by activity trigger
7 - updated in the Bringg platform
8 - updated in the store app
9 - from_run_end
10 - updated by Bringg automation

cancelled_at
datetime

The date and time when this order was canceled.

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_id
integer

Bringg's ID of the customer associated with this order.

delete_at
datetime

A null timestamp indicates that the entity is still active or present in Bringg.

delivery_cost
float

The delivery fee charged by a third-party carrier.

delivery_price
float

The delivery fee charged by you to your end customer.

delivery_window_id
integer

Bringg's ID for the delivery window selected by or assigned to the customer.

discount
float

dispatcher_id
integer

The ID of the dispatcher who assigned this order.

distance_automatically_set
integer

Indicates how the distance_traveled for this order was calculated. Possible values:
0 - automatic
1 - estimated
2 - manual

distance_traveled
double

The actual distance traveled (in km).

driver_payments
Array

An array including details of all payments accepted by a driver for this order.

ended_time
datetime

The date and time when the order was canceled or marked as complete.

external_carrier_tracking_url
string

The carrier's tracking link.
Included as part of the task_fleet_mapping > shared_extras objects, which contain information provided by the carrier associated with this order and can be included in flexible webhooks.

external_id
string

Your external system's ID for this order.

external_user_id
string

Your external system's ID for the driver associated with this order.

failed_delivery_attempts
integer

The number of times a driver unsuccessfully attempted to deliver the order.

fleet
object

An object containing the details of an assigned or quoted carrier.

fleet_delivery_external_id
string

The external carrier's ID for the order.

fleet_id
integer

Bringg's ID for the external carrier.

group_leader_id
integer

If this order is part of a group of orders, this is the ID of the order representing the entire collection of orders in the group (the parent order containing all child orders in the group). This is the ID that Bringg operators (for example, dispatchers and users/drivers) view. NOTE: Bringg internally maintains each order and each order contains the same group leader ID.

group_uuid
string

If this order is a group of orders, this is the UUID of the group (see group_leader_id).

id
integer

The unique ID of this order in Bringg.

invalidated
boolean

When true, signifies that this order is missing fields that Bringg requires to validate orders and include them in order lists and optimization among other Bringg features.

last_assigned_time
datetime

The last date and time this order was assigned to a driver.

last_ready_to_execute_at
datetime

The last time this order was marked as ready to execute.

last_way_point_lat
double

The geographical latitude for the last waypoint for the order.

last_way_point_lng
double

The geographical longitude of the last waypoint for the order.

late
boolean

Indicates whether the driver has not arrived at a destination in this order on or before the scheduled times. The values are:
false or 0 - the driver is not late
true or 1 - the driver is late
The default value is false.

late_reason
string

left_to_be_paid
double

The unpaid balance of this total order.

linked_task_id
integer

Bringg’s ID for a linked order. Linked orders are created when one order is split into distinct tasks for each waypoint.

merchant_id
integer

The ID of the merchant to which the order belongs.

parent_task_id
integer

If this order was created from another order (for example, one that failed), this is the ID of the original order.

payment_type_name
string

The name of the payment type. For example, Visa, Mastercard, or Amex.

planned_distance_from_prev_task
double

The distance to this order's last waypoint from the last waypoint of the preceding order in the route, as calculated during Route Optimization and via manual planning adjustments in the route planner.

planning_done
boolean

Indicates if this order has been organized into a route, and that route has been marked as "Done Planning."

planning_published
boolean

Indicates if the planned delivery window has been finalized or shared with the customer.

post_delivery_tip_cash
double

The tip (gratuity) paid to the driver in cash after delivery.

post_delivery_tip_credit
double

The tip (gratuity) paid to the driver by credit after delivery.

pre_delivery_tip
double

The tip (gratuity) paid to the driver before delivery.

preparation_acknowledge_time_actual
datetime

Time and date when the order was actually acknowledged.

preparation_end_time_actual
datetime

Time and date when the order actually ended.

preparation_end_time_planned
datetime

Time and date when the order was scheduled to end.

preparation_picked_up_time_actual
datetime

Time and date when the order was actually picked up.

preparation_ready_for_pickup_time_actual
datetime

Time and date when the order was actually ready for pick up.

preparation_ready_for_pickup_time_planned
datetime

Time and date when the order was scheduled to be ready for pickup.

preparation_start_time_actual
datetime

Time and date when preparation of the order actually began.

preparation_start_time_planned
datetime

Time and date when preparation of the order was scheduled to begin.

preparation_status
integer

The order's stage in the preparation workflow. Possible values:
0- acknowledged
1- preparation started
2- preparation ended
3- ready for pickup
4- picked up
5- send to preparation failed

price_before_tax
double

The net price of this order not including taxes.

priority
integer

Sequence of the order within an assigned route. For example, Priority 1 is the first stop in the route.

ready_to_execute
boolean

Indicates whether this order is in planning and not visible to users (drivers). The values are:

  • false or 0 - is not in planning and is visible to users (drivers)
  • true or 1 - is in planning and is not visible to users (drivers)

recurrent_task_template_id
integer

Designates the recurring order series that generated this order. See Create Recurring Order Template.

reserved_until
datetime

Date and time when the reservation of a delivery slot for an order expires. If the order is not completed by this time, the delivery slot reservation expires and the order is canceled.

run_id
integer

The ID of the route the order is assigned to.

run_start_time
datetime

If the order is part of a "run", this is the start date and time of the "run". A "run" is a group of user (driver) tasks beginning at the time a user (driver) leaves a "base" and ending when the user (driver) returns to that "base".
This is in UTC and is in the format " %Y-%m-%dT%H:%M:%S%z".

run_uuid
uuid

The UUID of the run the order is assigned to. Use run_id to search in Bringg UI.

scans
array of objects

An array of objects including details about barcode scans related to an order, such as for inventory items.

scheduled_at
datetime

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

scheduled_to_be_ready
datetime

The date and time when an order is scheduled to be ready for pickup from a waypoint.

service_fee
double

The service fee charged by an external carrier. Usually calculated as a percentage of the subtotal of the order.

service_plan_id
integer

Bringg's ID for the Service Plan applied to this order. Service Plans are used to set SLA and driver actions.

shared_locations
array of objects

Array of objects that includes URLs, tokens, and identifying data related to the customer experience for a waypoint.

shift_id
integer

Bringg's ID for the driver's shift when fulfilling this order.

start_lat
double

The geoposition latitude of the driver when this order started.

start_lng
double

The geoposition longitude of the driver when this order started.

started_time
datetime

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

status
string

Indicates the current status of this order. Possible values include:
0- new
1 - assigned
2 - on the way
3 - checked in
4- done
6 - accepted
7- canceled
8 - rejected
9 - unacknowledged

tag_id
integer

The Bringg ID of the tag associated with this order.

tax_price
float

The tax amount of the price of this order.

tip
float

The tip (gratuity) paid to the driver for this order.

tip_driver_enabled
boolean

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.

total_price
float

The total price of this order.

updated_at
datetime

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

user_id
integer

Bringg's ID for the driver associated with this order.

uuid
uuid

A universally unique identifier (UUID) for this order.

way_points
array of objects

The list of waypoints associated with this order. For more details, see the Way Point Object.

Language