GET api/PharmacyLocator?zipCode={zipCode}&maxDistance={maxDistance}&bin={bin}&groupCode={groupCode}&pharmacyHeadquarterNo={pharmacyHeadquarterNo}&name={name}&city={city}&stateCode={stateCode}&npi={npi}&ncpdp={ncpdp}

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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
zipCode

The zip code used as the center point for locating pharmacies.

 string

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.
pharmacyHeadquarterNo

The pharmacy Headquarter used for filtering pharmacies. This parameter is optional.

 integer

None.
name

The name used for filtering pharmacies. This parameter is optional.

 string

None.
city

The city for filtering pharmacies. This parameter is optional.

 string

None.
stateCode

The state code used for filtering pharmacies. This parameter is optional.

 string

None.
npi

The NPI used for filtering pharmacies. This parameter is optional.

 string

None.
ncpdp

The NCPDP used for filtering pharmacies. This parameter is optional.

 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.

Collection of PharmacyLocatorResponseModel
NameDescriptionTypeAdditional information
NPI

string

None.
LocationName

The name of the pharmacy

 string

None.
StreetAddress

The address of the pharmacy

 string

None.
City

The city of the pharmacy

 string

None.
StateCode

The state of the pharmacy

 string

None.
ZipCode

The zip code of the pharmacy

 string

None.
PhoneNumber

The phone number of the pharmacy

 string

None.
PhoneExt

The phone number extension of the pharmacy

 string

None.
PhoneNumberFull

The full phone number of the pharmacy

 string

None.
Distance

The distancy of the pharmacy from the zip code entered

 decimal number

None.
Latitude

The latitude of the pharmacy

 decimal number

None.
Longitude

The longitude of the pharmacy

 decimal number

None.
NCPDP

The NCPDP ID

 string

None.
PharmacyHeadquarterUrl

Gets or sets the link to the underlying Pharmacy Headquarter

 string

None.
PharmacyHeadquarterNo

Gets or sets the identifier for the pharmacy headquarter associated with this Applied Pharmacy Headquarter Exception

 integer

None.
ProviderHours

The provider hours

 string

None.
Is24HourOperation

The provider is 24 hours operation

 boolean

None.

Response Formats

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

Sample: 
[
  {
    "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,
    "ncpdp": "sample string 14",
    "pharmacyHeadquarterUrl": "sample string 15",
    "pharmacyHeadquarterNo": 1,
    "providerHours": "sample string 16",
    "is24HourOperation": true
  },
  {
    "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,
    "ncpdp": "sample string 14",
    "pharmacyHeadquarterUrl": "sample string 15",
    "pharmacyHeadquarterNo": 1,
    "providerHours": "sample string 16",
    "is24HourOperation": true
  }
]