> For the complete documentation index, see [llms.txt](https://docs.globalalerting.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.globalalerting.com/web-api/itineraries.md).

# Itineraries

## GET /V2/{tenantVarCode}/itineraries

> Returns itineraries for specified tenant

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Itineraries"}],"paths":{"/V2/{tenantVarCode}/itineraries":{"get":{"tags":["Itineraries"],"summary":"Returns itineraries for specified tenant","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Start date itinerary filter","schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"query","description":"End date itinerary filter","schema":{"type":"string","format":"date-time"}},{"name":"approvalState","in":"query","description":"When used it filters result by approval state: NoDecision=0, Approved=1, Declined=2","schema":{"type":"integer","format":"int32","default":-1}},{"name":"subtenants","in":"query","description":"When 'subtenants=true' the list contains itineraries for the tenant and all subtenants","schema":{"type":"boolean","default":false}},{"name":"byTravelerOnly","in":"query","description":"When 'byTravelerOnly=true' the list contains only itineraries for the current user","schema":{"type":"boolean","default":false}},{"name":"pnrNumber","in":"query","description":"When used it returns only itineraries with specified PNR number ignoring all other parameters.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}}}}}}}},"components":{"schemas":{"Itinerary":{"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the itinerary","format":"int32"},"Start":{"type":"string","description":"Itinerary start date","format":"date-time"},"End":{"type":"string","description":"Itinerary end date","format":"date-time"},"StartUserTimeZone":{"type":"string","description":"Itinerary start date converted to user time zone","format":"date-time"},"EndUserTimeZone":{"type":"string","description":"Itinerary end date converted to user time zone","format":"date-time"},"UserTimeZoneId":{"type":"string","description":"User time zone id","nullable":true},"Summary":{"type":"string","description":"Summary text","nullable":true},"ApprovalState":{"$ref":"#/components/schemas/ApprovalState"},"OverallRisk":{"type":"integer","description":"Calculated overall risk","format":"int32"},"ExternalId":{"type":"string","description":"External system Id","nullable":true},"ExternalStatus":{"type":"string","description":"External system status","nullable":true},"PnrNumber":{"type":"string","description":"PNR Number - Passenger name record of a reservation system","nullable":true},"Travelers":{"type":"array","items":{"$ref":"#/components/schemas/Traveler"},"description":"Travelers","nullable":true},"Hotels":{"type":"array","items":{"$ref":"#/components/schemas/Hotel"},"description":"Hotels","nullable":true},"Flights":{"type":"array","items":{"$ref":"#/components/schemas/Flight"},"description":"Flights","nullable":true},"Journeys":{"type":"array","items":{"$ref":"#/components/schemas/InsightsJourney"},"description":"Journeys","nullable":true},"Regions":{"type":"array","items":{"$ref":"#/components/schemas/ItineraryRegion"},"description":"GAP Insights intelligence regions","nullable":true},"Notes":{"type":"string","description":"Free-text notes","nullable":true}},"additionalProperties":false},"ApprovalState":{"enum":["NoDecision","Approved","Declined","Canceled"],"type":"string"},"Traveler":{"required":["EmailAddress","Firstname","Lastname","PhoneNumber"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the traveler","format":"int32"},"EmailAddress":{"minLength":1,"type":"string","description":"Email address"},"Firstname":{"minLength":1,"type":"string","description":"First name"},"Lastname":{"minLength":1,"type":"string","description":"Last name"},"DateOfBirth":{"type":"string","description":"Date of birth","format":"date-time","nullable":true},"PhoneNumber":{"minLength":1,"type":"string","description":"Phone number"},"Citizenship":{"type":"string","description":"Read only Gap user citizenship","nullable":true},"Address":{"type":"string","description":"Read only Gap user address","nullable":true},"CityStatePostalCode":{"type":"string","description":"Read only Gap user city, state, postal code","nullable":true},"Country":{"type":"string","description":"Read only Gap user country","nullable":true},"PhoneNumbersAll":{"type":"string","description":"Read only Gap user phone numbers","nullable":true},"EmergencyContact1":{"type":"string","description":"Read only Gap user first emergency contact","nullable":true},"EmergencyContact2":{"type":"string","description":"Read only Gap user second emergency contact","nullable":true}},"additionalProperties":false},"Hotel":{"required":["Address","Latitude","Longitude"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the hotel","format":"int32"},"Name":{"type":"string","description":"Hotel name","nullable":true},"Address":{"minLength":1,"type":"string","description":"Hotel address"},"Latitude":{"type":"number","description":"Latitude","format":"double"},"Longitude":{"type":"number","description":"Longitude","format":"double"},"CountryName":{"type":"string","description":"Country name","nullable":true},"CountryCode":{"type":"string","description":"Two letter country code","nullable":true},"TimeZoneId":{"type":"string","description":"Time zone id","nullable":true},"CheckInTimeLocal":{"type":"string","description":"Check-in local time (required if check-in time UTC not specified)","format":"date-time","nullable":true},"CheckInTime":{"type":"string","description":"Check-in time UTC (required if check-in local time not specified)","format":"date-time","nullable":true},"CheckOutTimeLocal":{"type":"string","description":"Check-out local time (required if check-out time UTC not specified)","format":"date-time","nullable":true},"CheckOutTime":{"type":"string","description":"Check-out time UTC (required if check-out local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"Flight":{"required":["Destination","FlightNumber","Origin"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the hotel","format":"int32"},"FlightNumber":{"minLength":1,"type":"string","description":"Flight number - tail number (e.g., N12345), or an ident (typically an ICAO airline with flight number, e.g., SWA2558)"},"Origin":{"minLength":1,"type":"string","description":"Origin airport"},"Destination":{"minLength":1,"type":"string","description":"Destination airport"},"OriginLatitude":{"type":"number","description":"Origin latitude","format":"double","nullable":true},"OriginLongitude":{"type":"number","description":"Origin longitude","format":"double","nullable":true},"OriginCountryName":{"type":"string","description":"Origin country name","nullable":true},"OriginCountryCode":{"type":"string","description":"Origin two letter country code","nullable":true},"DepartureTimeZoneId":{"type":"string","description":"Departure time zone id","nullable":true},"DepartureTimeLocal":{"type":"string","description":"Departure local time (required if departure time UTC not specified)","format":"date-time","nullable":true},"DepartureTime":{"type":"string","description":"Departure time UTC (required if departure local time not specified)","format":"date-time","nullable":true},"DestinationLatitude":{"type":"number","description":"Destination latitude","format":"double","nullable":true},"DestinationLongitude":{"type":"number","description":"Destination longitude","format":"double","nullable":true},"DestinationCountryName":{"type":"string","description":"Destination country name","nullable":true},"DestinationCountryCode":{"type":"string","description":"Destination two letter country code","nullable":true},"ArrivalTimeZoneId":{"type":"string","description":"Arrival time zone id","nullable":true},"ArrivalTimeLocal":{"type":"string","description":"Arrival local time (required if arrival time UTC not specified)","format":"date-time","nullable":true},"ArrivalTime":{"type":"string","description":"Arrival time UTC (required if arrival local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"InsightsJourney":{"required":["DestinationAddress","DestinationLatitude","DestinationLongitude","JourneyType","Name","OriginAddress","OriginLatitude","OriginLongitude"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the journey","format":"int32"},"JourneyType":{"$ref":"#/components/schemas/InsightsJourneyType"},"Name":{"minLength":1,"type":"string","description":"Name"},"Description":{"type":"string","description":"Description","nullable":true},"OriginAddress":{"minLength":1,"type":"string","description":"Origin address"},"OriginLatitude":{"type":"number","description":"Origin latitude","format":"double"},"OriginLongitude":{"type":"number","description":"Origin longitude","format":"double"},"OriginCountryName":{"type":"string","description":"Origin country name","nullable":true},"OriginCountryCode":{"type":"string","description":"Origin two letter country code","nullable":true},"DepartureTimeZoneId":{"type":"string","description":"Departure time zone id","nullable":true},"DepartureTimeLocal":{"type":"string","description":"Departure local time (required if departure time UTC not specified)","format":"date-time","nullable":true},"DepartureTime":{"type":"string","description":"Departure time UTC (required if departure local time not specified)","format":"date-time","nullable":true},"DestinationAddress":{"minLength":1,"type":"string","description":"Destination address"},"DestinationLatitude":{"type":"number","description":"Destination latitude","format":"double"},"DestinationLongitude":{"type":"number","description":"Destination longitude","format":"double"},"DestinationCountryName":{"type":"string","description":"Destination country name","nullable":true},"DestinationCountryCode":{"type":"string","description":"Destination two letter country code","nullable":true},"ArrivalTimeZoneId":{"type":"string","description":"Arrival time zone id","nullable":true},"ArrivalTimeLocal":{"type":"string","description":"Arrival local time (required if arrival time UTC not specified)","format":"date-time","nullable":true},"ArrivalTime":{"type":"string","description":"Arrival time UTC (required if arrival local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"InsightsJourneyType":{"enum":["Walk","Drive","Transit","Cycle","Ship"],"type":"string"},"ItineraryRegion":{"type":"object","properties":{"Name":{"type":"string","description":"Region name","nullable":true},"GeometryId":{"type":"string","description":"Insights intelligence region id","nullable":true}},"additionalProperties":false}}}}
```

## POST /V2/{tenantVarCode}/itineraries

> Creates a new itinerary

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Itineraries"}],"paths":{"/V2/{tenantVarCode}/itineraries":{"post":{"tags":["Itineraries"],"summary":"Creates a new itinerary","operationId":"PostItinerary","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Itinerary (empty object or object with PnrNumber)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItineraryCreate"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/ItineraryCreate"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/ItineraryCreate"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ItineraryCreate"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ItineraryCreate"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ItineraryCreate"}},"text/json":{"schema":{"$ref":"#/components/schemas/ItineraryCreate"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ItineraryCreate"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ItineraryCreate"}},"application/*+xml":{"schema":{"$ref":"#/components/schemas/ItineraryCreate"}}}},"responses":{"200":{"description":"OK"}}}}},"components":{"schemas":{"ItineraryCreate":{"type":"object","properties":{"PnrNumber":{"type":"string","description":"PNR Number - Passenger name record of a reservation system","nullable":true},"Notes":{"type":"string","description":"Free-text notes","nullable":true}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/itinerariesList

> Returns itineraries for specified tenant

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Itineraries"}],"paths":{"/V2/{tenantVarCode}/itinerariesList":{"get":{"tags":["Itineraries"],"summary":"Returns itineraries for specified tenant","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Start date itinerary filter","schema":{"type":"string","format":"date-time"}},{"name":"endDate","in":"query","description":"End date itinerary filter","schema":{"type":"string","format":"date-time"}},{"name":"approvalState","in":"query","description":"When used it filters result by approval state: NoDecision=0, Approved=1, Declined=2","schema":{"type":"integer","format":"int32","default":-1}},{"name":"page","in":"query","description":"Optional page number. Default = 1","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Optional page size. Default = 100","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"application/json;IEEE754Compatible=false":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"application/json;IEEE754Compatible=true":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"application/octet-stream":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"text/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}},"text/csv":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Itinerary"}}}}}}}}},"components":{"schemas":{"Itinerary":{"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the itinerary","format":"int32"},"Start":{"type":"string","description":"Itinerary start date","format":"date-time"},"End":{"type":"string","description":"Itinerary end date","format":"date-time"},"StartUserTimeZone":{"type":"string","description":"Itinerary start date converted to user time zone","format":"date-time"},"EndUserTimeZone":{"type":"string","description":"Itinerary end date converted to user time zone","format":"date-time"},"UserTimeZoneId":{"type":"string","description":"User time zone id","nullable":true},"Summary":{"type":"string","description":"Summary text","nullable":true},"ApprovalState":{"$ref":"#/components/schemas/ApprovalState"},"OverallRisk":{"type":"integer","description":"Calculated overall risk","format":"int32"},"ExternalId":{"type":"string","description":"External system Id","nullable":true},"ExternalStatus":{"type":"string","description":"External system status","nullable":true},"PnrNumber":{"type":"string","description":"PNR Number - Passenger name record of a reservation system","nullable":true},"Travelers":{"type":"array","items":{"$ref":"#/components/schemas/Traveler"},"description":"Travelers","nullable":true},"Hotels":{"type":"array","items":{"$ref":"#/components/schemas/Hotel"},"description":"Hotels","nullable":true},"Flights":{"type":"array","items":{"$ref":"#/components/schemas/Flight"},"description":"Flights","nullable":true},"Journeys":{"type":"array","items":{"$ref":"#/components/schemas/InsightsJourney"},"description":"Journeys","nullable":true},"Regions":{"type":"array","items":{"$ref":"#/components/schemas/ItineraryRegion"},"description":"GAP Insights intelligence regions","nullable":true},"Notes":{"type":"string","description":"Free-text notes","nullable":true}},"additionalProperties":false},"ApprovalState":{"enum":["NoDecision","Approved","Declined","Canceled"],"type":"string"},"Traveler":{"required":["EmailAddress","Firstname","Lastname","PhoneNumber"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the traveler","format":"int32"},"EmailAddress":{"minLength":1,"type":"string","description":"Email address"},"Firstname":{"minLength":1,"type":"string","description":"First name"},"Lastname":{"minLength":1,"type":"string","description":"Last name"},"DateOfBirth":{"type":"string","description":"Date of birth","format":"date-time","nullable":true},"PhoneNumber":{"minLength":1,"type":"string","description":"Phone number"},"Citizenship":{"type":"string","description":"Read only Gap user citizenship","nullable":true},"Address":{"type":"string","description":"Read only Gap user address","nullable":true},"CityStatePostalCode":{"type":"string","description":"Read only Gap user city, state, postal code","nullable":true},"Country":{"type":"string","description":"Read only Gap user country","nullable":true},"PhoneNumbersAll":{"type":"string","description":"Read only Gap user phone numbers","nullable":true},"EmergencyContact1":{"type":"string","description":"Read only Gap user first emergency contact","nullable":true},"EmergencyContact2":{"type":"string","description":"Read only Gap user second emergency contact","nullable":true}},"additionalProperties":false},"Hotel":{"required":["Address","Latitude","Longitude"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the hotel","format":"int32"},"Name":{"type":"string","description":"Hotel name","nullable":true},"Address":{"minLength":1,"type":"string","description":"Hotel address"},"Latitude":{"type":"number","description":"Latitude","format":"double"},"Longitude":{"type":"number","description":"Longitude","format":"double"},"CountryName":{"type":"string","description":"Country name","nullable":true},"CountryCode":{"type":"string","description":"Two letter country code","nullable":true},"TimeZoneId":{"type":"string","description":"Time zone id","nullable":true},"CheckInTimeLocal":{"type":"string","description":"Check-in local time (required if check-in time UTC not specified)","format":"date-time","nullable":true},"CheckInTime":{"type":"string","description":"Check-in time UTC (required if check-in local time not specified)","format":"date-time","nullable":true},"CheckOutTimeLocal":{"type":"string","description":"Check-out local time (required if check-out time UTC not specified)","format":"date-time","nullable":true},"CheckOutTime":{"type":"string","description":"Check-out time UTC (required if check-out local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"Flight":{"required":["Destination","FlightNumber","Origin"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the hotel","format":"int32"},"FlightNumber":{"minLength":1,"type":"string","description":"Flight number - tail number (e.g., N12345), or an ident (typically an ICAO airline with flight number, e.g., SWA2558)"},"Origin":{"minLength":1,"type":"string","description":"Origin airport"},"Destination":{"minLength":1,"type":"string","description":"Destination airport"},"OriginLatitude":{"type":"number","description":"Origin latitude","format":"double","nullable":true},"OriginLongitude":{"type":"number","description":"Origin longitude","format":"double","nullable":true},"OriginCountryName":{"type":"string","description":"Origin country name","nullable":true},"OriginCountryCode":{"type":"string","description":"Origin two letter country code","nullable":true},"DepartureTimeZoneId":{"type":"string","description":"Departure time zone id","nullable":true},"DepartureTimeLocal":{"type":"string","description":"Departure local time (required if departure time UTC not specified)","format":"date-time","nullable":true},"DepartureTime":{"type":"string","description":"Departure time UTC (required if departure local time not specified)","format":"date-time","nullable":true},"DestinationLatitude":{"type":"number","description":"Destination latitude","format":"double","nullable":true},"DestinationLongitude":{"type":"number","description":"Destination longitude","format":"double","nullable":true},"DestinationCountryName":{"type":"string","description":"Destination country name","nullable":true},"DestinationCountryCode":{"type":"string","description":"Destination two letter country code","nullable":true},"ArrivalTimeZoneId":{"type":"string","description":"Arrival time zone id","nullable":true},"ArrivalTimeLocal":{"type":"string","description":"Arrival local time (required if arrival time UTC not specified)","format":"date-time","nullable":true},"ArrivalTime":{"type":"string","description":"Arrival time UTC (required if arrival local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"InsightsJourney":{"required":["DestinationAddress","DestinationLatitude","DestinationLongitude","JourneyType","Name","OriginAddress","OriginLatitude","OriginLongitude"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the journey","format":"int32"},"JourneyType":{"$ref":"#/components/schemas/InsightsJourneyType"},"Name":{"minLength":1,"type":"string","description":"Name"},"Description":{"type":"string","description":"Description","nullable":true},"OriginAddress":{"minLength":1,"type":"string","description":"Origin address"},"OriginLatitude":{"type":"number","description":"Origin latitude","format":"double"},"OriginLongitude":{"type":"number","description":"Origin longitude","format":"double"},"OriginCountryName":{"type":"string","description":"Origin country name","nullable":true},"OriginCountryCode":{"type":"string","description":"Origin two letter country code","nullable":true},"DepartureTimeZoneId":{"type":"string","description":"Departure time zone id","nullable":true},"DepartureTimeLocal":{"type":"string","description":"Departure local time (required if departure time UTC not specified)","format":"date-time","nullable":true},"DepartureTime":{"type":"string","description":"Departure time UTC (required if departure local time not specified)","format":"date-time","nullable":true},"DestinationAddress":{"minLength":1,"type":"string","description":"Destination address"},"DestinationLatitude":{"type":"number","description":"Destination latitude","format":"double"},"DestinationLongitude":{"type":"number","description":"Destination longitude","format":"double"},"DestinationCountryName":{"type":"string","description":"Destination country name","nullable":true},"DestinationCountryCode":{"type":"string","description":"Destination two letter country code","nullable":true},"ArrivalTimeZoneId":{"type":"string","description":"Arrival time zone id","nullable":true},"ArrivalTimeLocal":{"type":"string","description":"Arrival local time (required if arrival time UTC not specified)","format":"date-time","nullable":true},"ArrivalTime":{"type":"string","description":"Arrival time UTC (required if arrival local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"InsightsJourneyType":{"enum":["Walk","Drive","Transit","Cycle","Ship"],"type":"string"},"ItineraryRegion":{"type":"object","properties":{"Name":{"type":"string","description":"Region name","nullable":true},"GeometryId":{"type":"string","description":"Insights intelligence region id","nullable":true}},"additionalProperties":false}}}}
```

## GET /V2/{tenantVarCode}/itineraries/{itineraryId}

> Returns a specific itinerary

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Itineraries"}],"paths":{"/V2/{tenantVarCode}/itineraries/{itineraryId}":{"get":{"tags":["Itineraries"],"summary":"Returns a specific itinerary","operationId":"GetItinerary","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"itineraryId","in":"path","description":"Itinerary Id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Itinerary"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Itinerary"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Itinerary"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Itinerary"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Itinerary"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Itinerary"}},"text/json":{"schema":{"$ref":"#/components/schemas/Itinerary"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Itinerary"}}}}}}}},"components":{"schemas":{"Itinerary":{"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the itinerary","format":"int32"},"Start":{"type":"string","description":"Itinerary start date","format":"date-time"},"End":{"type":"string","description":"Itinerary end date","format":"date-time"},"StartUserTimeZone":{"type":"string","description":"Itinerary start date converted to user time zone","format":"date-time"},"EndUserTimeZone":{"type":"string","description":"Itinerary end date converted to user time zone","format":"date-time"},"UserTimeZoneId":{"type":"string","description":"User time zone id","nullable":true},"Summary":{"type":"string","description":"Summary text","nullable":true},"ApprovalState":{"$ref":"#/components/schemas/ApprovalState"},"OverallRisk":{"type":"integer","description":"Calculated overall risk","format":"int32"},"ExternalId":{"type":"string","description":"External system Id","nullable":true},"ExternalStatus":{"type":"string","description":"External system status","nullable":true},"PnrNumber":{"type":"string","description":"PNR Number - Passenger name record of a reservation system","nullable":true},"Travelers":{"type":"array","items":{"$ref":"#/components/schemas/Traveler"},"description":"Travelers","nullable":true},"Hotels":{"type":"array","items":{"$ref":"#/components/schemas/Hotel"},"description":"Hotels","nullable":true},"Flights":{"type":"array","items":{"$ref":"#/components/schemas/Flight"},"description":"Flights","nullable":true},"Journeys":{"type":"array","items":{"$ref":"#/components/schemas/InsightsJourney"},"description":"Journeys","nullable":true},"Regions":{"type":"array","items":{"$ref":"#/components/schemas/ItineraryRegion"},"description":"GAP Insights intelligence regions","nullable":true},"Notes":{"type":"string","description":"Free-text notes","nullable":true}},"additionalProperties":false},"ApprovalState":{"enum":["NoDecision","Approved","Declined","Canceled"],"type":"string"},"Traveler":{"required":["EmailAddress","Firstname","Lastname","PhoneNumber"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the traveler","format":"int32"},"EmailAddress":{"minLength":1,"type":"string","description":"Email address"},"Firstname":{"minLength":1,"type":"string","description":"First name"},"Lastname":{"minLength":1,"type":"string","description":"Last name"},"DateOfBirth":{"type":"string","description":"Date of birth","format":"date-time","nullable":true},"PhoneNumber":{"minLength":1,"type":"string","description":"Phone number"},"Citizenship":{"type":"string","description":"Read only Gap user citizenship","nullable":true},"Address":{"type":"string","description":"Read only Gap user address","nullable":true},"CityStatePostalCode":{"type":"string","description":"Read only Gap user city, state, postal code","nullable":true},"Country":{"type":"string","description":"Read only Gap user country","nullable":true},"PhoneNumbersAll":{"type":"string","description":"Read only Gap user phone numbers","nullable":true},"EmergencyContact1":{"type":"string","description":"Read only Gap user first emergency contact","nullable":true},"EmergencyContact2":{"type":"string","description":"Read only Gap user second emergency contact","nullable":true}},"additionalProperties":false},"Hotel":{"required":["Address","Latitude","Longitude"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the hotel","format":"int32"},"Name":{"type":"string","description":"Hotel name","nullable":true},"Address":{"minLength":1,"type":"string","description":"Hotel address"},"Latitude":{"type":"number","description":"Latitude","format":"double"},"Longitude":{"type":"number","description":"Longitude","format":"double"},"CountryName":{"type":"string","description":"Country name","nullable":true},"CountryCode":{"type":"string","description":"Two letter country code","nullable":true},"TimeZoneId":{"type":"string","description":"Time zone id","nullable":true},"CheckInTimeLocal":{"type":"string","description":"Check-in local time (required if check-in time UTC not specified)","format":"date-time","nullable":true},"CheckInTime":{"type":"string","description":"Check-in time UTC (required if check-in local time not specified)","format":"date-time","nullable":true},"CheckOutTimeLocal":{"type":"string","description":"Check-out local time (required if check-out time UTC not specified)","format":"date-time","nullable":true},"CheckOutTime":{"type":"string","description":"Check-out time UTC (required if check-out local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"Flight":{"required":["Destination","FlightNumber","Origin"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the hotel","format":"int32"},"FlightNumber":{"minLength":1,"type":"string","description":"Flight number - tail number (e.g., N12345), or an ident (typically an ICAO airline with flight number, e.g., SWA2558)"},"Origin":{"minLength":1,"type":"string","description":"Origin airport"},"Destination":{"minLength":1,"type":"string","description":"Destination airport"},"OriginLatitude":{"type":"number","description":"Origin latitude","format":"double","nullable":true},"OriginLongitude":{"type":"number","description":"Origin longitude","format":"double","nullable":true},"OriginCountryName":{"type":"string","description":"Origin country name","nullable":true},"OriginCountryCode":{"type":"string","description":"Origin two letter country code","nullable":true},"DepartureTimeZoneId":{"type":"string","description":"Departure time zone id","nullable":true},"DepartureTimeLocal":{"type":"string","description":"Departure local time (required if departure time UTC not specified)","format":"date-time","nullable":true},"DepartureTime":{"type":"string","description":"Departure time UTC (required if departure local time not specified)","format":"date-time","nullable":true},"DestinationLatitude":{"type":"number","description":"Destination latitude","format":"double","nullable":true},"DestinationLongitude":{"type":"number","description":"Destination longitude","format":"double","nullable":true},"DestinationCountryName":{"type":"string","description":"Destination country name","nullable":true},"DestinationCountryCode":{"type":"string","description":"Destination two letter country code","nullable":true},"ArrivalTimeZoneId":{"type":"string","description":"Arrival time zone id","nullable":true},"ArrivalTimeLocal":{"type":"string","description":"Arrival local time (required if arrival time UTC not specified)","format":"date-time","nullable":true},"ArrivalTime":{"type":"string","description":"Arrival time UTC (required if arrival local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"InsightsJourney":{"required":["DestinationAddress","DestinationLatitude","DestinationLongitude","JourneyType","Name","OriginAddress","OriginLatitude","OriginLongitude"],"type":"object","properties":{"Id":{"type":"integer","description":"A unique identifier of the journey","format":"int32"},"JourneyType":{"$ref":"#/components/schemas/InsightsJourneyType"},"Name":{"minLength":1,"type":"string","description":"Name"},"Description":{"type":"string","description":"Description","nullable":true},"OriginAddress":{"minLength":1,"type":"string","description":"Origin address"},"OriginLatitude":{"type":"number","description":"Origin latitude","format":"double"},"OriginLongitude":{"type":"number","description":"Origin longitude","format":"double"},"OriginCountryName":{"type":"string","description":"Origin country name","nullable":true},"OriginCountryCode":{"type":"string","description":"Origin two letter country code","nullable":true},"DepartureTimeZoneId":{"type":"string","description":"Departure time zone id","nullable":true},"DepartureTimeLocal":{"type":"string","description":"Departure local time (required if departure time UTC not specified)","format":"date-time","nullable":true},"DepartureTime":{"type":"string","description":"Departure time UTC (required if departure local time not specified)","format":"date-time","nullable":true},"DestinationAddress":{"minLength":1,"type":"string","description":"Destination address"},"DestinationLatitude":{"type":"number","description":"Destination latitude","format":"double"},"DestinationLongitude":{"type":"number","description":"Destination longitude","format":"double"},"DestinationCountryName":{"type":"string","description":"Destination country name","nullable":true},"DestinationCountryCode":{"type":"string","description":"Destination two letter country code","nullable":true},"ArrivalTimeZoneId":{"type":"string","description":"Arrival time zone id","nullable":true},"ArrivalTimeLocal":{"type":"string","description":"Arrival local time (required if arrival time UTC not specified)","format":"date-time","nullable":true},"ArrivalTime":{"type":"string","description":"Arrival time UTC (required if arrival local time not specified)","format":"date-time","nullable":true}},"additionalProperties":false},"InsightsJourneyType":{"enum":["Walk","Drive","Transit","Cycle","Ship"],"type":"string"},"ItineraryRegion":{"type":"object","properties":{"Name":{"type":"string","description":"Region name","nullable":true},"GeometryId":{"type":"string","description":"Insights intelligence region id","nullable":true}},"additionalProperties":false}}}}
```

## PUT /V2/{tenantVarCode}/itineraries/{itineraryId}

> Updates an existing itinerary

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Itineraries"}],"paths":{"/V2/{tenantVarCode}/itineraries/{itineraryId}":{"put":{"tags":["Itineraries"],"summary":"Updates an existing itinerary","operationId":"PutItinerary","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"itineraryId","in":"path","description":"Itinerary Id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Itinerary object (only Approval state or PnrNumber can be updated)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItineraryUpdate"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/ItineraryUpdate"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/ItineraryUpdate"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ItineraryUpdate"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ItineraryUpdate"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ItineraryUpdate"}},"text/json":{"schema":{"$ref":"#/components/schemas/ItineraryUpdate"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ItineraryUpdate"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ItineraryUpdate"}},"application/*+xml":{"schema":{"$ref":"#/components/schemas/ItineraryUpdate"}}}},"responses":{"200":{"description":"OK"}}}}},"components":{"schemas":{"ItineraryUpdate":{"type":"object","properties":{"ApprovalState":{"$ref":"#/components/schemas/ApprovalState"},"PnrNumber":{"type":"string","description":"PNR Number - Passenger name record of a reservation system","nullable":true},"Notes":{"type":"string","description":"Free-text notes","nullable":true}},"additionalProperties":false},"ApprovalState":{"enum":["NoDecision","Approved","Declined","Canceled"],"type":"string"}}}}
```

## DELETE /V2/{tenantVarCode}/itineraries/{itineraryId}

> Deletes a specific itinerary

```json
{"openapi":"3.0.4","info":{"title":"GAP REST API Documentation V2","version":"v2"},"tags":[{"name":"Itineraries"}],"paths":{"/V2/{tenantVarCode}/itineraries/{itineraryId}":{"delete":{"tags":["Itineraries"],"summary":"Deletes a specific itinerary","parameters":[{"name":"tenantVarCode","in":"path","description":"Tenant Var Code","required":true,"schema":{"type":"string"}},{"name":"itineraryId","in":"path","description":"Itinerary Id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK"}}}}}}
```