API Version: 
Version 2.0 - March 30, 2017

Introduction:

The Walgreens Store Locator API enables third party applications customers to get realtime dynamic store location information about any of our 8,200+ Walgreens and Duane Reade store locations.

Documentation/Services Highlights:

  • Added detailed description tables for all the request json body parameters!
  • New Endpoint! Get all the active store numbers!

Technical Information:

  • Request an API Key
  • "QA" Observe the badge on the right, this also known as "Staging" or "Test" - use this for testing purposes
  • "PR" Observe the badge on the right, this also known as "Production" of "Prod" - only use this when the application is released publicly

Store Locator Flow:

The external services listed below make up the complete list of services that are available to get all information available via the Store Locator API.

In order to ensure your integration is both future and backwards compatible, please make sure that the integration is only reading the parameters which will display in the app UI and do not impose strict parsing or typecasting logic for any of the API response parameters. We may add new request and response parameters to our APIs in order to offer enhanced functionality and to support multiple products in a contiguous way.

Store Search:

Description: This service is used to fetch the "stores" array which is the list of 10 stores nearest to the "lat" and "lng" passed into the API. Request Content-type is application/json. The Store Search request should be a HTTPS POST.

Attribute Required/Optional Description
apiKey required The API Key that you have been approved for. Can be found here.
affId required The AffiliateID that you was given in your application email.
lat required The lat value is the latitude of point your are trying to locate stores.
lng required The lng value is the longitude of point your are trying to locate stores.
srchOpt optional value See below section Explaining the search option parameter.
nxtPrev optional value The nxtPrev is used for pagination. Passing "next", gives the next 10 stores. Passing "prev", gives the previous 10 stores. Defaulted to "".
requestType required The RequestType is a value that invokes our internal service. The value must be "locator".
act required The Action is a value that invokes our internal service. The value must be "fndStore".
view required The View is a value that invokes our internal service. The value must be "fndStoreJSON".
devinf optional value See below section Explaining Device Info
appver optional value See below section Explaining App version

Search Filters Info:

This parameter is what can be used to find stores with certain features. It is defaulted to "", this would return all stores regardless of their features. The parameter can also be set to comma-separated list of any of the following:

Value Filter Description
"t4hr" Only store locations open 24 hours
"t4hr_rx" Only store locations with pharmacy open 24 hours
"dt" Only store locations with a Drive-Thru Pharmacy
"tc" Only store locations with a Healthcare Clinic
"phi" Only store locations with a Photo Lab
"cbw" Only store locations with Beer and Wine
"cdr" Only store locations that are Duane Reade
"evc" Only store locations with Electric Vehicle Charging Stations
"rb" Only store locations with Redbox DVD Rentals
"cpge" Only store locations with Blue Rhino Propane Gas Exchanges
"fs" Only store locations with Flu Shots
"icp" Only store locations that treat Chickenpox series (Varicella)
"fsim" Only store locations that treat Flu (Influenza)
"iha" Only store locations that treat Hepatitis A series
"ihb" Only store locations that treat Hepatitis B series
"ihc" Only store locations that treat Hepatitis A/B combination
"ihpv" Only store locations that treat Human Papillomavirus (HPV)
"ije" Only store locations that treat Japanese Encephalitis
"imn" Only store locations that treat Meningitis (Meningococcal)
"immr" Only store locations that treat Measles, Mumps, Rubella (MMR)
"ipn" Only store locations that treat Pneumonia (Pneumococcal)
"ipol" Only store locations that treat Polio
"irb" Only store locations that treat Rabies
"sv" Only store locations that treat Shingles(Herpes Zoster)
"iwc" Only store locations that treat Tetanus, Diphtheria, Pertussis/Whooping Cough (Tdap)
"itd" Only store locations that treat Tetanus & Diphtheria (Td)
"ity" Only store locations that treat Typhoid
"iyf" Only store locations that treat Yellow Fever
"hhs" Only store locations that have Hepatitis Support
"hiv" Only store locations that have HIV/AIDS Support
"chhc" Only store locations that have Home Health Care Solutions
"his" Only store locations that have Infertility Support
"mc" Only store locations that have Medication Compounding
"hos" Only store locations that have Optical Services
"hts" Only store locations that have Transplant Support
"thsv_ind" Only store locations that have TravelHealth Consultations

Store Number List:

Description: This service is used to obtain the active "stores" array. Which contains all the "storeNo" that can be passed into the store details API. Request Content-type is application/json. The Store Number List request should be a HTTPS POST.

Attribute Required/Optional Description
apiKey required The API Key that you have been approved for. Can be found here.
affId required The AffiliateID that you was given in your application email.
act required The Action is a value that invokes our internal service. The value must be "storeNumber".
devinf optional value See below section Explaining Device Info
appver optional value See below section Explaining App version

Store Details:

Description: This service is used to fetch the immense details for a single store based on the "storeNo" passed into the API. Request Content-type is application/json. The Store Details request should be a HTTPS POST.

Attribute Required/Optional Description
apiKey required The API Key that you have been approved for. Can be found here.
affId required The AffiliateID that you was given in your application email.
storeNo required The storeNo value is the store number of the store you are attempting to query. Can be obtained from either of the above services.
act required The Action is a value that invokes our internal service. The value must be "storeDtl".
view required The View is a value that invokes our internal service. The value must be "storeDtlJSON".
devinf optional value See below section Explaining Device Info
appver optional value See below section Explaining App version

Error Codes:

Error Code Description
403 Either your "apiKey" parameter is invalid, or you did not pass the JSON in the POST body correctly.
500 The "affId" passed is invalid.
501 The "POST" HTTP method was not used.
502 The "affId" passed was not readable.
503 The protocol used was not "HTTPS".
504 The request took too long to send. Please try again.
506-512 Multiple different issues, but most likely is our servers are down...

App Version Parameter:

Description: Information about the version of your application the customer is using. Useful to us both for debugging product order issues/bugs.

Examples: "1.00" or "1.01" or "1.10" or "10.01"


Device Info Parameter:

Description: Information about the customers device

Examples:

Device OS Version devinf Value
iPhone 10.2 "iPhone,10.2"
iPad 10.2 "iPad,10.2"
iPod 10.2 "iPod,10.2"
Android 7.0 "Android,7.0"
Android Tablet 7.0 "AndroidTablet,7.0"
Chrome 43.0.1410.65 "Chrome,26.0"
Windows 8.1 "Windows,10.2"
Internet Explorer Browser "IE,11"
Safari Browser "Safari,6.0"
Opera Browser "Opera,12.15"

Disclaimer:

Consistent with the Terms of Use, your ability to launch a production integration of an Application is subject to approval by Walgreens.