Activity Listings API

Guidance and examples for accessing the Activity Listings API

Use the Activity Listings API to search Expedia activity inventory by date window, location, and other parameters to return a listing of available activities.

Endpoint

MethodEndpoint
GEThttps://apim.expedia.com/activities/listings

Required Headers

Key:Expedia API key
Authorization:Expedia API Authorization String
Accept:application/vnd.exp-activity.v3+json
Partner-Transaction-Id:Partner TransactionID String

Next Steps

  • Get more information for a specific activity via the Activity Details API.
  • Deeplink customer to Expedia website to book selected Activity.

Example of Request

https://apim.expedia.com/activities/listings?location=shenzhen&startDate=2021-06-01&endDate=2021-06-07

Activity Success Response

{
	"TransactionId": "f06edfa3-27f4-44e6-838c-b8dd3d0a3210",
	"Count": 1,
	"Location": "shenzhen, gd",
	"StartDate": "2021-08-01",
	"EndDate": "2021-08-08",
	"Categories": [{
		"Count": 1,
		"CategoryName": "Cruises & Water Tours",
		"CategoryDisplayName": "Cruises & Water Tours",
		"GroupName": "Tours",
		"GroupDisplayName": "Tours"
	}],
	"Activities": [{
		"Id": 166597,
		"Title": "Faster Than Skip-the-Line: Vatican, Sistine Chapel & St. Peter's Tour",
		"Description": "Enjoy 5 of Seattle's most popular attractions with a multi-ticket booklet that\u2019s valid for 9 consecutive days. This pass is perfect if you want to explore the city on your schedule, craft your own itinerary, and visit the city\u2019s can\u2019t-miss museums and most iconi..",
		"Media": [{
			"Type": "1",
			"Size": "t",
			"Url": "http://a.travel-assets.com/ lxweb/ media-vault/ 166597_m.jpeg? v=104741"
		}],
		"Categories": ["Walking & Bike Tours"],
		"Duration": "PT3H0M",
		"CancellationPolicy": {
			"FreeCancellation": true
		},
		"Price": {
			"Category": "Adult",
			"TotalRate": {
				"Value": 100,
				"Currency": "USD"
			}
		},
		"ReferencePrice": {
			"Category": "Adult",
			"TotalRate": {
				"Value": 110,
				"Currency": "USD"
			}
		},
		"Savings": {
			"percentage": 42,
			"amount": {
				"Value": "9",
				"Currency": "USD"
			}
		},
		"Redemption": {
			"Type": "Voucherless",
			"Locations": [{
				"Address": {
					"Address1": "99 Union St",
					"City": "Seattle",
					"PostalCode": "431625",
					"Province": "WA",
					"Country": "USA"
				},
				"GeoLocation": {
					"Latitude": "47.60772",
					"Longitude": "-122.33936"
				}
			}]
		},
		"Locations": [{
			"Address": {
				"Address1": "99 Union St",
				"City": "Seattle",
				"PostalCode": "431625",
				"Province": "WA",
				"Country": "USA"
			},
			"GeoLocation": {
				"Latitude": "47.60772",
				"Longitude": "-122.33936"
			}
		}],
		"Supplier": {
			"Name": "City Wonders"
		},
		"RecommendationScore": 90,
		"ReviewCount": 100,
		"Links": {
			"WebDetails": {
				"Href": "https://www.expedia.com/things-to-do/space-needle-observation-deck-admission.a193678.activity-details?srp=true&location=sea"
			},
			"ApiDetails": {
				"Accept": "application/vnd.exp-activity.v3+json",
				"Method": "GET",
				"Href": "https://apim.expedia.com/activities/details/CgUyMDIzMBIyCgkyMDEzMDQ1OTYSCTIwOTc3MjcwOBoCMjQqCjIwMTctMTEtMTkyCjIwMTctMTEtMjUqAwoBMg"
			}
		}
	}]
}

Activity Success Response with Warnings

