GET api/PharmacyLocator/paged?zipCode={zipCode}&page={page}&pagesize={pagesize}&maxDistance={maxDistance}&bin={bin}&groupCode={groupCode}

Retrieves a list of pharmacies within a specified distance from a given zip code.

Request Information

URI Parameters

Name	Description	Type	Additional information
zipCode	The zip code used as the center point for locating pharmacies.	string	Required
page	The 1-based index of the page of pharmacy locations to return ( 1 by default)	integer	Required
pagesize	The number of pharmacy locations to return per page (25 by default, max 100)	integer	Required
maxDistance	The maximum distance (in miles) from the zip code within which to search for pharmacies. This parameter is optional. Its default value is 10 and its maximum is 100.	integer	Default value is 10
bin	The BIN used for filtering pharmacies. This parameter is optional if both `bin` and `groupCode` are not provided. If either `bin` or `groupCode` is provided, both are required.	string	None.
groupCode	The group code used for filtering pharmacies. This parameter is optional if both `bin` and `groupCode` are not provided. If either `bin` or `groupCode` is provided, both are required.	string	None.

Body Parameters

None.

Response Information

Resource Description

Returns a list of the closest 100 pharmacies located within the specified distance of the provided zip code.

PagedResultModelOfPharmacyLocatorResponseModel

Name	Type	Additional information
PageNumber	integer	None.
PageCount	integer	None.
PageSize	integer	None.
Items	Collection of PharmacyLocatorResponseModel	None.
TotalRecordCount	integer	None.

Response Formats

application/json, text/json, application/json-patch+json

Sample:

{
  "pageNumber": 1,
  "pageCount": 2,
  "pageSize": 3,
  "items": [
    {
      "npi": "sample string 2",
      "locationName": "sample string 3",
      "streetAddress": "sample string 4",
      "city": "sample string 5",
      "stateCode": "sample string 6",
      "zipCode": "sample string 7",
      "phoneNumber": "sample string 8",
      "phoneExt": "sample string 9",
      "phoneNumberFull": "sample string 10",
      "distance": 11.0,
      "latitude": 1.0,
      "longitude": 1.0
    },
    {
      "npi": "sample string 2",
      "locationName": "sample string 3",
      "streetAddress": "sample string 4",
      "city": "sample string 5",
      "stateCode": "sample string 6",
      "zipCode": "sample string 7",
      "phoneNumber": "sample string 8",
      "phoneExt": "sample string 9",
      "phoneNumberFull": "sample string 10",
      "distance": 11.0,
      "latitude": 1.0,
      "longitude": 1.0
    }
  ],
  "totalRecordCount": 4
}