API Reference

Order Marked Late

The Order Was Marked Late callback occurs when an order is not completed by the scheduled time. This callback returns detailed information describing the order, including the order 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": 8500657,
	"title": "Pickup damaged machine parts",
	"created_at": "2017-12-12T14:45:04.000Z",
	"updated_at": "2017-12-12T14:59:35.000Z",
	"customer_id": 4652688,
	"user_id": 77552,
	"status": "TASK_LATE",
	"scheduled_at": "2017-12-12T15:00:00.000Z",
	"merchant_id": 11271,
	"active_way_point_id": 10637114,
	"way_points": [
		{
			"id": 10637114,
			"lat": 40.442228,
			"lng": -80.003107,
			"task_id": 8500657,
			"done": false,
			"created_at": "2017-12-12T14:45:04.391Z",
			"updated_at": "2017-12-12T14:59:35.868Z",
			"customer_id": 4652688,
			"address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
			"position": 1,
			"scheduled_at": "2017-12-12T15:00:00.000Z",
			"checkin_time": null,
			"checkout_time": null,
			"note": null,
			"find_me": null,
			"asap": null,
			"late": true,
			"eta": null,
			"etl": "2017-12-12T15:18:07.268Z",
			"silent": false,
			"phone": "+9724121234567",
			"email": "[email protected]",
			"delete_at": null,
			"checkin_lat": null,
			"checkin_lng": null,
			"checkout_lat": null,
			"checkout_lng": null,
			"etos": 300,
			"distance_traveled_client": null,
			"distance_traveled_server": null,
			"automatically_checked_in": 0,
			"automatically_checked_out": 0,
			"merchant_id": 11271,
			"start_lat": null,
			"start_lng": null,
			"start_time": null,
			"estimated_distance": null,
			"estimated_time": null,
			"allow_editing_inventory": true,
			"must_approve_inventory": false,
			"address_second_line": "Annex B",
			"zipcode": null,
			"allow_scanning_inventory": null,
			"allow_editing_payment": null,
			"late_reason": "the task is in 15 minutes and we don't know where the driver is",
			"no_later_than": null,
			"no_earlier_than": null,
			"masked_phone_number": null,
			"twilio_number_id": null,
			"marked_late_at": "2017-12-12T14:59:35.867Z",
			"borough": null,
			"city": null,
			"distance_traveled": null,
			"state": null,
			"delivery_confirmation_scan": null,
			"delivery_confirmation_note": null,
			"delivery_confirmation_photo": null,
			"delivery_confirmation_signature": null,
			"delivery_confirmation_form": null,
			"delivery_confirmation_ocr": null,
			"company_name": null,
			"customer_contact_ids": [
				4652688
			],
			"contacts": [
				{
					"customer_id": 4652688,
					"contact_type": "phone",
					"contact_value": "+9724121234567",
					"sharing_allowed": true
				},
				{
					"customer_id": 4652688,
					"contact_type": "email",
					"contact_value": "[email protected]",
					"sharing_allowed": true
				}
			],
			"allow_editing_original_quantity": null,
			"pickup_dropoff_option": null,
			"delivery_confirmation_cash": null,
			"district": null,
			"house_number": null,
			"street": null,
			"pending_geocode": false,
			"original_eta": null,
			"allow_automatic_set_coordinates": true,
			"has_to_leave_by": null,
			"customer": {
				"id": 4652688,
				"name": "Beverage Brothers",
				"address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
				"lat": 40.442228,
				"lng": -80.003107,
				"created_at": "2017-12-11T17:19:06.856Z",
				"updated_at": "2017-12-12T14:45:04.432Z",
				"phone": "+9724121234567",
				"merchant_id": 11271,
				"image": "/images/avatar.png",
				"access_token": "75903a14-f94d-4deb-ba8b-832dce895f82",
				"confirmation_code": "7454",
				"salt": null,
				"approved": false,
				"push_token": null,
				"uuid": "0885ddb9-c943-4ef5-98f2-9db7f02e6d13",
				"email": "[email protected]",
				"external_id": "4652688",
				"delete_at": null,
				"facebook_id": null,
				"extras": null,
				"original_lat_lng_changed": "2017-12-12T11:47:49.499Z",
				"encrypted_password": "",
				"blocked_email": false,
				"address_second_line": "Annex B",
				"zipcode": null,
				"allow_login": false,
				"stripe_id": null,
				"original_phone_number": "412-123-4567",
				"last_open_at": null,
				"last_order_at": null,
				"uploaded_profile_image": {
					"url": "/images/avatar.png"
				},
				"original_lat": 40.442228,
				"original_lng": -80.003107,
				"consecutive_checkins_out_of_geofence": 0,
				"allow_sending_email": true,
				"allow_sending_sms": true,
				"reset_password_token": null,
				"reset_password_sent_at": null,
				"mobile_version": null,
				"mobile_type": 0,
				"mobile_maker": null,
				"client_version": null,
				"client_name": null,
				"city": null,
				"borough": null,
				"state": null,
				"dev": false,
				"business_code": null,
				"language": null,
				"district": null,
				"house_number": null,
				"street": null
			},
			"full_address": "120 Fifth Ave, Pittsburgh, PA 15222, USA"
		}
	],
	"customer": {
		"id": 4652688,
		"name": "Beverage Brothers",
		"address": "120 Fifth Ave, Pittsburgh, PA 15222, USA",
		"lat": 40.442228,
		"lng": -80.003107,
		"created_at": "2017-12-11T17:19:06.856Z",
		"updated_at": "2017-12-12T14:45:04.432Z",
		"phone": "+9724121234567",
		"merchant_id": 11271,
		"image": "/images/avatar.png",
		"access_token": "75903a14-f94d-4deb-ba8b-832dce895f82",
		"confirmation_code": "7454",
		"salt": null,
		"approved": false,
		"push_token": null,
		"uuid": "0885ddb9-c943-4ef5-98f2-9db7f02e6d13",
		"email": "[email protected]",
		"external_id": "4652688",
		"delete_at": null,
		"facebook_id": null,
		"extras": null,
		"original_lat_lng_changed": "2017-12-12T11:47:49.499Z",
		"encrypted_password": "",
		"blocked_email": false,
		"address_second_line": "Annex B",
		"zipcode": null,
		"allow_login": false,
		"stripe_id": null,
		"original_phone_number": "412-123-4567",
		"last_open_at": null,
		"last_order_at": null,
		"uploaded_profile_image": {
			"url": "/images/avatar.png"
		},
		"original_lat": 40.442228,
		"original_lng": -80.003107,
		"consecutive_checkins_out_of_geofence": 0,
		"allow_sending_email": true,
		"allow_sending_sms": true,
		"reset_password_token": null,
		"reset_password_sent_at": null,
		"mobile_version": null,
		"mobile_type": 0,
		"mobile_maker": null,
		"client_version": null,
		"client_name": null,
		"city": null,
		"borough": null,
		"state": null,
		"dev": false,
		"business_code": null,
		"language": null,
		"district": null,
		"house_number": null,
		"street": null
	},
	"late": true,
	"external_id": "8500657",
	"uuid": "a0562a77-f872-40c2-a9cf-6702dc230800",
	"priority": 8500657,
	"dispatcher_id": null,
	"ready_to_execute": true,
	"tip_driver_enabled": false,
	"tag_id": 8613,
	"automatically_assigned": false,
	"last_assigned_time": "2017-12-12T14:56:57.000Z",
	"task_inventories": [],
	"task_notes": [],
	"fleet_id": null
}

