Skip to documentation
Browse documentation

Sample merchant coverage

Sample Blinkit delivery points within an area and group serving merchant IDs with location and delivery estimates.

Capability ID blinkit.merchant.coverage
Maximum runtime 180 seconds
View raw

POST /execute Shared execution endpoint

Input parameters

Provide bounds with south, north, west and east coordinates. South must be below north and west below east. The area can be at most 10,000 square km and each side at most 200 km.

grid_step_km sets the sampling spacing, from 1.5 to 20 km, default 5. sampling_limit caps the sampled points, from 1 to 200, default 25.

bounds object required

Geographic bounds of the requested area.

Example {"east":77.6,"north":12.872,"south":12.87,"west":77.598}
bounds.east number required

From -180 to 180.

bounds.north number required

From -85 to 85.

bounds.south number required

From -85 to 85.

bounds.west number required

From -180 to 180.

grid_step_km number optional

From 1.5 to 20. Default: `5`.

Example 5
sampling_limit integer optional

From 1 to 200. Default: `25`.

Example 1

Response

Successful output is returned in results[0].data.

Each merchant contains observations at sampled delivery points. The coordinates identify those points, not physical stores.

Use grid_complete, completed_points and stop_reason to understand sampling coverage. A capped or interrupted grid does not establish coverage of the full area or every address in a pincode. Physical store addresses, opening state and delivery radii are not returned.

Illustrative sample The example response is shown in the response panel.

Illustrative output fields

Values illustrate one response. Read the guidance above for missing values and limits; fields can vary with the requested operation and the data available.

PathObserved typeExample
results array 1 items
results array 1 items
sampling object 12 fields
sampling.attempted_points integer 1
sampling.bounds object 4 fields
sampling.completed_points integer 1
sampling.coordinates_scope string sampled_delivery_points
sampling.elapsed_ms integer 0
sampling.grid_complete boolean false
sampling.grid_points integer 4
sampling.grid_step_km integer 5
sampling.points array 1 items
sampling.selected_points integer 1
sampling.serviceable_points integer 1
sampling.stop_reason string sampling_limit

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

Overview, pricing and sample data for every endpoint: Blinkit API