ABCDEFGHIJKLMNOPQRSTUVWXYZ
1
Data Model (view only)DatatypeFormatRequiredExampleDescription
2
affiliateContextObjectContext object which will be persisted along with an application and will be returned unmodified. This allows to store reference numbers or other context information from a partner system to Sherpa. PPI will be ignored and not persisted.
3
affiliateIdstringID provided by SherpaYes
4
currencystringalpha3Preferred Currency
5
languageenumalpha2YesenPreferred Language, defaults to en
6
defaultNationalityCountrystringalpha2Default Nationality
7
8
itinerary[0].originCountrystringalpha2
9
itinerary[0].originAirportCodestringIATA Airport CodeMUC for Munich Airport, GermanyoriginCountry will be set based on originAirportCode. If originCountry set, but contradicts originAirportCode, both will be ignored.
10
itinerary[0].destinationCountrystringalpha22 letter destination country code
11
itinerary[0].destinationAirportCodestringIATA Airport CodeJFK for John F. Kennedy Airport, USAdestinationCountry will be set based on destinationAirportCode. if destinationCountry set, but contradicts destinationAirportCode, both will be ingored.
12
itinerary[0].arrivalDatestringYYYY-MM-DD2019-06-25Arrival Date to this country
13
itinerary[0].arrivalTimestringHH:MM12:05Time of flight arrival
14
itinerary[0].arrivalTimezonestringTimezone Date NameAmerica/Aruba
Timezone https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
15
itinerary[0].departureDatestringYYYY-MM-DDIf not set, defaults to Today
16
itinerary[0].departureTimestringHH:MM12:05Time of flight departure
17
itinerary[0].departureTimezonestringTimezone Date NameAmerica/Aruba
Timezone https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
18
itinerary[0].flightNumberstringAB123
Final flight number that arrives at destination
19
itinerary[0].carrierCodeIatastringAC2 Letter IATA Code
20
travellers[0].countryOfBirthstringalpha3Country Of Birth
21
travellers[0].dateOfBirthstringYYYY-MM-DD43830
Date Of Birth as appears on the Travel Document
22
travellers[0].displayNamestringThis name will be used in the User Interface. Best practise is to use either first name if known or use "Traveller 1"
23
travellers[0].emailstringContact Email
24
travellers[0].givenNamesstring
Given Names as they appear on the Travel Document
25
travellers[0].surnamestring
Surname as it appears on the Travel Document
26
travellers[0].sexstringMALE | FEMALESex, as it appears on the passport
27
travellers[0].passportExpiryDatestringYYYY-MM-DDPassport Expiry Date
28
travellers[0].passportIssueDatestringYYYY-MM-DDPassport Issue Date
29
travellers[0].passportIssuingAuthoritystringDepartment of Foreign Affairs (DFA)Passport Issuing Authority
30
travellers[0].passportNumberstringPassport Number
31
travellers[0].passportIssuingCountrystringalpha3GERPassport Country of Issue
32
travellers[0].nationalIdNumberstring
33
travellers[0].phoneCountryCodestringalpha2AUAlpha2 code for name of country
34
travellers[0].phoneNumberstringPhone Number
35
travellers[0].phoneTypestringenumWork, Mobile, HomePhone Type
36
travellers[0].placeOfBirthstringPlace Of Birth
37
travellers[0].residence.citystringResidential Address City
38
travellers[0].residence.countrystringalpha3Residential Address Country
39
travellers[0].residence.postalCodestringResidential Address Postal Code or Zip
40
travellers[0].residence.statestringResidential Address State
41
travellers[0].residence.streetstring
Residential Address Street Address Line 1
42
travellers[0].residence.streetLine2string
Residential Address Street Address Line 2
43
travellers[0].residence.streetNumberstringResidential Address Street Number
44
travellers[0].residence.unitstringResidential Address Unit
45
46
accommodation.citystring
47
accommodation.countrystring
48
accommodation.fullAddressstring
49
accommodation.namestring
50
accommodation.postalCodestring
51
accommodation.statestring
52
accommodation.streetstring
53
accommodation.streetLine2string
54
accommodation.streetNumberstring
55
accommodation.typestring
56
accommodation.unitstring
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100