TripSearch returns data for trips and reservations.

User needs at least select permission for trips. Results may be filtered if trip permission includes OnlySelf (based on user’s linked advisors) or if trip permission includes OnlyBranch (based on user’s branch).

See: Trip

Permission Areas: Trip

Column Type Size Table Description
recNo long   trip  
tagRecNo long   trip  
tagName string 64 trip  
tagValue string 1024 trip  
tags string   trip  
summaryCount int   trip  
createDateTime DateTimeOffset   trip  
lastModifiedDateTime DateTimeOffset   trip  
name string 256 trip  
startDateTime DateTime   trip  
startDateTargetTravelDate DateTime   trip  
endDateTime DateTime   trip  
targetTravelDate Date   trip  
clientProfileRecNo long   trip  
clientProfileName string 256 trip  
clientProfileInfoName string 256 trip  
advisorProfileRecNo long   trip  
advisorProfileName string 256 trip  
advisorProfileId string 32 trip  
remarks string 256 trip TripSearch.Remarks column deprecated
advisorRemarks string 256 trip TripSearch.AdvisorRemarks column deprecated
cancelled bool   trip  
destinations string   trip  
destinationRecNo long   trip  
destinationName string 64 trip  
destinationRegionRecNo long   trip  
destinationRegionName string 64 trip  
branchRecNo long   trip  
branchName string 64 trip  
tripRecordLocator string 32 trip  
visibility short   trip  
tripTotalFare long   trip  
tripCommissionAmount long   trip  
tripClientBalance long   trip  
reservationRecNo long   reservation  
reservationTagRecNo long   reservation  
reservationTagName string 64 reservation  
reservationTagValue string 1024 reservation  
reservationTags string   reservation  
reservationSupplierProfileRecNo long   reservation  
reservationSupplierProfileName string 256 reservation  
reservationSupplierProfileInfoName string 256 reservation  
reservationCommisionTriggerIndex short   reservation BookingDate = 1, DepartDate = 2, ReturnDate = 3, FinalPayDate = 4
reservationCommisionTriggerDaysOffset short   reservation  
reservationClientBalance long   reservation  
reservationSupplierBalance long   reservation  
reservationTrackClientPayments bool   reservation  
reservationStatus short   reservation Pending = 1, Confirmed = 2, Cancelled = 3, Voided = 4
reservationTravelCategoryRecNo short   reservation Air = 1, Hotel = 2, Car = 3, Cruise = 4, Tour = 5, Rail = 6, Transfer = 7, Insurance = 8, ServiceFee = 9, Excursion = 10, ClientVoucher = 11, GiftCertificate = 12, SupplierVoucher = 13, Misc = 99
reservationTravelCategoryName string 32 reservation  
reservationTravelSubCategoryRecNo long   reservation  
reservationTravelSubCategoryName string 64 reservation  
reservationTotalFare long   reservation  
reservationCommissionAmount long   reservation  
reservationCommissionRate short   reservation Percentage values have an implied 2 digits after the decimal point. A value of 25% is represented as 2500
reservationBaseFare long   reservation  
reservationTaxAmount long   reservation  
reservationHighFare long   reservation  
reservationLowFare long   reservation  
reservationBookDateTime DateTime   reservation  
reservationStartDateTime DateTime   reservation  
reservationEndDateTime DateTime   reservation  
reservationConfirmationNo string 64 reservation  
reservationGroupBookingNumber string 16 CruiseR  
reservationRecordLocator string 32 reservation  
reservationDepositRecNo long   reservationDeposit  
reservationDepositDueDate Date   reservationDeposit Since reservations can now have multiple deposits, column will reflect earliest deposit that meets specified criteria
reservationDepositDueAmount long   reservationDeposit Since reservations can now have multiple deposits, column will reflect earliest deposit that meets specified criteria
reservationDepositCompleted DateTimeOffset   reservationDeposit  
reservationFinalPayDueDate Date   reservation  
reservationARCBSPNumber int   reservation  
reservationProviderProfileRecNo long   reservation  
reservationProviderProfileName string 256 reservation  
reservationProviderProfileInfoName string 256 reservation  
reservationTicketNo long   reservation  
reservationEndingTicketNo long   airReservation  
reservationConfirmationNumber string 64 reservation TripSearch.ReservationConfirmationNumber column deprecated; use TripSearch.ReservationConfirmationNo instead
reservationConfirmationTicketNo string 64 reservation  
reservationConfirmedDateTime DateTime   reservation  
reservationPromoId string 256 reservation  
reservationSource string 32 reservation  
reservationPrimaryTravelerRecNo long   reservation  
reservationPrimaryTravelerName string 256 reservation  
reservationTravelerName string   reservation  
reservationTicketType short   airReservation Normal = 1, ExchangeAddCollect = 2, ExchangeRefund = 3, CreditMemo = 4, DebitMemo = 5, TAAD = 6
reservationOriginalTicketNo long   airReservation  
reservationCommissionDatePayable Date   reservation  
reservationCreateDateTime DateTimeOffset   reservation  
reservationLastModifiedDateTime DateTimeOffset   reservation  
reservationMarkupDiscount long   reservation  
reservationItineraryRemarks string   reservation  
reservationForeignCurrencyCode string 3 reservation  
reservationForeignTotalFare long   reservation  
reservationForeignCommissionAmount long   reservation  
reservationForeignConversionRate int   reservation Percentage values have an implied 4 digits after the decimal point. A value of 0.2512 == 25.12% is represented as 251200
reservationGstVatOnCommissionAmount long   reservation  
reservationGstVatOnCommissionOverride bool   reservation  
reservationGstVatOnCommissionRate int   reservation Percentage values have an implied 4 digits after the decimal point. A value of 0.2512 == 25.12% is represented as 251200
reservationTotalGstVatTaxAmount long   reservation  
reservationUnitDescription string   reservation  
reservationNumberOfUnits short   reservation  
tripActionRecNo long   tripActionItem  
tripActionItemTriggerIndex short   tripActionItem FixedDate = 1, StartDate = 2, EndDate = 3, TargetTravelDate = 4, CreateDate = 5, EarliestBookingDate = 6, EarliestDepositDate = 7, EarliestFinalPayDate = 8
tripActionItemDate Date   tripActionItem  
tripActionItemTriggerFixedDate Date   tripActionItem  
tripActionItemDescription string   tripActionItem  
tripActionItemCompleted DateTimeOffset   tripActionItem  
tripActionItemAssignedToAppUserRecNo long   tripActionItem  
tripActionItemAssignedToAppUserId string 64 tripActionItem  
reservationAdvisorRecNo long   reservationAdvisor  
reservationAdvisorProfileRecNo long   reservationAdvisor  
reservationAdvisorProfileName string 256 reservationAdvisor  
reservationAdvisorProfileId string 32 reservationAdvisor  
reservationAdvisorCommissionAmount long   reservationAdvisor  
reservationAdvisorCommissionRate short   reservationAdvisor Percentage values have an implied 2 digits after the decimal point. A value of 25% is represented as 2500
reservationAdvisorReconciliationRecNo long   reservationAdvisor  
reservationAdvisorReconciliationDate Date   reservationAdvisor  
reservationAdvisorDefaultCommissionRate short   reservationAdvisor Percentage values have an implied 2 digits after the decimal point. A value of 25% is represented as 2500
reservationAdvisorDefaultCommissionAmount long   reservationAdvisor  
reservationAccountingEntryRecNo long   reservation  
reservationAccountingEntryCreateDate Date   reservation  
reservationTravelerRecNo long   reservationTraveler  
reservationAdvisorsDatePayable Date   reservation  
tripPaymentAuthorizationRecNo long   tripPaymentAuthorization  
tripPaymentAuthorizationStatus short   tripPaymentAuthorization Pending = 1, Authorized = 2, Expired = 3
tripPaymentAuthorizationCreateDateTime DateTimeOffset   tripPaymentAuthorization  
tripPaymentAuthorizationExpirationDateTime DateTimeOffset   tripPaymentAuthorization  
reservationSupplierPaymentTotal long   reservation  
reservationClientPaymentTotal long   reservation  
tripDocumentAcknowledgementRecNo long   tripDocumentAcknowledgement  
tripDocumentAcknowledgementStatus short   tripDocumentAcknowledgement Pending = 1, Acknowledged = 2, Expired = 3
tripDocumentAcknowledgementCreateDateTime DateTimeOffset   tripDocumentAcknowledgement  
tripDocumentAcknowledgementAcknowledgeByDateTime DateTimeOffset   tripDocumentAcknowledgement  
tripDocumentAcknowledgementDocumentTemplateRecNo long   tripDocumentAcknowledgement  
tripWarningMessages string   trip  
reservationWarningMessages string   reservation  
reservationFareSavings long   reservation  
reservationFareLoss long   reservation  
reservationAirItinerary string 128 airReservation  
ClientProfile_recNo long   trip  
ClientProfile_tagRecNo long   trip  
ClientProfile_tagName string 64 trip  
ClientProfile_tagValue string 1024 trip  
ClientProfile_tags string   trip  
ClientProfile_createDateTime DateTimeOffset   trip  
ClientProfile_lastModifiedDateTime DateTimeOffset   trip  
ClientProfile_name string 256 trip  
ClientProfile_uniqueId string 64 trip  
ClientProfile_profileType short   trip Client = 1, Supplier = 2, Advisor = 3, Other = 4
ClientProfile_clientType short   clientProfile Personal = 1, Corporate = 2
ClientProfile_supplierType short   supplierProfile BillingAndServiceProvider = 1, BillingProvider = 2, ServiceProvider = 3
ClientProfile_primaryPersonRecNo long   trip  
ClientProfile_primaryPersonName string 256 trip  
ClientProfile_primaryPersonFirstName string 64 trip  
ClientProfile_primaryPersonLastName string 64 trip  
ClientProfile_primaryPersonEmail string 256 trip  
ClientProfile_primaryPersonPhone string 256 trip  
ClientProfile_clientAnniversaryDay short   clientProfile  
ClientProfile_clientAnniversaryMonth short   clientProfile  
ClientProfile_clientAnniversaryYear short   clientProfile  
ClientProfile_clientAnniversaryNote string 256 clientProfile  
ClientProfile_clientAdvisorProfileRecNo long   clientProfile  
ClientProfile_clientAdvisorName string 256 clientProfile  
ClientProfile_clientBranchRecNo long   clientProfile  
ClientProfile_clientBranchName string 64 clientProfile  
ClientProfile_remarks string 256 trip  
ClientProfile_activeStatus short   trip Inactive = 0, Active = 1, Pending = 2
ClientProfile_primaryEmail string 256 trip  
ClientProfile_primaryEmailPermitMarketing bool   trip  
ClientProfile_primaryPhone string 256 trip  
ClientProfile_primaryPhonePermitMarketing bool   trip  
ClientProfile_preferredSupplier bool   supplierProfile  
ClientProfile_supplierTravelCategoryFlags int   supplierProfile Air = 1, Hotel = 2, Car = 4, Cruise = 8, Tour = 16, Rail = 32, Transfer = 64, Insurance = 128, ServiceFee = 256, Excursion = 512, Misc = 1024
ClientProfile_street1 string 128 address  
ClientProfile_street2 string 128 address  
ClientProfile_city string 64 address  
ClientProfile_stateProvince string 32 address  
ClientProfile_zipPostalCode string 16 address  
ClientProfile_country string 4 address  
ClientProfile_mailingStreet1 string 128 address  
ClientProfile_mailingStreet2 string 128 address  
ClientProfile_mailingCity string 64 address  
ClientProfile_mailingStateProvince string 32 address  
ClientProfile_mailingZipPostalCode string 16 address  
ClientProfile_mailingCountry string 4 address  
ClientProfile_addressPermitMarketing bool   address  
ClientProfile_supplierVendorId string 10 supplierProfile  
ClientProfile_supplierCommissionRate short   supplierProfile Percentage values have an implied 2 digits after the decimal point. A value of 25% is represented as 2500
ClientProfile_clientInformalSalutation string 128 clientProfile  
ClientProfile_clientFormalSalutation string 128 clientProfile  
ClientProfile_firstId string 32 trip  
ClientProfile_profileCommType short   communication Phone = 1, Email = 2, SocialMedia = 3, Web = 4
ClientProfile_profileCommValue string 256 communication  
ClientProfile_profileCommIsBillingContact bool   communication ProfileSearch.profileCommIsBillingContact is deprecated, use profileCommContactOption instead.
ClientProfile_profileCommContactOption short   communication Billing = 1, CustomerService = 2
ClientProfile_actionRecNo long   trip  
ClientProfile_actionItemTriggerIndex short   trip FixedDate = 1, CreateDate = 2, AnniversaryDate = 3
ClientProfile_actionItemDate Date   trip  
ClientProfile_actionItemTriggerFixedDate Date   trip  
ClientProfile_actionItemDescription string   trip  
ClientProfile_actionItemCompleted DateTimeOffset   trip  
ClientProfile_actionItemAssignedToAppUserRecNo long   trip  
ClientProfile_actionItemAssignedToAppUserId string 64 trip  
ClientProfile_imageCount short   trip  
ClientProfile_supplierAirlineNo short   supplierProfile  
ClientProfile_documentAcknowledgementRecNo long   trip  
ClientProfile_documentAcknowledgementStatus short   trip Pending = 1, Acknowledged = 2, Expired = 3
ClientProfile_documentAcknowledgementCreateDateTime DateTimeOffset   trip  
Parameter Type Linked Column Description
recNo [inherited] NumSearchParam recNo  
skipLookup [inherited] bool    
readOnlyIntent [inherited] bool    
startingRow [inherited] long    
rowCount [inherited] long    
topRows [inherited] long    
distinct [inherited] bool    
createDateTimeFrom [inherited] DateTimeUTCSearchParam    
createDateTimeTo [inherited] DateTimeUTCSearchParam    
modifiedDateTimeFrom [inherited] DateTimeUTCSearchParam    
modifiedDateTimeTo [inherited] DateTimeUTCSearchParam    
includeCols [inherited] string[]    
includeColsExtended [inherited] includeColsExtended[]    
baseUrl [inherited] string    
reportFormat [inherited] bool    
reportName [inherited] string    
queryOptimizerFlags [inherited] [int<int>]   Recompile = 1
priority [inherited] long    
tags [inherited] TagsSearchParams[]    
clientProfileRecNo NumSearchParam clientProfileRecNo  
advisorProfileRecNo NumSearchParam advisorProfileRecNo  
targetTravelDateFrom DateSearchParam targetTravelDate  
targetTravelDateTo DateSearchParam targetTravelDate  
tripStartDateTimeFrom DateSearchParam startDateTime  
tripStartDateTimeTo DateSearchParam startDateTime  
tripEndDateTimeFrom DateSearchParam endDateTime  
tripEndDateTimeTo DateSearchParam endDateTime  
cancelled bool cancelled  
tripName StringSearchParam name  
destinationRecNo NumSearchParam destinationRecNo  
branchRecNo NumSearchParam branchRecNo  
tripRecordLocator StringSearchParam tripRecordLocator  
tripVisibility [short<short>] visibility None = 0, ClientItin = 1, ClientTripProposal = 2, DestinationImages = 64
reservationCreateDateTimeFrom DateTimeUTCSearchParam    
reservationCreateDateTimeTo DateTimeUTCSearchParam    
reservationModifiedDateTimeFrom DateTimeUTCSearchParam    
reservationModifiedDateTimeTo DateTimeUTCSearchParam    
reservationRecNo NumSearchParam reservationRecNo  
reservationBookDateTimeFrom DateSearchParam reservationBookDateTime  
reservationBookDateTimeTo DateSearchParam reservationBookDateTime  
reservationStartDateTimeFrom DateSearchParam reservationStartDateTime  
reservationStartDateTimeTo DateSearchParam reservationStartDateTime  
reservationEndDateTimeFrom DateSearchParam reservationEndDateTime  
reservationEndDateTimeTo DateSearchParam reservationEndDateTime  
reservationDepositDueDateFrom DateSearchParam reservationDepositDueDate  
reservationDepositDueDateTo DateSearchParam reservationDepositDueDate  
reservationDepositCompleted bool reservationDepositCompleted  
reservationFinalPayDueDateFrom DateSearchParam reservationFinalPayDueDate  
reservationFinalPayDueDateTo DateSearchParam reservationFinalPayDueDate  
reservationTravelCategory EnumSearchParam<TravelCategory> reservationTravelCategoryRecNo Air = 1, Hotel = 2, Car = 3, Cruise = 4, Tour = 5, Rail = 6, Transfer = 7, Insurance = 8, ServiceFee = 9, Excursion = 10, ClientVoucher = 11, GiftCertificate = 12, SupplierVoucher = 13, Misc = 99
subReservationTravelCategory EnumSearchParam<TravelCategory>   Air = 1, Hotel = 2, Car = 3, Cruise = 4, Tour = 5, Rail = 6, Transfer = 7, Insurance = 8, ServiceFee = 9, Excursion = 10, ClientVoucher = 11, GiftCertificate = 12, SupplierVoucher = 13, Misc = 99
reservationTravelSubCategoryRecNo NumSearchParam reservationTravelSubCategoryRecNo  
reservationSupplierProfileRecNo NumSearchParam reservationSupplierProfileRecNo  
reservationTrackClientPayments bool reservationTrackClientPayments  
reservationStatus EnumSearchParam<Status> reservationStatus Pending = 1, Confirmed = 2, Cancelled = 3, Voided = 4
subReservationStatus EnumSearchParam<Status>   Pending = 1, Confirmed = 2, Cancelled = 3, Voided = 4
reservationClientBalance NumSearchParam reservationClientBalance  
reservationClientBalanceMin NumSearchParam reservationClientBalance  
reservationClientBalanceMax NumSearchParam reservationClientBalance  
reservationSupplierBalance NumSearchParam reservationSupplierBalance  
reservationSupplierBalanceMin NumSearchParam reservationSupplierBalance  
reservationSupplierBalanceMax NumSearchParam reservationSupplierBalance  
reservationARCBSPNumber NumSearchParam reservationARCBSPNumber  
reservationAdvisorProfileRecNo NumSearchParam reservationAdvisorProfileRecNo  
reservationProviderProfileRecNo NumSearchParam reservationProviderProfileRecNo  
reservationTravelerRecNo NumSearchParam reservationTravelerRecNo  
reservationTravelerName StringSearchParam reservationTravelerName  
reservationTicketNumber NumSearchParam reservationTicketNo  
reservationConfirmationNumber StringSearchParam reservationConfirmationNo  
reservationGroupBookingNumber StringSearchParam reservationGroupBookingNumber  
reservationConfirmedDateTimeFrom DateSearchParam reservationConfirmedDateTime  
reservationConfirmedDateTimeTo DateSearchParam reservationConfirmedDateTime  
reservationRecordLocator StringSearchParam reservationRecordLocator  
reservationPromoId StringSearchParam reservationPromoId  
reservationTotalFare NumSearchParam reservationTotalFare  
reservationCommissionAmount NumSearchParam reservationCommissionAmount  
reservationSupplierProfileInfoName StringSearchParam reservationSupplierProfileInfoName  
reservationProviderProfileInfoName StringSearchParam reservationProviderProfileInfoName  
reservationOriginalTicketNumber NumSearchParam reservationOriginalTicketNo  
tripActionItemCompleted bool tripActionItemCompleted  
tripActionItemDateFrom DateSearchParam tripActionItemDate  
tripActionItemDateTo DateSearchParam tripActionItemDate  
tripActionItemAssignedToAppUserRecNo NumSearchParam tripActionItemAssignedToAppUserRecNo  
reservationAdvisorReconciliationRecNo NumSearchParam reservationAdvisorReconciliationRecNo  
reservationAdvisorReconciled bool reservationAdvisorReconciliationRecNo Parameter reservationAdvisorReconciled is deprecated, use reservationAdvisorReconciliationRecNo IS BLANK instead.
reservationAdvisorReconciliationDateFrom DateSearchParam reservationAdvisorReconciliationDate  
reservationAdvisorReconciliationDateTo DateSearchParam reservationAdvisorReconciliationDate  
reservationCommissionDatePayableFrom DateSearchParam reservationCommissionDatePayable Filter results based on calculated date payable column
reservationCommissionDatePayableTo DateSearchParam reservationCommissionDatePayable Filter results based on calculated date payable column
reservationAccountingEntryCreateDateFrom DateSearchParam reservationAccountingEntryCreateDate  
reservationAccountingEntryCreateDateTo DateSearchParam reservationAccountingEntryCreateDate  
reservationAdvisorsDatePayableFrom DateSearchParam reservationAdvisorsDatePayable  
reservationAdvisorsDatePayableTo DateSearchParam reservationAdvisorsDatePayable  
reservationAdvisorRecNo NumSearchParam reservationAdvisorRecNo  
tripPaymentAuthorizationRecNo NumSearchParam tripPaymentAuthorizationRecNo  
tripPaymentAuthorizationStatus EnumSearchParam<PaymentAuthorizationStatus> tripPaymentAuthorizationStatus Pending = 1, Authorized = 2, Expired = 3
tripPaymentAuthorizationCreateDateTimeFrom DateTimeUTCSearchParam tripPaymentAuthorizationCreateDateTime  
tripPaymentAuthorizationCreateDateTimeTo DateTimeUTCSearchParam tripPaymentAuthorizationCreateDateTime  
tripPaymentAuthorizationExpirationDateTimeFrom DateTimeUTCSearchParam tripPaymentAuthorizationExpirationDateTime  
tripPaymentAuthorizationExpirationDateTimeTo DateTimeUTCSearchParam tripPaymentAuthorizationExpirationDateTime  
reservationSupplierPaymentTotal NumSearchParam reservationSupplierPaymentTotal  
reservationSource StringSearchParam reservationSource  
reservationItineraryRemarks StringSearchParam reservationItineraryRemarks  
tripDocumentAcknowledgementRecNo NumSearchParam tripDocumentAcknowledgementRecNo  
tripDocumentAcknowledgementStatus EnumSearchParam<DocumentAcknowledgementStatus> tripDocumentAcknowledgementStatus Pending = 1, Acknowledged = 2, Expired = 3
tripDocumentAcknowledgementCreateDateTimeFrom DateTimeUTCSearchParam tripDocumentAcknowledgementCreateDateTime  
tripDocumentAcknowledgementCreateDateTimeTo DateTimeUTCSearchParam tripDocumentAcknowledgementCreateDateTime  
tripDocumentAcknowledgementAcknowledgeByDateTimeFrom DateTimeUTCSearchParam tripDocumentAcknowledgementAcknowledgeByDateTime  
tripDocumentAcknowledgementAcknowledgeByDateTimeTo DateTimeUTCSearchParam tripDocumentAcknowledgementAcknowledgeByDateTime  
tripDocumentAcknowledgementDocumentTemplateRecNo NumSearchParam tripDocumentAcknowledgementDocumentTemplateRecNo  
tripWarningMessages StringSearchParam tripWarningMessages  
reservationWarningMessages StringSearchParam reservationWarningMessages  
reservationTags TagsSearchParams[]    
includeParamSets TripSearchParams[]    
excludeParamSets TripSearchParams[]    
clientProfileSearchParams ProfileSearchParams clientProfileRecNo  
destinationSearchParams DestinationSearchParams destinationRecNo  
reservationTravelerSearchParams PersonSearchParams reservationTravelerRecNo  
reservationAdvisorProfileSearchParams ProfileSearchParams reservationAdvisorProfileRecNo  
reservationSupplierProfileSearchParams ProfileSearchParams reservationSupplierProfileRecNo  
reservationProviderProfileSearchParams ProfileSearchParams reservationProviderProfileRecNo  
reservationPaymentSearchParams PaymentSearchParams reservationRecNo  
excludeTripSearchParams TripSearchParams recNo  
Status code Description
200 Ok
401 Unauthorized
403 Forbidden

Example request: a trip search that returns the trip recNo and trip name for trips with a target travel date between 31-DEC-2022 and 15-JAN-2023

POST https://api-dev.trestechnologies.com/tripSearch
Content-Type: application/json
Authorization: Bearer <session-token>
{
  "targetTravelDateFrom": {
    "Date": "2022-12-31T00:00:00"
  },
  "targetTravelDateTo": {
    "Date": "2023-01-15T00:00:00"
  },
  "includeCols": [
    "recNo",
    "name"
  ]
}

Example response

Content-Type: application/json
Status: 200 Ok
[
  {
    "recNo": 1969697,
    "name": "Hawaii 2023"
  },
  {
    "recNo": 1969698,
    "name": "50th Anniversary"
  }
]