Guest Information

Include information about the primary guest staying in the room and optionally for additional guests.

Parameter	Description	Type	Required
*Guests/Citizenships*	Contains Citizenship information of the guest.	Object	No
Guests/Citizenships/@CountryCode	The ISO 1366-1 country code.	String	No
Guests/Citizenships/@Primary	If true, indicates the CountryName associated with citizenship is primary.	Boolean	No
Guests/@Comments	Specifies comments for the guest. Visible in the SynXis Voice Agent application.	String	No
*Guests/ContactNumbers*	Contains contact information of the guest.	Object	No
Guests/ContactNumbers/@Code	Code associated to a contact number.	String	No
Guests/ContactNumbers/@Default	If true, indicates the default contact number for the guest.	Boolean	No
Guests/ContactNumbers/@Number	A contact number through which a guest can be reached.	String	No
Guests/ContactNumbers/@Role	Specifies the role of a contact number. *Values*: Unknown, Home, or Office	String	No
Guests/ContactNumbers/@SortOrder	Sort order of the contact numbers.	Integer	No
Guests/ContactNumbers/@Type	Specifies the type of a contact number. *Values*: Unknown, Voice, Fax, Mobile, Voice1, or Voice2	String	No
Guests/ContactNumbers/@Use	Specifies the time of day to use for the contact number. *Values*: Unknown, DayTimeContact, EveningContact, or AnytimeContact	String	No
Guests/@DateOfBirth	Guest date of birth.	String ($date)	No
Guests/@DenyChargeToRoom	If true, indicates a guest wants to deny posting charges to the room. Guest cannot have a payment method associated and cannot be a share-with reservation.	Boolean	No
*Guests/EmailAddress*	Contains email address information of the guest.	Object	No
Guests/EmailAddress@Default	If true, indicates the default email address of the guest.	Boolean	No
Guests/EmailAddress@Type	Type of email address. *Values*: Primary or Mobile	String	No
Guests/EmailAddress@Value	Email address of the guest.	String	No
Guests/@Gender	Specifies the gender of a guest. *Values*: Male, Female or Unspecified	String	No
*Guests/Locations*	Contains location information of the guest.	Object	No
Guests/Locations/Address/@AddressLine	Street-related information associated with an address.	[String]	No
Guests/Locations/Address/@City	City associated with an address.	String	No
Guests/Locations/Address/@Default	If true, indicates the default address for the guest.	Boolean	No
Guests/Locations/Address/@PostalCode	Postal code associated with an address.	String	No
Guests/Locations/Address/@Type	Specifies the type of address. *Values*: Home, Billing, BillingTax, Business, Chain, Collection, Contact, CreditCard, Delivery, Deposit, Hotel, Mailing, OtherUse, Permanent, Physical, PreOpeningOffice	String	No
Guests/Locations/Address/Business/@Name	Name of a business associated with an address.	String	No
Guests/Locations/Address/Business/@Unit	Business unit associated with an address.	String	No
Guests/Locations/Address/Country/@Code	The ISO 1366-1 country code associated with an address.	String	No
Guests/Locations/Address/Country/@Value	Name of the country.	String	No
Guests/Locations/Address/StateProv/@Code	Code of a state or province associated with an address.	String	No
Guests/Locations/Address/StateProv/@Value	Name of the state or province.	String	No
Guests/Locations/@Name	Name of the location (i.e. Home, Business).	String	No
Guests/@MarketingOptIn	If true, indicates that a guest has agreed to receive promotional messages.	Boolean	No
*Guests/PersonName*	Contains Name information of the guest.	Object	No
Guests/PersonName@GivenName	Specifies the Given/First name of a guest.	String	No
Guests/PersonName@MiddleName	Specifies a middle initial of a guest (maximum of 2 characters).	String	No
Guests/PersonName@PreferredGivenName	Specifies the preferred Given/First name of a guest.	String	No
Guests/PersonName@PreferredSurname	Specifies the preferred Surname/Lastname of the guest.	String	No
Guests/PersonName@Prefix	Specifies a prefix associated with the name of a guest.	String	No
Guests/PersonName@Suffix	Specifies a suffix associated with the name of a guest.	String	No
Guests/PersonName@SurName	Specifies the Surname/Lastname of the guest.	String	No
Guests@Role	Role of the Guest *Values*: Primary or Additional	String	No
*Guests/SpokenLanguages*	Contains information about the languages spoken by the guest.	Object	No
Guests/SpokenLanguages/@Code	Language code spoken by the guest. Visible in the SynXis Voice Agent application.	String	No
Guests/SpokenLanguages/@Default	If true, indicates the language associated with the code is the default language for the guest.	Boolean	No
Guests/@StartDate	Defines check in date for a guest.	String (date)	No
Guests/@EndDate	Defines check out date for a guest.	String (date)	No
*Guests/TravelDocuments*	Contains travel documentation information of the guest.	Object	No
Guests/TravelDocuments/@HolderName	Name of the travel document owner.	String	No
Guests/TravelDocuments/@IssuingAuthority	The office which issued a travel document.	String	No
Guests/TravelDocuments/@Number	The number associated with a travel document. *Values*: Not visible in SynXis CR but is available for delivery to 3rd party or PMS.	String	No
Guests/TravelDocuments/@PlaceOfIssue	The place where a travel document was issued.	String	No
Guests/TravelDocuments/@Type	Type of a travel document used by a guest to confirm their identity. *Values*: AlienRegistrationNumber, CpfTaxNumber, DriversLicense, InsurancePolicyNumber, MilitaryIdentification, NationalIdentityDocument, Passport, TaxExemptionNumber, VaccinationCertificate, VehicleRegistrationorLicenseNumber, or Visa	String	No

