Update Order

Use this API to update order when you need to update the following fields:

  • Scheduled Pickup Time or Delivery Time
  • Delivery Time Window
  • Driver's ETA to Pickup or Dropoff
  • Integration event
  • Delivery cost
  • Green delivery

EXAMPLE PAYLOAD

{
  "task_id": 1234567,
  "way_points": [
    {
      "way_point_position": 2,
      "scheduled_at": "2020-12-03 14:00:00 UTC",
      "note": "Optional reason for updating the Scheduled time"
    }
  ],
   "reported_time": 1609148419000,
   "fleet_extras": {
        "some": "important info"
   },
   "green_delivery": true
}
{
  "task_id": 1234567,
  "way_points": [
    {
      "way_point_position": 2,
      "no_earlier_than": "2020-12-03 13:00:00 UTC",
      "no_later_than": "2020-12-03 15:00:00 UTC",
      "note": "Optional reason for updating the Time Window"
    }
  ],
   "reported_time": 1609148419000,
   "fleet_extras": {
        "some": "important info"
   },
   "green_delivery": true
}
{
  "task_id": 1234567,
  "way_points": [
    {
      "way_point_position": 2,
      "eta": "2020-12-03 14:00:00 UTC",
      "note": "Optional reason for updating the ETA"
    }
  ],
   "reported_time": 1609148419000,
   "fleet_extras": {
        "some": "important info"
   },
   "green_delivery": true
}
{
  "task_id": 1234567,
  "way_points": [
    {
      "way_point_position": 2,
      "no_earlier_than": "2020-12-03 13:00:00 UTC",
      "no_later_than": "2020-12-03 15:00:00 UTC",
      "scheduled_at": "2020-12-03 14:00:00 UTC",
      "eta": "2020-12-03 14:30:00 UTC",
      "note": "Optional reason for making the updates"
    }
  ],
   "reported_time": 1609148419000,
   "fleet_extras": {
        "some": "important info"
   },
   "green_delivery": true
}
{
    "task_id" : 12345,
    "integration_event" : {
        "status_code": "12344",
        "description": "Description of status"
    },
   "reported_time": 1609148419000,
   "fleet_extras": {
        "some": "important info"
   },
   "green_delivery": true
}
{
  "task_id": 9883062,
  "delivery_cost": 12.99,
  "reported_time": 1609148419000,
  "fleet_extras": {
        "some": "important info"
   },
   "green_delivery": true
}

BODY PARAMS

* task_id

Int32

Bringg's unique Order ID

* way_point_position

Int32

Identifies the way point (stop) number. Possible values are 1 (pickup/store/warehouse) or 2 (dropoff/customer). MANDATORY

way_point_id

Int32

Bringg ID of the way point with which this note is associated. OPTIONAL

scheduled_at

datetime

The date and time the driver is scheduled to arrive at the waypoint. The value is in UTC in the format "%Y-%m-%dT%H:%M:%S%z UTC"

no_earlier_than

datetime

The start of the time window for this waypoint. The value is in UTC in the format "%Y-%m-%dT%H:%M:%S%z UTC"

no_later_than

datetime

The end of the time window for this waypoint. The value is in UTC in the format "%Y-%m-%dT%H:%M:%S%z UTC"

eta

datetime

The estimated time of arrival (ETA) of the driver at this waypoint. The value is in UTC in the format "%Y-%m-%dT%H:%M:%S%z UTC"

note

string

Optional reason for the update

reported_time

integer

Unix Epoch time in milliseconds when the event occurred

fleet_extras

object

Additional information that comes from the Fleet. OPTIONAL

delivery_cost

float

The fee that you are charging for delivery of this order, in Dollars/Euro units. OPTIONAL

green_delivery

boolean

Allows you to indicate whether a green vehicle is delivering this order. OPTIONAL

📘

What Bringg will send in response

{
    "success": true
}

🚧

Integration Event

The "status_code" field is case-sensitive. Therefore, sending "D14" is treated as different to "d14".