Left Destination (Way Point)

The Left Way Point callback occurs when the user (driver) notifies Bringg the user (driver) departed from a way point in an order. This callback returns detailed information describing the driver's departure from the way point.

📘

Registering Your URL for the Left Way Point Webhook

For information describing how to register your URL for a webhook, see Bringg Webhooks.

Response

{
  "id": 33363526,
  "scheduled_at": "2020-10-30T10:00:00.000Z",
  "task_id": 24981076,
  "customer_id": 12744836,
  "eta": null,
  "etl": "2020-10-08T07:20:42.018Z",
  "name": "Warehouse",
  "address": "5210 TRADEMARK DRIVE, RALEIGH, NC",
  "address_second_line": null,
  "done": true,
  "address_type": null,
  "location_name": null,
  "no_earlier_than": null,
  "no_later_than": null,
  "lat": 35.7686299,
  "lng": -78.5487832,
  "phone": null,
  "note": null,
  "allow_editing_inventory": true,
  "must_approve_inventory": false,
  "zipcode": "27610",
  "borough": null,
  "city": "Raleigh",
  "state": null,
  "pickup_dropoff_option": 0,
  "etos": 300,
  "position": 1,
  "webhook_type": "way_point_left",
  "merchant_id": 275
}
{
  "way_point": {
    "id": 24250485,
    "lat": 41.32918,
    "lng": 2.04919,
    "address": "Centro Comercial , Carrer de les Alberedes, 9",
    "position": 1,
    "scheduled_at": "2021-01-08T08:35:00.000Z",
    "checkin_time": "2021-01-10T15:38:44.585Z",
    "checkout_time": "2021-01-10T15:38:44.585Z",
    "customer": {
      "name": "Tienda Sant Boi [013]",
      "address": "Centro Comercial Sant Boi, Carrer de les Alberedes, 9"
    },
    "task": {
      "id": 20045176,
      "title": "Pedido 013-943462",
      "external_id": "013-943462-20210105",
      "user": {
        "id": 24008,
        "name": "ADER/Andy Noriega Gil",
        "external_id": "1973LFM",
        "company": {
          "name": "Ader"
        }
      },
      "teams": [
        {
          "id": 3616,
          "name": "Sant Boi [013]",
          "external_id": "013"
        }
      ]
    }
  },
  "webhook_type": "way_point_left",
  "merchant_id": 178
}

Output Params

id

Int32

The Id of the order.

address

string

The address of this way point.

address_second_line

text

The second line of the address of this way point.

allow_editing_inventory

boolean

Indicates whether the user (driver) is allowed to change inventory at this way point. The values are:

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

The default value is true.

borough

string

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

city

string

This way point's city.

customer_id

Int32

The Id of the customer associated with this way point.

done

boolean

Indicates whether this way point is done. The values are:

  • false or 0 - this way point is not done
  • true or 1 - this way point is done

The default value is false.

eta

datetime

The estimated time of arrival (ETA) at this way point, 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 way point (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 way point.

lng

double

The geoposition longitude of this way point.

must_approve_inventory

boolean

Indicates whether the user (driver) is allowed to leave this way point 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 way point. The maximum length is 255 characters.

phone

string

The phone number of this way point.

position

Int32

Indicates the arrangement of a sequence of waypoints. For example, a task with 2 waypoints would have a waypoint with position 1 (the first waypoint) and a waypoint with position 2 (the second waypoint).

scheduled_at

datetime

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

state

string

This way point's state.

task_id

Int32

Bringg order Id.

zipcode

string

The ZIP code of this way point.