post https://prefix-admin-api.bringg.com/open_fleet_services/checkin
Use this API call to mark when the driver arrives at the store/pickup or at the customer/dropoff.
EXAMPLE PAYLOAD
{
"task_id": 9497399,
"lat": 35.6826875,
"lng": -78.6702802,
"reported_time": 1591272971000,
"pickup_dropoff_option" : "pickup"
}
BODY PARAMS
|
* task_id Int32 |
Bringg's unique Order ID |
|
lat double |
The latitude of where the driver was when the action took place |
|
lng double |
The latitude of where the driver was when the action took place |
|
reported_time integer |
Unix Epoch time in milliseconds when the action took place |
|
pickup_dropoff_option string |
Indicates for which stop/destination the action is taking place. Possible values: "pickup", "dropoff", or "both" (seldom used). OPTIONAL |
What Bringg will send in response
{
"success": true,
"task": {
"title": "1591098207",
"user_id": 669602,
"created_at": "2020-06-02T11:43:28.866Z",
"scheduled_at": null,
"lat": 35.7686299,
"lng": -78.5487832,
"status": 3,
"id": 7188943,
"address": "5210 TRADEMARK DRIVE, RALEIGH, NC",
"active_way_point_id": 11061564,
"started_time": "2020-06-03T16:59:43.351Z",
"cancelled_at": null,
"cancellation_lat": null,
"cancellation_lng": null,
"late": false,
"extras": {
"integration": {
"trackingNumber": "1591098207",
"uniqueIdentifier": "ABC"
}
},
"external_id": "1591098207-R0",
"customer_id": 7199889,
"asap": null,
"ended_time": null,
"priority": 7188943,
"distance_traveled": null,
"total_price": null,
"delivery_cost": null,
"delivery_price": null,
"tip": null,
"pre_delivery_tip": null,
"post_delivery_tip_cash": null,
"post_delivery_tip_credit": null,
"left_to_be_paid": null,
"task_cancellation_reason": null,
"dispatcher_id": null,
"uuid": "c3952fcd-80ba-4e31-b1cd-bf861e2b0503",
"ready_to_execute": true,
"discount": null,
"tip_driver_enabled": false,
"tax_price": null,
"price_before_tax": null,
"tag_id": 588,
"group_uuid": null,
"group_leader_id": null,
"automatically_cancelled": 0,
"parent_task_id": null,
"payment_method": null,
"payment_type_name": null,
"linked_task_id": null,
"preparation_status": 0,
"preparation_start_time_planned": null,
"preparation_end_time_planned": null,
"preparation_ready_for_pickup_time_planned": null,
"invalidated": false,
"automatically_assigned": true,
"task_type_id": 4,
"origin_title": "Service",
"task_configuration_id": null,
"required_skills": [],
"team_ids": [
77910
],
"virtual_task": false,
"run_id": null,
"fleet_id": 180,
"preparation_external_id": null,
"rank": null,
"fleet_delivery_external_id": "123",
"task_notes": [],
"way_points": [
{
"id": 11061564,
"scheduled_at": null,
"has_to_leave_by": null,
"task_id": 7188943,
"customer_id": 7199890,
"done": false,
"lat": 35.7686299,
"lng": -78.5487832,
"address": "5210 TRADEMARK DRIVE, RALEIGH, NC",
"address_second_line": null,
"zipcode": "27610",
"position": 1,
"checkin_time": "2020-06-03T17:15:29.697Z",
"checkout_time": null,
"note": null,
"find_me": null,
"asap": null,
"late": false,
"etl": "2020-06-03T17:20:29.697Z",
"eta": null,
"silent": false,
"city": "Raleigh",
"borough": null,
"full_address": "5210 TRADEMARK DRIVE, RALEIGH, NC, Raleigh, 27610",
"automatic_checkin": false,
"automatic_checkout": false,
"phone": null,
"email": null,
"no_later_than": null,
"no_earlier_than": null,
"rating": null,
"checkin_lat": null,
"checkin_lng": null,
"checkout_lat": null,
"checkout_lng": null,
"district": null,
"house_number": null,
"company_name": null,
"pickup_dropoff_option": 0,
"etos": 300,
"address_type": null,
"location_name": null,
"scheduled_arrival": null,
"name": "Warehouse",
"ui_data": null,
"customer": {
"id": 7199890,
"name": "Warehouse",
"address": null,
"lat": null,
"lng": null,
"created_at": "2020-06-02T11:43:28.443Z",
"updated_at": "2020-06-02T11:43:28.452Z",
"phone": null,
"merchant_id": 1007,
"image": null,
"access_token": "e9e6cc96-d195-4b6a-a14b-767f40266880",
"confirmation_code": "1078",
"salt": null,
"approved": false,
"push_token": null,
"uuid": "4dfac88e-2ae2-4c38-95ee-edebde81746d",
"email": null,
"external_id": "7199890",
"delete_at": null,
"facebook_id": null,
"extras": null,
"original_lat_lng_changed": null,
"encrypted_password": "",
"blocked_email": false,
"address_second_line": null,
"zipcode": null,
"allow_login": false,
"stripe_id": null,
"original_phone_number": null,
"last_open_at": null,
"last_order_at": null,
"uploaded_profile_image": {
"url": "/images/avatar.png"
},
"original_lat": null,
"original_lng": null,
"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,
"allow_dynamically_updating_location": null,
"is_sales_rep": false,
"address_type": null,
"tax_payer_external_id": null,
"tax_payer_name": null,
"rank": null,
"user_id": null
}
},
{
"id": 11061565,
"scheduled_at": null,
"has_to_leave_by": null,
"task_id": 7188943,
"customer_id": 7199049,
"done": false,
"lat": 35.6961331,
"lng": -78.6922998,
"address": "6305 LAKE WHEELER RD",
"address_second_line": null,
"zipcode": "27603",
"position": 2,
"checkin_time": null,
"checkout_time": null,
"note": null,
"find_me": null,
"asap": null,
"late": false,
"etl": "2020-06-03T17:23:57.866Z",
"eta": "2020-06-03T17:18:57.866Z",
"silent": false,
"city": "RALEIGH",
"borough": null,
"full_address": "6305 LAKE WHEELER RD, RALEIGH, NC, 27603",
"automatic_checkin": false,
"automatic_checkout": false,
"phone": "+15555555555",
"email": "",
"no_later_than": null,
"no_earlier_than": null,
"rating": null,
"checkin_lat": null,
"checkin_lng": null,
"checkout_lat": null,
"checkout_lng": null,
"district": null,
"house_number": null,
"company_name": null,
"pickup_dropoff_option": 1,
"etos": 300,
"address_type": null,
"location_name": null,
"scheduled_arrival": null,
"name": "",
"ui_data": null,
"customer": {
"id": 7199049,
"name": "John Smith",
"address": null,
"lat": null,
"lng": null,
"created_at": "2020-06-02T08:01:47.114Z",
"updated_at": "2020-06-02T08:47:06.584Z",
"phone": "+15555555555",
"merchant_id": 1007,
"image": null,
"access_token": "767305d7-4eac-43fb-b731-6028f9f1d41b",
"confirmation_code": "1543",
"salt": null,
"approved": false,
"push_token": null,
"uuid": "0846443f-abcf-4a36-b033-387da774be06",
"email": "",
"external_id": "7199049",
"delete_at": null,
"facebook_id": null,
"extras": null,
"original_lat_lng_changed": null,
"encrypted_password": "",
"blocked_email": false,
"address_second_line": null,
"zipcode": null,
"allow_login": false,
"stripe_id": null,
"original_phone_number": "+15555555555",
"last_open_at": null,
"last_order_at": null,
"uploaded_profile_image": {
"url": "/images/avatar.png"
},
"original_lat": null,
"original_lng": null,
"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,
"allow_dynamically_updating_location": null,
"is_sales_rep": false,
"address_type": null,
"tax_payer_external_id": null,
"tax_payer_name": null,
"rank": null,
"user_id": null
}
}
],
"shared_locations": [],
"task_inventories": [
{
"id": 29417962,
"task_id": 7188943,
"inventory_id": 14323336,
"quantity": 0,
"original_quantity": 1,
"merchant_id": 1007,
"name": "MODULES",
"price": null,
"image": "/images/product-placeholder.png",
"way_point_id": 11061565,
"scan_string": "1591098207",
"pending": false,
"note": "Other",
"parent_task_inventory_id": null,
"coc_type": null,
"external_id": "14323336",
"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": 14323336,
"name": "MODULES",
"price": null,
"image": "/images/product-placeholder.png",
"merchant_id": 1007,
"external_id": "14323336",
"scan_string": "1591098207",
"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": 29417961,
"task_id": 7188943,
"inventory_id": 14323335,
"quantity": 0,
"original_quantity": 1,
"merchant_id": 1007,
"name": "MODULES",
"price": null,
"image": "/images/product-placeholder.png",
"way_point_id": 11061564,
"scan_string": "1591098207",
"pending": true,
"note": "Other",
"parent_task_inventory_id": null,
"coc_type": null,
"external_id": "14323335",
"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": 14323335,
"name": "MODULES",
"price": null,
"image": "/images/product-placeholder.png",
"merchant_id": 1007,
"external_id": "14323335",
"scan_string": "1591098207",
"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": [],
"invalid_reasons": [],
"service_plan": null
}
}
{
"success": false,
"rc": 1,
"message": "Can not checkin of a done task"
}