Merchant Data API Reference

Fetching all available merchant types#

Send a GET request to https://console.datasutram.com/api/poi/allpoitypes?category=merchant. All available #merchant types are returned in the response.

[
  "mandi",
  "petrol_pump",
  "jewellery_store",
  "grocery",
  "restaurant",
  "BC_agent",
  "chemist",
  "travel_agent",
  "garage",
  "school",
  "money_transfer_service",
  "diagnostic_centre",
  "insurance_agent",
  "telecom_store",
  "daily_utility",
  "store"
]

Merchant Data#

The Merchant Acquisition API takes Location(Pincode only) and Merchant Types as required parameters and returns a list of Merchants, in paginated format. Other than these two parameters, for custom search - this API also accepts an array of coordinates for which either Radial Search(Merchants falling within the catchment) or Reverse Radial Search(Merchants falling outside the catchment and within the selected Pincode) around the coordinates. "limit" parameter is used to control the number of merchants per page, and "page" is used to control the response page number. Default value for "page" is 1, and "limit" is 10.

A table for reference to footfall values in response

Footfall Range	People Count
0 - 0.2	0 - 500
0.2 - 0.4	500 - 1000
0.4 - 0.6	1000 - 5000
0.6 - 0.8	1500 - 2000
0.8+	2000+

Send a POST request to https://console.datasutram.com/api/acquisition/merchant-v3 to get Merchants using just the Pincode and the Merchant Types.

{
  "location": {
    "Pincode": "400050"
  },
  "types":
    ["pharmacy", "grocery"]
}

Response:

{
  "count": 10,
  "page": 1,
  "totalCount": 48,
  "data": [
    {
      "address": "Waterfield Road,A17, Police Quarter, Bandra West",
      "category": "merchant",
      "geometry": {
        "type": "Point",
        "coordinates": [
          "19.0579755",
          "72.8340913"
        ]
      },
      "id": 1347817,
      "index": {
        "footfall": "0.1333",
        "market_area": "Yes",
      },
      "locationDetails": {
        "Pincode": "400050",
        "Taluka": "Mumbai City",
        "District": "mumbai suburban",
        "State": "maharashtra"
      },
      "merchantId": "DSGRAAOWL",
      "merchantType": "grocery",
      "name": "Bandra Consumer Co-operative Society"
    }, ... 9 more items
  ]
}

Add limit and page parameters to control the response as per the paginated format.

{
  "location": {
    "Pincode": "400050"
  },
  "types":
    ["pharmacy", "grocery"],
  "limit": 20,
  "page": 2
}

Response:

{
  "count": 20,
  "page": 2,
  "totalCount": 48,
  "data": [
    {
      "address": "Shop No. 4, Kit Kat Society, Bandra West",
      "category": "merchant",
      "geometry": {
        "type": "Point",
        "coordinates": [
          "19.061158",
          "72.830219"
        ]
      },
      "id": 1347813,
      "index": {
        "footfall": "0.1333",
        "market_area": "Yes"
      },
      "locationDetails": {
        "Pincode": "400050",
        "Taluka": "Mumbai City",
        "District": "mumbai suburban",
        "State": "maharashtra"
      },
      "merchantId": "DSGRAAOWH",
      "merchantType": "grocery",
      "name": "Amy General Stores"
    }, ... 19 more items
  ]
}

Send a POST request to https://console.datasutram.com/api/acquisition/merchant-v3 to get Merchants using Coordinates.

{
    "within": {
        "radius":1,
        "points":[{"lat":19.09534,"lng":72.86502}]
    },
    "types":["pharmacy", "grocery"]
}

Response

{
  "count": 10,
  "page": 1,
  "totalCount": 46,
  "data": [
    {
      "address": "M C Chagla Road,Anthony Cottage, Vile Parle East",
      "category": "merchant",
      "geometry": {
        "type": "Point",
        "coordinates": [
          "19.1044162",
          "72.8585660999999"
        ]
      },
      "id": 1348910,
      "index": {
        "footfall": "0.1667",
        "market_area": "Yes"
      },
      "locationDetails": {
        "Pincode": "400099",
        "Taluka": "Mumbai Suburban",
        "District": "mumbai suburban",
        "State": "maharashtra"
      },
      "merchantId": "DSGRAAQMF",
      "merchantType": "grocery",
      "name": "Pramanik Super Stores"
    }, ... 9 more items
  ]
}