API Reference

Order ETA Changed

The Order ETA Changed callback occurs when an order's estimated time of arrival to a customer is changed. This returns detailed information describing the order, including the driver and status.

📘

Register Your URL for this Webhook

To start receiving webhooks from Bringg, you must first register a URL. Detailed guidance on setting up and managing Bringg webhooks is available in the following resources:


Response

{
   "id": 11109312,
   "scheduled_at": "2017-12-24T17:59:26.104Z",
   "task_id": 8916170,
   "task_external_id": "ABC123",
   "customer_id": 3185225,
   "eta": "2017-12-24T18:00:40.043Z",
   "etl": "2017-12-24T18:05:40.043Z",
   "position": 1,
   "address": "HaYarkon St 99, Tel Aviv-Yafo, Israel",
   "address_second_line": null,
   "done": false,
   "lat": 32.0798253,
   "lng": 34.7680826000001,
   "phone": null,
  "additional_attributes": {
      "planned_distance_from_prev_task": 4.594
  },
   "note": null,
   "allow_editing_inventory": true,
   "must_approve_inventory": false,
   "zipcode": null,
   "borough": null,
   "city": null,
   "state": null
}

{
  "way_point": {
    "id": 9877,
    "position": 2,
    "scheduled_at": "2023-01-01T12:47:00.000Z",
    "eta": "2023-01-01T12:35:00.000Z",
    "address": "123 1st Ave. New York, NY 10002",
    "task": {
      "id": 1234,
      "external_id": "h9371hHE",
      "service_plan": {
        "external_id": "Express"
      },
      "teams": [
           {
             "external_id": "team 1"
           }
         ]
    }
  },
  "webhook_type": "way_point_eta_changed",
  "merchant_id": 1
}

Output Params

id

Int32

The unique Id of this order.

address

string

The address of this order.

address_second_line

text

The second line of the address of this order.

allow_editing_inventory

boolean

Indicates whether the user (driver) is allowed to change the order inventory. The values are:

  • false or 0 - the user (driver) is not allowed to change the order inventory.
  • true or 1 - the user (driver) is allowed to change the order inventory.

The default value is true.

borough

string

This order's borough. This can also be used for any neighborhood or zone.

city

string

This order's city.

customer_id

Int32

The Id of the customer associated with this order.

done

boolean

Indicates whether this order is done. The values are:

  • false or 0 - this order is not done
  • true or 1 - this order is done

The default value is false.

eta

datetime

The estimated time of arrival (ETA) at this order location, added only after the user (driver) has started order or after optimization. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

etl

datetime

The estimated time of leaving this order location (ETA plus time on site). This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

lat

double

The geoposition latitude of this order location.

lng

double

The geoposition longitude of this order location.

must_approve_inventory

boolean

Indicates whether the user (driver) is allowed to leave this order location before scanning inventory. The values are:

  • false or 0 - the user (driver) is not required to scan all inventory or mark it as collected before completing the order
  • true or 1 - the user (driver) must scan all inventory or mark it as collected before completing the order

The default value is false.

note

string

A note on this order. The maximum length is 255 characters.

position

Int32

The position of this location in all locations in the order to which this order belongs. For example, the order may contain 5 locations and this location is position 2 (the second).

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".

state

string

This order's state.

task_id

Int32

Bringg order ID.

task_external_id

string

Your order ID.

zipcode

string

The ZIP code of this order location.