Refer to the Payment Methods topic for details on Guest Payments.

Sample Request (Partial)

{
"Guests": [{
"Citizenships": [{
"CountryCode": "US",
"Primary": true
}],
"Comments": "This is a guest comment.",
"ContactNumbers": [{
"Code": "719",
"Default": true,
"Number": "555-2717",
"Role": "Home",
"SortOrder": 1,
"Type": "Voice",
"Use": "DayTimeContact"
}],
"DateOfBirth": "1985-05-18",
"EmailAddress": [{
"Type": "Primary",
"Value": "jonh.public@email.com",
"Default": true
},
{
"Type": "Mobile",
"Value": "john.public@email2.com",
"Default": false
}
],
"Gender": "Male",
"Locations": [{
"Address": {
"AddressLine": [
"123 Main St",
"Appt. 201"
],
"City": "Denver",
"Country": {
"Code": "US"
},
"Default": true,
"PostalCode": "80203",
"StateProv": {
"Code": "CO"
},
"Type": "Home"
},
"Name": "Home Address"
}],
"MarketingOptIn": true,
"Payments": [{
"Amount": "50",
"PaymentCard": {
"CardCode": "VI",
"CardHolder": "John Public",
"CardNumber": "444444444444444",
"CardSecurityCode": "123",
"ExpireDate": "1225"
},
"Type": "CreditCard"
}],
"PersonName": {
"GivenName": "John",
"MiddleName": "A",
"Prefix": "Mr.",
"Suffix": "Jr.",
"Surname": "Public",
"PreferredGivenName": "James",
"PreferredSurname": "Smith"
},
"Role": "Primary",
"SpokenLanguages": [{
"Code": "en",
"Default": true
}],
"TravelDocuments": [{
"Type": "MilitaryIdentification",
"HolderName": "John Public",
"Number": "2999-9285820-874",
"IssuingAuthority": "DOJ",
"PlaceOfIssue": "Houston, TX"
}]
}]
}

Sample Request (Complete)

{
"Chain": {
"Id": 14161022
},
"Channels": {
"PrimaryChannel": {
"Code": "WEB"
},
"SecondaryChannel": {
"Code": "SYNXISWS_BE"
}
},
"Hotel": {
"Id": 100319
},
"Guests": [
{
"Citizenships": [
{
"CountryCode": "US",
"Primary": true
}
],
"Comments": "This is a guest comment.",
"ContactNumbers": [
{
"Code": "719",
"Default": true,
"Number": "555-2717",
"Role": "Home",
"SortOrder": 1,
"Type": "Voice",
"Use": "DayTimeContact"
}
],
"DateOfBirth": "1985-05-18",
"EmailAddress": [
{
"Type": "Primary",
"Value": "jonh.public@email.com",
"Default": true
},
{
"Type": "Mobile",
"Value": "john.public@email2.com",
"Default": false
}
],
"Gender": "Male",
"Locations": [
{
"Address": {
"AddressLine": [
"123 Main St",
"Appt. 201"
],
"City": "Denver",
"Country": {
"Code": "US"
},
"Default": true,
"PostalCode": "80203",
"StateProv": {
"Code": "CO"
},
"Type": "Home"
},
"Name": "Home Address"
}
],
"MarketingOptIn": true,
"Payments": [
{
"Amount": "50",
"PaymentCard": {
"CardCode": "VI",
"CardHolder": "John Public",
"CardNumber": "444444444444444",
"CardSecurityCode": "123",
"ExpireDate": "1225"
},
"Type": "CreditCard"
}
],
"PersonName": {
"GivenName": "John",
"MiddleName": "A",
"Prefix": "Mr.",
"Suffix": "Jr.",
"Surname": "Public",
"PreferredGivenName": "James",
"PreferredSurname": "Smith"
},
"Role": "Primary",
"SpokenLanguages": [
{
"Code": "en",
"Default": true
}
],
"TravelDocuments": [
{
"Type": "MilitaryIdentification",
"HolderName": "John Public",
"Number": "2999-9285820-874",
"IssuingAuthority": "DOJ",
"PlaceOfIssue": "Houston, TX"
}
]
}
],
"RoomStay": {
"StartDate": "2023-06-07",
"EndDate": "2023-06-08",
"GuestCount": [
{
"AgeQualifyingCode": "Adult",
"NumGuests": 1
}
],
"NumRooms": 1,
"Products": [
{
"Product": {
"RateCode": "BAR",
"RoomCode": "LUXQ"
}
}
]
},
"status": "Confirmed"
}