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 | Indicates whether the service completed successfully.
|
message | If an error occurred, a message indicating the error is included. |
rc | If an error occurred, the return code is included. |
accept_time | The date and time when the driver accepted this order. |
acknowledged_at | 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 | The ID for the incomplete waypoint associated with this order. |
automatically_assigned | Indicates whether this order was automatically assigned. The values are: |
automatically_cancelled | Indicates the method used to cancel this order. Possible values: |
automatically_ended | Indicates the method used to end this order. Possible values: |
automatically_started | Indicates the method used to start this order. Possible values: |
cancelled_at | The date and time when this order was canceled. |
created_at | 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 | Bringg's ID of the customer associated with this order. |
delete_at | A null timestamp indicates that the entity is still active or present in Bringg. |
delivery_cost | The delivery fee charged by a third-party carrier. |
delivery_price | The delivery fee charged by you to your end customer. |
delivery_window_id | Bringg's ID for the delivery window selected by or assigned to the customer. |
discount | |
dispatcher_id | The ID of the dispatcher who assigned this order. |
distance_automatically_set | Indicates how the distance_traveled for this order was calculated. Possible values: |
distance_traveled | The actual distance traveled (in km). |
driver_payments | An array including details of all payments accepted by a driver for this order. |
ended_time | The date and time when the order was canceled or marked as complete. |
external_carrier_tracking_url | The carrier's tracking link. |
external_id | Your external system's ID for this order. |
external_user_id | Your external system's ID for the driver associated with this order. |
failed_delivery_attempts | The number of times a driver unsuccessfully attempted to deliver the order. |
fleet | An object containing the details of an assigned or quoted carrier. |
fleet_delivery_external_id | The external carrier's ID for the order. |
fleet_id | Bringg's ID for the external carrier. |
group_leader_id | 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 | If this order is a group of orders, this is the UUID of the group (see |
id | The unique ID of this order in Bringg. |
invalidated | When |
last_assigned_time | The last date and time this order was assigned to a driver. |
last_ready_to_execute_at | The last time this order was marked as ready to execute. |
last_way_point_lat | The geographical latitude for the last waypoint for the order. |
last_way_point_lng | The geographical longitude of the last waypoint for the order. |
late | Indicates whether the driver has not arrived at a destination in this order on or before the scheduled times. The values are: |
late_reason | |
left_to_be_paid | The unpaid balance of this total order. |
linked_task_id | Bringg’s ID for a linked order. Linked orders are created when one order is split into distinct tasks for each waypoint. |
merchant_id | The ID of the merchant to which the order belongs. |
parent_task_id | If this order was created from another order (for example, one that failed), this is the ID of the original order. |
payment_type_name | The name of the payment type. For example, Visa, Mastercard, or Amex. |
planned_distance_from_prev_task | 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 | Indicates if this order has been organized into a route, and that route has been marked as "Done Planning." |
planning_published | Indicates if the planned delivery window has been finalized or shared with the customer. |
post_delivery_tip_cash | The tip (gratuity) paid to the driver in cash after delivery. |
post_delivery_tip_credit | The tip (gratuity) paid to the driver by credit after delivery. |
pre_delivery_tip | The tip (gratuity) paid to the driver before delivery. |
preparation_acknowledge_time_actual | Time and date when the order was actually acknowledged. |
preparation_end_time_actual | Time and date when the order actually ended. |
preparation_end_time_planned | Time and date when the order was scheduled to end. |
preparation_picked_up_time_actual | Time and date when the order was actually picked up. |
preparation_ready_for_pickup_time_actual | Time and date when the order was actually ready for pick up. |
preparation_ready_for_pickup_time_planned | Time and date when the order was scheduled to be ready for pickup. |
preparation_start_time_actual | Time and date when preparation of the order actually began. |
preparation_start_time_planned | Time and date when preparation of the order was scheduled to begin. |
preparation_status | The order's stage in the preparation workflow. Possible values: |
price_before_tax | The net price of this order not including taxes. |
priority | Sequence of the order within an assigned route. For example, Priority 1 is the first stop in the route. |
ready_to_execute | Indicates whether this order is in planning and not visible to users (drivers). The values are:
|
recurrent_task_template_id | Designates the recurring order series that generated this order. See Create Recurring Order Template. |
reserved_until | 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 | The ID of the route the order is assigned to. |
run_start_time | 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". |
run_uuid | The UUID of the run the order is assigned to. Use |
scans | An array of objects including details about barcode scans related to an order, such as for inventory items. |
scheduled_at | 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 | The date and time when an order is scheduled to be ready for pickup from a waypoint. |
service_fee | The service fee charged by an external carrier. Usually calculated as a percentage of the subtotal of the order. |
service_plan_id | 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 that includes URLs, tokens, and identifying data related to the customer experience for a waypoint. |
shift_id | Bringg's ID for the driver's shift when fulfilling this order. |
start_lat | The geoposition latitude of the driver when this order started. |
start_lng | The geoposition longitude of the driver when this order started. |
started_time | 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 | Indicates the current status of this order. Possible values include: |
tag_id | The Bringg ID of the tag associated with this order. |
tax_price | The tax amount of the price of this order. |
tip | The tip (gratuity) paid to the driver for this order. |
tip_driver_enabled | Indicates whether the user (driver) is allowed to be tipped. The values are:
|
title | This order's title. The maximum length is 255 characters. |
total_price | The total price of this order. |
updated_at | 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 | Bringg's ID for the driver associated with this order. |
uuid | A universally unique identifier (UUID) for this order. |
way_points | The list of waypoints associated with this order. For more details, see the Way Point Object. |