USusenash
Route

Find Nearby Couriers

Changed on

Nearest couriers on active routes (assigned, started, in progress) to a point, ranked by straight-line distance from each courier's latest GPS ping. Couriers with no recorded ping are omitted. Scope to one depot with store_location_id, and leave out the route being rescued with exclude_route_ids.

get/v1/routes/nearby-couriers

Request

Query parameters

latnumber required

Latitude to measure from, e.g. the stranded driver.

lngnumber required

Longitude to measure from.

limitinteger

Maximum couriers to return.

store_location_idstring nullable

Only routes carrying an order picked up at this store location.

exclude_route_idsstring nullable

Comma-separated route ids to leave out, along with their couriers, e.g. the route that needs rescuing.

max_location_age_minutesinteger

Ignore couriers whose latest ping is older than this.

Response

OK

Changes