Start Order

Use this API call when the driver starts the order/delivery.

EXAMPLE PAYLOAD

While the only mandatory field in the payload is the Bringg Order ID , we strongly recommend you send as many of the other fields as possible:

{
  "task_id": 9707185,
  "lat": 35.6826875,
  "lng": -78.6702802,
  "reported_time": 1591272971000,
  "delivery_cost": 12.99,
  "green_delivery": true
}

BODY PARAMS

* task_id

Int32

Bringg's unique Order ID

lat

double

The latitude of where the driver was when the order was started

lng

double

The latitude of where the driver was when the order was started

reported_time

integer

Unix Epoch time in milliseconds when the order was started. For more information on how to get Epoch time, go to https://www.epochconverter.com/

delivery_cost

float

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

green_delivery

boolean

Show the consumer if the order was delivered by a green vehicle. OPTIONAL

NOTE: If reported_time is not provided in the payload, Bringg will default this to the current timestamp.

📘

What Bringg will send you in response

{
    "success": true,
    "task": {
        "title": "1591107425",
        "user_id": 662319,
        "created_at": "2020-06-02T14:17:05.803Z",
        "scheduled_at": null,
        "lat": 35.7686299,
        "lng": -78.5487832,
        "status": 2,
        "id": 7197059,
        "address": "5210 TRADEMARK DRIVE, RALEIGH, NC",
        "active_way_point_id": 11070509,
        "started_time": "2020-06-03T07:59:38.440Z",
        "asap": null,
        "late": false,
        "late_reason": null,
        "extras": {
            "integration": {
                "trackingNumber": "1591107425",
                "uniqueIdentifier": "ABC"
            }
        },
        "merchant_name": null,
        "external_id": "1591107425",
        "uuid": "8ec4c9a6-4fcb-4fb1-b94d-79aeeeb745cd",
        "priority": 7197059,
        "total_price": null,
        "delivery_price": null,
        "left_to_be_paid": null,
        "distance_traveled": null,
        "dispatcher_id": null,
        "tag_id": 588,
        "cancelled_at": null,
        "discount": null,
        "tip_driver_enabled": false,
        "run_uuid": null,
        "scheduled_to_be_ready": null,
        "run_start_time": null,
        "run_end_time": null,
        "payment_type_name": null,
        "linked_task_id": null,
        "fleet_id": 180,
        "fleet_delivery_external_id": "123",
        "first_way_point_has_to_leave_by": null,
        "origin_title": "Service",
        "customer": {
            "id": 7201388,
            "name": "John Smith",
            "address": null,
            "address_second_line": null,
            "zipcode": null,
            "lat": null,
            "lng": null,
            "phone": null,
            "image": "/images/avatar.png",
            "email": null,
            "merchant_id": 1007,
            "external_id": "7201388",
            "confirmation_code": "8892",
            "client_version": null,
            "client_name": null,
            "mobile_type": 0,
            "allow_login": false,
            "extras": null,
            "city": null,
            "borough": null,
            "state": null,
            "street": null,
            "business_code": null,
            "language": null,
            "rank": null,
            "team_ids": [],
            "customer_notes": []
        },
        "user": {
            "id": 662319,
            "name": "Test Driver1",
            "status": "offline",
            "sub": "Started",
            "lat": null,
            "lng": null,
            "profile_image": "https://www.routeone.com/sites/default/files/default_images/default-person.png",
            "phone": "+15555555555",
            "admin": false,
            "driver": true,
            "dispatcher": false,
            "customer": false,
            "current_task": null,
            "beta": false,
            "debug": false,
            "email": "[email protected]",
            "job_description": null,
            "driver_current_sign_in_at": null,
            "driver_sign_in_count": 0,
            "average_rating": null,
            "num_ratings": 0,
            "last_sign_in_at": null,
            "active_shift_id": 2494135,
            "created_at": "2020-06-02T15:22:28.806Z",
            "partner_user": false,
            "feature_flags": null,
            "authorization_flags": {
                "dispatch": {
                    "value": true
                },
                "create_order": {
                    "value": true
                },
                "view_task": {
                    "value": true
                },
                "acknowledge": {
                    "value": true
                },
                "history": {
                    "value": true
                },
                "drivers": {
                    "value": true
                },
                "driver_profile": {
                    "value": true
                },
                "add_driver": {
                    "value": true
                },
                "change_driver_type": {
                    "value": true
                },
                "assign_driver_to_task": {
                    "value": true
                },
                "teams": {
                    "value": true
                },
                "user_types": {
                    "value": true
                },
                "customers_menu": {
                    "value": true
                },
                "reports": {
                    "value": true
                },
                "dashboard": {
                    "value": true
                },
                "cashout_edit_distance": {
                    "value": true
                },
                "access_settings_screen": {
                    "value": true
                },
                "customer_care": {
                    "value": true
                },
                "maintain_driver_shift_times": {
                    "value": true
                },
                "complete_task": {
                    "value": true
                },
                "edit_delivery_block": {
                    "value": true
                },
                "send_to_preparation": {
                    "value": true
                },
                "access_task": {
                    "access_to_all_tasks": true
                },
                "access_user": {
                    "access_to_all_users": true
                },
                "edit_company": {
                    "value": false
                },
                "cancel_task": {
                    "value": true
                },
                "lock_unlock_task": {
                    "value": true
                },
                "reschedule_cancelled_order": {
                    "value": true
                },
                "edit_task_details": {
                    "value": true
                },
                "assign_user_to_company": {
                    "value": false
                },
                "enable_bi_dashboard": {
                    "value": false
                },
                "enable_webhooks": {
                    "value": false
                },
                "enable_merchant_logs": {
                    "value": false
                },
                "enable_setting_page": {
                    "value": false
                },
                "enable_self_assignment_to_teams": {
                    "value": false
                },
                "edit_exclusion_windows": {
                    "value": false
                }
            },
            "confirmed_at": null,
            "confirmation_sent_at": null,
            "battery": null,
            "uuid": "890f1abd-8938-434f-85d7-080a1e9ca8fb",
            "mobile_type": null,
            "mobile_version": null,
            "device_model": null,
            "default_user_activity": 5,
            "language": null,
            "merchant_id": 1007,
            "locked": false,
            "user_type_id": null,
            "privilege_id": null,
            "estimated_last_address": null,
            "estimated_last_lat": null,
            "estimated_last_lng": null,
            "estimated_last_etl": null,
            "external_id": "test_driver1",
            "at_home": false,
            "company": null,
            "private_vehicle": true,
            "original_user_id": null,
            "default_welcome_url_id": null,
            "enable_logs": null,
            "in_beacon_range": false,
            "home_address": null,
            "home_lat": null,
            "home_lng": null,
            "skills": [],
            "vehicle_skills": [],
            "rank": 5,
            "os_version": null,
            "app_id": null,
            "company_id": null,
            "team_ids": []
        },
        "task_notes": [],
        "way_points": [
            {
                "id": 11070509,
                "scheduled_at": null,
                "has_to_leave_by": null,
                "task_id": 7197059,
                "customer_id": 7201389,
                "done": false,
                "lat": 35.7686299,
                "lng": -78.5487832,
                "address": "5210 TRADEMARK DRIVE, RALEIGH, NC",
                "address_second_line": null,
                "zipcode": "27610",
                "position": 1,
                "city": "Raleigh",
                "borough": null,
                "street": null,
                "checkin_time": null,
                "checkout_time": null,
                "note": null,
                "find_me": null,
                "asap": null,
                "late": false,
                "etl": null,
                "eta": null,
                "silent": false,
                "allow_editing_inventory": true,
                "allow_editing_payment": null,
                "allow_scanning_inventory": true,
                "automatic_checkin": null,
                "automatic_checkout": null,
                "phone": null,
                "distance_traveled_server": null,
                "must_approve_inventory": false,
                "contacts": [],
                "no_later_than": null,
                "no_earlier_than": null,
                "extra_customers": [],
                "pending_geocode": false,
                "etos": 300,
                "address_type": null,
                "location_name": null,
                "name": "Warehouse",
                "ui_data": null,
                "customer": {
                    "id": 7201389,
                    "name": "Warehouse",
                    "address": null,
                    "address_second_line": null,
                    "zipcode": null,
                    "lat": null,
                    "lng": null,
                    "phone": null,
                    "image": "/images/avatar.png",
                    "email": null,
                    "merchant_id": 1007,
                    "external_id": "7201389",
                    "confirmation_code": "4301",
                    "client_version": null,
                    "client_name": null,
                    "mobile_type": 0,
                    "allow_login": false,
                    "extras": null,
                    "city": null,
                    "borough": null,
                    "state": null,
                    "street": null,
                    "business_code": null,
                    "language": null,
                    "rank": null,
                    "team_ids": [],
                    "customer_notes": []
                },
                "rating": null,
                "inventory_changes": []
            },
            {
                "id": 11070510,
                "scheduled_at": null,
                "has_to_leave_by": null,
                "task_id": 7197059,
                "customer_id": 7199049,
                "done": false,
                "lat": 35.6961331,
                "lng": -78.6922998,
                "address": "6305 LAKE WHEELER RD",
                "address_second_line": null,
                "zipcode": "27603",
                "position": 2,
                "city": "RALEIGH",
                "borough": null,
                "street": null,
                "checkin_time": null,
                "checkout_time": null,
                "note": null,
                "find_me": null,
                "asap": null,
                "late": false,
                "etl": null,
                "eta": null,
                "silent": false,
                "allow_editing_inventory": true,
                "allow_editing_payment": null,
                "allow_scanning_inventory": true,
                "automatic_checkin": null,
                "automatic_checkout": null,
                "phone": "+15555555555",
                "distance_traveled_server": null,
                "must_approve_inventory": false,
                "contacts": [
                    {
                        "customer_id": 7199049,
                        "contact_type": "phone",
                        "contact_value": "+15555555555",
                        "sharing_allowed": true,
                        "opted_by_customer": false
                    }
                ],
                "no_later_than": null,
                "no_earlier_than": null,
                "extra_customers": [],
                "pending_geocode": null,
                "etos": 300,
                "address_type": null,
                "location_name": null,
                "name": "",
                "ui_data": null,
                "customer": {
                    "id": 7199049,
                    "name": "John Smith",
                    "address": null,
                    "address_second_line": null,
                    "zipcode": null,
                    "lat": null,
                    "lng": null,
                    "phone": "+19192054392",
                    "image": "/images/avatar.png",
                    "email": "",
                    "merchant_id": 1007,
                    "external_id": "7199049",
                    "confirmation_code": "1543",
                    "client_version": null,
                    "client_name": null,
                    "mobile_type": 0,
                    "allow_login": false,
                    "extras": null,
                    "city": null,
                    "borough": null,
                    "state": null,
                    "street": null,
                    "business_code": null,
                    "language": null,
                    "rank": null,
                    "team_ids": [],
                    "customer_notes": []
                },
                "rating": null,
                "inventory_changes": []
            }
        ],
        "shared_locations": [],
        "team_ids": [
            77910
        ],
        "task_inventories": [
            {
                "id": 29433150,
                "task_id": 7197059,
                "inventory_id": 14336497,
                "quantity": 0,
                "original_quantity": 1,
                "merchant_id": 1007,
                "name": "MODULES",
                "price": null,
                "image": "/images/product-placeholder.png",
                "way_point_id": 11070509,
                "scan_string": "1591107425",
                "pending": true,
                "note": "Other",
                "parent_task_inventory_id": null,
                "coc_type": null,
                "external_id": "14336497",
                "size": null,
                "weight": 450.0,
                "length": null,
                "height": null,
                "width": null,
                "source_task_id": null,
                "rejected_quantity": 0,
                "assigned_serial": null,
                "actions_configuration_id": null,
                "scheduled_arrival": null,
                "inventory": {
                    "id": 14336497,
                    "name": "MODULES",
                    "price": null,
                    "image": "/images/product-placeholder.png",
                    "merchant_id": 1007,
                    "external_id": "14336497",
                    "scan_string": "1591107425",
                    "commodity": null,
                    "notes": null,
                    "weight": 450.0,
                    "size": null,
                    "extras": null,
                    "delivery_cost": null,
                    "completed": null,
                    "width": null,
                    "height": null,
                    "length": null,
                    "volume": null,
                    "description": null,
                    "limitations": null,
                    "age_restricted": null
                }
            },
            {
                "id": 29433151,
                "task_id": 7197059,
                "inventory_id": 14336498,
                "quantity": 0,
                "original_quantity": 1,
                "merchant_id": 1007,
                "name": "MODULES",
                "price": null,
                "image": "/images/product-placeholder.png",
                "way_point_id": 11070510,
                "scan_string": "1591107425",
                "pending": false,
                "note": "Other",
                "parent_task_inventory_id": null,
                "coc_type": null,
                "external_id": "14336498",
                "size": null,
                "weight": 450.0,
                "length": null,
                "height": null,
                "width": null,
                "source_task_id": null,
                "rejected_quantity": 0,
                "assigned_serial": null,
                "actions_configuration_id": null,
                "scheduled_arrival": null,
                "inventory": {
                    "id": 14336498,
                    "name": "MODULES",
                    "price": null,
                    "image": "/images/product-placeholder.png",
                    "merchant_id": 1007,
                    "external_id": "14336498",
                    "scan_string": "1591107425",
                    "commodity": null,
                    "notes": null,
                    "weight": 450.0,
                    "size": null,
                    "extras": null,
                    "delivery_cost": null,
                    "completed": null,
                    "width": null,
                    "height": null,
                    "length": null,
                    "volume": null,
                    "description": null,
                    "limitations": null,
                    "age_restricted": null
                }
            }
        ],
        "scans": []
    }
}