Output Params

id

Int32

The unique Id of this order.

active_way_point_id

Int32

The Id of the way point in this order that is the user's (driver's) next destination.

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.

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

JSON

A JSON containing the following fields from the customer object associated with this order:

  • id
  • name
  • address
  • address_second_line
  • zipcode
  • lat
  • lng
  • phone
  • address_type
  • merchant_id
  • image
  • email
  • facebook_id
  • extras
  • external_id
  • mobile_type
  • client_version
  • client_name
  • See Customer Object.

    customer_id

    Int32

    The Id of the customer associated with this order.

    dispatcher_id

    Int32

    If the dispatcher locked this order, the Id of the dispatcher.

    external_id

    string

    The order's external Id.

    fleet_id

    Int32

    If this order is assigned to an external fleet, this is the Id of that external fleet.

    late

    Int32

    Indicates whether the user (driver) has not arrived at way points in this order on or before the scheduled times. The values are:

    • false or 0 - the user (driver) is not late
    • true or 1 - the user (driver) is late

    The default value is false.

    last_assigned_time

    datetime

    The last date and time an order was assigned to the user (driver). This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

    merchant_id

    Int32

    The Id of the company. The merchant_id may be null, if the developer works with only one company.

    priority

    Int32

    The priority of this order.

    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

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

    status

    string

    This order's status. The value is TASK_LATE. NOTE: Other webhook's return status an Int32, but Order Was Rejected By Driver returns status as a string with a specific value (TASK_LATE).

    tag_id

    Int32

    If a tag exists, this is the Bringg tab Id.

    task_inventories

    Array of JSONs

    An array of JSONs containing this order's inventory, see Task Inventories.

    task_notes

    Array of JSONs

    An array of JSONs containing notes added to this order, see Task Notes.

    tip_driver_enabled

    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.

    updated_at

    datetime

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

    user_id

    Int32

    The Id of the user (driver).

    uuid

    Int32

    The universal unique Id of this order.

    way_points

    Array of JSONs

    An array of JSONs containing way_point information, see Way Point.