Indicating multiple or bulk arrival and leaving
Use this API call when you want to do a bulk pickup of orders from a location (e.g. merchant's warehouse) and bring them back to your distribution center / warehouse (middle mile). Only after the orders are in your location will a driver go out and deliver each order separately (last mile).
What this means is that you don't want to Start an Order until after cluster pickup. Once your driver is ready to leave your center on their way to the customer, now is the time to send the Start Order API call.
Assign a Driver First
Before doing a cluster checkin/checkout, make sure that you have assigned a driver to the orders using the Assign Driver API call.
EXAMPLE PAYLOAD
{
"task_ids": [123, 456, 789],
"pickup_dropoff_option" : "pickup",
"way_point_position": 1,
"lat": 35.7826875,
"lng": -78.7702802,
"reported_time": 1595592696000
}
{
"task_ids": [8507308, 8551389],
"way_point_position": 1,
"lat": 35.7826875,
"lng": -78.7702802,
"reported_time": 1595592696000
}
BODY PARAMS
|
* task_ids Array of integers |
List of Bringg Order IDs |
|
*pickup_dropoff_option string |
Indicates for which stop/destination the action is taking place. Possible values: "pickup", "dropoff", or "both" (seldom used). OPTIONAL |
|
way_point_position integer |
DEPRECATED : Indicates for which stop (way point) this action needs to take effect. Values are 1 (pickup / warehouse) or 2 (dropoff / customer). In most cases, the value will be 1. |
|
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 the action took place |
|
reported_time integer |
Unix Epoch time in milliseconds when the action took place |
What Bringg will send you in response
{
"success": true,
"way_points_checked_in": [
123,
456,
789
]
}
{
"success": true,
"way_points_checked_out": [
123,
456,
789
]
}
401 Unauthorized Error
If you get this error when you submit the API, it means that either the task_id that you specified is not assigned to your fleet or you made a mistake with the value.