{
	"Warnings": [{
		"Code": "INVALID_SEARCH_DATE",
		"Description": "The requested start date or end date was in the past.."
	}],
	"TransactionId": "f06edfa3-27f4-44e6-838c-b8dd3d0a3210",
	"Count": 1,
	"Location": "shenzhen, gd",
	"StartDate": "2021-08-01",
	"EndDate": "2021-08-08",
	"Categories": [{
		"Count": 1,
		"CategoryName": "Cruises & Water Tours",
		"CategoryDisplayName": "Cruises & Water Tours",
		"GroupName": "Tours",
		"GroupDisplayName": "Tours"
	}],
	"Activities": [{
		"Id": 166597,
		"Title": "Faster Than Skip-the-Line: Vatican, Sistine Chapel & St. Peter's Tour",
		"Description": "Enjoy 5 of Seattle's most popular attractions with a multi-ticket booklet that’s valid for 9 consecutive days. This pass is perfect if you want to explore the city on your schedule, craft your own itinerary, and visit the city’s can’t-miss museums and most iconi..",
		"Media": [{
			"Type": 1,
			"Size": "t",
			"Url": "http://a.travel-assets.com/ lxweb/ media-vault/ 166597_m.jpeg? v=104741"
		}],
		"Categories": [
			"Walking & Bike Tours"
		],
		"Duration": "PT3H0M",
		"CancellationPolicy": {
			"FreeCancellation": true
		},
		"Price": {
			"Category": "Adult",
			"TotalRate": {
				"Value": 100,
				"Currency": "USD"
			}
		},
		"ReferencePrice": {
			"Category": "Adult",
			"TotalRate": {
				"Value": 110,
				"Currency": "USD"
			}
		},
		"Savings": {
			"percentage": 42,
			"amount": {
				"Value": "9",
				"Currency": "USD"
			}
		},
		"Redemption": {
			"Type": "Voucherless",
			"Locations": [{
				"Address": {
					"Address1": "99 Union St",
					"City": "Seattle",
					"PostalCode": "431625",
					"Province": "WA",
					"Country": "USA"
				},
				"GeoLocation": {
					"Latitude": "47.60772",
					"Longitude": "-122.33936"
				}
			}]
		},
		"Locations": [{
			"Address": {
				"Address1": "99 Union St",
				"City": "Seattle",
				"PostalCode": "431625",
				"Province": "WA",
				"Country": "USA"
			},
			"GeoLocation": {
				"Latitude": "47.60772",
				"Longitude": "-122.33936"
			}
		}],
		"Supplier": {
			"Name": "City Wonders"
		},
		"RecommendationScore": 90,
		"ReviewCount": 100,
		"Links": {
			"WebDetails": {
				"Href": "https://www.expedia.com/things-to-do/space-needle-observation-deck-admission.a193678.activity-details?srp=true&location=sea"
			},
			"ApiDetails": {
				"Accept": "application/vnd.exp-activity.v3+json",
				"Method": "GET",
				"Href": "https://apim.expedia.com/activities/details/CgUyMDIzMBIyCgkyMDEzMDQ1OTYSCTIwOTc3MjcwOBoCMjQqCjIwMTctMTEtMTkyCjIwMTctMTEtMjUqAwoBMg"
			}
		}
	}]
}

Activity Disambiguation Response

{
	"Errors": [{
		"Code": "AMBIGUOUS_LOCATION",
		"Description": "Multiple search locations found.",
		"LocationKeyword": "99UnionSt",
		"LocationOptions": [{
				"ShortName": "Union Grove, Wisconsin, United States of America",
				"Address": "Milwaukee (and vicinity), Wisconsin, United States of America"
			},
			{
				"ShortName": "La Union, El Salvador",
				"Address": "San Salvador (and vicinity), El Salvador"
			},
			{
				"ShortName": "La Union, Anthony, New Mexico, United States of America",
				"Address": "El Paso (and vicinity), Texas, United States of America"
			}
		]
	}],
	"TransactionId": "cecf62c8-c103-4181-b09d-53c7190d1c48"
}

Error Codes

Common Error Codes

HTTP Status CodeError CodeError Message
500APPLICATION_ERRORApplication error.
409AMBIGUOUS_LOCATIONMultiple search locations found.
400BAD_REQUESTRequest method [value] not supported.
400INVALID_ACCEPT_HEADERAPI version is either missing or invalid. Please provide a correct API version in the Accept header.
400INVALID_PARTNER_TRANSACTION_IDPartner Transaction Id in http headers is missing.
400INVALID_CLIENT_KEYInvalid client key: [ client key value ].
400LOCATION_MISSINGParameter[value]or [value]is missing.
400INVALID_GEO_LOCATIONGeoLocation is invalid.
400CONFLICTING_PARAMETERSYou can only select one of below parameters to search :.
400INVALID_START_DATEStart date is invalid.
400INVALID_END_DATEEnd date is invalid.
400ENDDATE_EARLIER_THAN_STARTDATEEnd date should not be earlier than start date.
400INVALID_LINKSParameter 'links' contains invalid value : [links value]. Please pass supported values.
400INVALID_LOCALEInvalid locale : [locale value]. Please pass supported values.
400START_DATE_MISSINGStart date is missing.
200NO_RESULT_FOUNDSorry, your query completed successfully, but did not return any inventory. Please adjust your search parameters and try again.
200INVALID_SEARCH_DATEThe requested start date or end date was in the past.

API details

Here, you can explore the endpoint definitions for this API, then go to the API Explorer to try out all the XAP endpoints, download OpenAPI specs, or download our Postman collections. Testing with one or all of these options will give you an understanding of how the examples and schema definitions compare to the actual output.


Did you find this page helpful?
How can we improve this content?
Thank you for helping us improve!