Eligibility API

This request will provide the eligibility of specific vaccination or immunization for a given state / dob.

Endpoint URL

Sandbox:
https://services-qa.walgreens.com/api/vaccine/scheduling/eligibility/v1
Production:
https://services.walgreens.com/api/vaccine/scheduling/eligibility/v1

Endpoint Information

Request Body

Example Request

curl --request POST \ 
--location 'https://services-qa.walgreens.com/api/vaccine/scheduling/eligibility/v1' \
--header 'Content-Type: application/json' \
--data '{
	"apiKey": "YOUR_API_KEY",
	"affId": "YOUR_AFFILIATE_ID",
	"state": "STATE_OF_PATIENT",
	"dob": "DATE_OF_BIRTH_OF_PATIENT"
}' \

Example Response

{
	"state": "STATE_OF_PATIENT",
	"age": 34,
	"category": null,
	"dob": "09/30/1990",
	"eligibleVaccineList": [{
		"vaccineCode": "VACCINE_CODE",
		"displayName": "DISPLAY_NAME",
		"eligible": ELIGIGIBILITY_FLAG,
		"vaccineType": "VACCINE_TYPE",
		"vaccineDisplayOrder": SUGGESTED_DISPLAY_ORDER,
		"restrictions": [{
			"code": "RESTRICTION_CODE",
			"message": "RESTRICTION_MESSAGE",
			"vaccineCode": "VACCINE_CODE",
			"minimunAge": RESTRICTION_MIN_AGE,
			"maximumAge": RESTRICTION_MAX_AGE
		}],
		"warnings": [{
			"code": "WARNING_CODE",
			"message": "WARNING_MESSAGE",
			"vaccineCode": "VACCINE_CODE",
			"minimunAge": WARNING_MIN_AGE,
			"maximumAge": WARNING_MAX_AGE
		}],
		"multiDose": IS_MULTI_DOSE,
		"seriesNumber": SERIES_NUMBER_META_DATA,
		"group": "IS_GROUPED_META_DATA",
		"serviceId": "SERVICE_ID_META_DATA"
	},
	...shortened for brevity
	],
	"inEligibleVaccineList": [{
		"vaccineCode": "VACCINE_CODE",
		"displayName": "DISPLAY_NAME",
		"eligible": ELIGIGIBILITY_FLAG,
		"vaccineType": "VACCINE_TYPE",
		"vaccineDisplayOrder": SUGGESTED_DISPLAY_ORDER,
		"restrictions": [{
			"code": "RESTRICTION_CODE",
			"message": "RESTRICTION_MESSAGE",
			"vaccineCode": "VACCINE_CODE",
			"minimunAge": RESTRICTION_MIN_AGE,
			"maximumAge": RESTRICTION_MAX_AGE
		}],
		"warnings": [{
			"code": "WARNING_CODE",
			"message": "WARNING_MESSAGE",
			"vaccineCode": "VACCINE_CODE",
			"minimunAge": WARNING_MIN_AGE,
			"maximumAge": WARNING_MAX_AGE
		}],
		"multiDose": IS_MULTI_DOSE,
		"seriesNumber": SERIES_NUMBER_META_DATA,
		"group": "IS_GROUPED_META_DATA",
		"serviceId": "SERVICE_ID_META_DATA"
	},
	...shortened for brevity
	]
}

Timeslots API

This request will provide the timeslots of available appointments for a specific vaccination or immunization at specific Walgreens locations.

Endpoint URL

Sandbox:
https://services-qa.walgreens.com/api/vaccine/scheduling/timeslots/v1
Production:
https://services.walgreens.com/api/vaccine/scheduling/timeslots/v1

Endpoint Information

Request Body

Example Request

curl --request POST \ 
--location 'https://services-qa.walgreens.com/api/vaccine/scheduling/timeslots/v1' \
--header 'Content-Type: application/json' \
--data '{
	"apiKey": "YOUR_API_KEY",
	"affId": "YOUR_AFFILIATE_ID",
	"state": "IL",
	"zipCode": "94015",
	"dob": "2001-01-01",
	"vaccine": [
		"207",
		"150",
		"93"
	],
	"isEligibility": false,
	"appointmentAvailability": {
		"startDateTime": "2024-04-28",
		"endDateTime": "2024-04-29"
	},
	"position": {
		"latitude": 42.0646736,
		"longitude": -87.93838219999999
	}
}' \

Example Response

{
	"locations": [{
		"locationId": "THE_LOCATION_ID",
		"name": "THE_LOCATION_NAME",
		"storenumber": "THE_STORE_NUMBER",
		"description": "THE_STORE_DESCRIPTION",
		"position": {
			"latitude": STORE_LATITUDE,
			"longitude": STORE_LONGITUDE
		},
		"address": {
			"line1": "STORE_STREET_ADDRESS",
			"line2": "STORE_STREET_ADDRESS_2",
			"city": "STORE_CITY",
			"state": "STORE_STATE",
			"country": "STORE_COUNTRY",
			"zip": "STORE_ZIP"
		},
		"phone": [{
			"type": "STORE_PHONE_TYPE",
			"number": "STORE_PHONE_NUMBER"
		},
		...shortened for brevity
		],
		"distance": #.#,
		"timeZone": "STORE_TIMEZONE_2_CHAR",
		"appointmentAvailability": [{
			"manufacturer": [{
				"productId": "MANUFACTURER_PRODUCT_ID",
				"vaccineCode": "WALGREENS_VACCINE_CODE",
				"vaccineName": "WALGREENS_VACCINE_NAME",
				"category": "WALGREENS_VACCINE_CATEGORY",
				"prescriptionRequired": true or false
			},
			...shortened for brevity
			],
			"date": "YYYY-MM-DD",
			"day": "DAY_OF_WEEK",
			"slots": [
				"HH:MM am",
				"HH:MM pm",
				...shortened for brevity
			],
			"numberOfSlotsAvailable": NUMBER_OF_SLOTS_AVAILABLE
		},
		...shortened for brevity
		]
	},
	...shortened for brevity
	]
}

Hold Appointment API

This request enables users to hold vaccinations or immunization appointment timeslots at nearby Walgreens stores based on vaccine availability which were selected from the Timeslots request.

Endpoint URL

Sandbox:
https://services-qa.walgreens.com/api/vaccine/scheduling/hold/v1
Production:
https://services.walgreens.com/api/vaccine/scheduling/hold/v1

Endpoint Information

Request Body

Example Request

curl --request POST \ 
--location 'https://services-qa.walgreens.com/api/vaccine/scheduling/hold/v1' \
--header 'Content-Type: application/json' \
--data '{
	"apiKey": "YOUR_API_KEY",
	"affId": "YOUR_AFFILIATE_ID",
	"locationId": "USER_SELECTED_TIMESLOT_LOCATION_ID", 
	"appointmentDate": "USER_SELECTED_TIMESLOT_APPOINTMENT_DATE_TIME_STAMP",
	"slot": "USER_SELECTED_TIMESLOT_TIME",
	"channel": "Web",
	"client": "YOUR_CLIENT_NAME",
	"engagementType": "Guest",
	"vaccines": [{
		"code": "USER_SELECTED_TIMESLOT_VACCINATION_CODE",
		"productId": "USER_SELECTED_TIMESLOT_VACCINATION_PRODUCT_ID"
	}]
  }' \

Example Response

{
	"engagementId": "USER_SESSION_ENGAGEMENT_ID"
}

Patient Attach API

This request creates a new patient record with personal identifiable information (PII) for a given engagementId retrieved from the Hold Appointment API. The response does not return a Patient ID, and the PII is used only to create vaccination or immunization appointment booking.

Endpoint URL

Sandbox:
https://services-qa.walgreens.com/api/vaccine/scheduling/patient/v1
Production:
https://services.walgreens.com/api/vaccine/scheduling/patient/v1

Request Body

Example Request

curl --request POST \ 
--location 'https://services-qa.walgreens.com/api/vaccine/scheduling/patient/v1' \
--header 'Content-Type: application/json' \
--data '{
	"apiKey": "YOUR_API_KEY",
	"affId": "YOUR_AFFILIATE_ID",
	"engagementId": "USER_SESSION_ENGAGEMENT_ID",
	"partnerId": "YOUR_CLIENT_NAME",
	"firstName": "PATIENT_FIRST_NAME",
	"middleName": "PATIENT_MIDDLE_NAME",
	"lastName": "PATIENT_LAST_NAME",
	"dob": "PATIENT_DOB",
	"gender": "PATIENT_GENDER",
	"contact": {
		"phones": [{
			"type": "Mobile",
			"number": "PATIENT_PHONE_NUMBER",
			"smsConsent": "Agree"
		}],
		"emails": [{
			"type": "Email",
			"address": "PATIENT_EMAIL"
		}]
	}
}' \

Example Response

201 HTTP Status Code
							

						

Confirm Appointment API

This request enables users to confirm vaccination or immunization appointment based on engagementId. An appointment is not actually booked until a successful response is returned from this request.

Endpoint URL

Sandbox:
https://services-qa.walgreens.com/api/vaccine/scheduling/confirm/v1
Production:
https://services.walgreens.com/api/vaccine/scheduling/confirm/v1

Endpoint Information

HTTP Method: PATCH

Example Request

curl --request PATCH \
--location 'https://services-qa.walgreens.com/api/vaccine/scheduling/confirm/v1' \
--header 'Content-Type: application/json' \
--data '{
	"apiKey": "YOUR_API_KEY",
	"affId": "YOUR_AFFILIATE_ID",
	"engagementId": "USER_SESSION_ENGAGEMENT_ID"
}' \

Example Response

204 HTTP Status Code

Vaccination Immunization List:

Please find below the list of current vaccination or immunization codes and names.

Status Codes

Error Codes For Scheduling API:

Please see the various tables below mapping the various status codes and error codes across each endpoint.