Search by Booking Number

Search for a booking using the confirmation number.

zapiSearchBookingsByBookingNumber

GET https://{yourdomainname}.zaui.net/zapi/

Request Body

Name	Type	Description
zapiToken*	integer	Token that must be used for a reseller to communicate with the supplier system.
bookingNumber*	integer	Confirmation number assigned once booking is confirmed.
methodName*	string	The method being called.
zapiUserId*	integer	Generated by the supplier system when a new contact is created.
zapiAccountId*	integer	Generated by the supplier system.

200: OK

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiSearchBookingsByBookingNumber</methodName>
        <methodErrorCode>0</methodErrorCode>
        <methodErrorMessage>Ok</methodErrorMessage>
        <totalSearchResults>1</totalSearchResults>
        <booking>
            <bookingNumber>40234</bookingNumber>
            <bookingReference>27J76MT</bookingReference>
            <guestID>1236</guestID>
            <guestHashKey>27071c33db840b2478eb8faa074f367586e33015</guestHashKey>
            <lastName>
                <![CDATA[Bravo]]>
            </lastName>
            <firstName>
                <![CDATA[Johnny]]>
            </firstName>
            <email>
                <![CDATA[[e-mail]]]>
            </email>
            <mobilePrefix>
                <![CDATA[6045669284]]>
            </mobilePrefix>
            <mobilePhone>
                <![CDATA[6045669284]]>
            </mobilePhone>
            <isCancelled>0</isCancelled>
            <outstandingBalance>$105.00</outstandingBalance>
            <bookingBalance>
                <hasOutstandingBalance>false</hasOutstandingBalance>
                <balance>0</balance>
                <balanceFormated>$0.00</balanceFormated>
            </bookingBalance>
            <subTotal>$100.00</subTotal>
            <tax>$5.00</tax>
            <activitySurplusFees>$0.00</activitySurplusFees>
            <total>$105.00</total>
            <reservationist>
                <![CDATA[Zaui Support]]>
            </reservationist>
            <activities>
                <activity>
                    <attributeId>71728</attributeId>
                    <activityName>
                        <![CDATA[Electric Bike Rentals]]>
                    </activityName>
                    <activityId>128</activityId>
                    <activityType>505</activityType>
                    <packageId>0</packageId>
                    <packageName/>
                    <activityDate>2021-11-18</activityDate>
                    <activityTime>09:00:00</activityTime>
                    <supplierConfirmation/>
                    <activityDateTime>Thu, Nov 18 2021 9:00 AM</activityDateTime>
                    <pickupLocationId>0</pickupLocationId>
                    <pickupTime>
                        <![CDATA[]]>
                    </pickupTime>
                    <pickupName>
                        <![CDATA[]]>
                    </pickupName>
                    <pickupLocationAddress>
                        <![CDATA[]]>
                    </pickupLocationAddress>
                    <pickupLocationTimeString>
                        <![CDATA[ ]]>
                    </pickupLocationTimeString>
                    <dropOffLocationId>0</dropOffLocationId>
                    <dropoffTime>
                        <![CDATA[]]>
                    </dropoffTime>
                    <dropoffName>
                        <![CDATA[]]>
                    </dropoffName>
                    <dropOffLocationAddress>
                        <![CDATA[]]>
                    </dropOffLocationAddress>
                    <dropOffLocationTimeString>
                        <![CDATA[ ]]>
                    </dropOffLocationTimeString>
                    <commissionAgentId>5</commissionAgentId>
                    <commissionAgentName>
                        <![CDATA[Zaui Support]]>
                    </commissionAgentName>
                    <commissionAgentCompany>
                        <![CDATA[Supplier Test System]]>
                    </commissionAgentCompany>
                    <rentalStartTime>09:00:00</rentalStartTime>
                    <rentalEndTime>13:00:00</rentalEndTime>
                    <rentalEndDate>2021-11-18</rentalEndDate>
                    <tag/>
                    <notes>
                        <![CDATA[]]>
                    </notes>
                    <passengers>
                        <seniors>0</seniors>
                        <adults>2</adults>
                        <students>0</students>
                        <children>0</children>
                        <infants>0</infants>
                        <passengersAsString>
                            <![CDATA[2 (ad)]]>
                        </passengersAsString>
                    </passengers>
                    <passengersAsString>
                        <![CDATA[2 (ad) ]]>
                    </passengersAsString>
                    <equipment>
                        <equipmentCategory>
                            <equipmentCategoryId>1</equipmentCategoryId>
                            <equipmentCategoryName>Adult Bikes</equipmentCategoryName>
                            <bookedEquipment>
                                <equipmentItem>
                                    <equipmentId>580</equipmentId>
                                    <equipmentName>Adult Bikes 1</equipmentName>
                                </equipmentItem>
                                <equipmentItem>
                                    <equipmentId>581</equipmentId>
                                    <equipmentName>Adult Bikes 2</equipmentName>
                                </equipmentItem>
                            </bookedEquipment>
                        </equipmentCategory>
                    </equipment>
                    <totalCost>$100.00</totalCost>
                    <pricingOptions/>
                    <checkedInStatus>Not Checked In</checkedInStatus>
                    <onStandby>false</onStandby>
                    <onWaitList>false</onWaitList>
                    <waitListId>0</waitListId>
                    <Airlines/>
                    <guides/>
                </activity>
            </activities>
            <products/>
            <transactions>
                <transaction>
                    <transactionId>99780</transactionId>
                    <transactionName>
                        <![CDATA[Override - Pay Later]]>
                    </transactionName>
                    <transactionMethod>2003</transactionMethod>
                    <transactionAmount>$105.00</transactionAmount>
                    <userId>5</userId>
                    <firstName>
                        <![CDATA[Zaui]]>
                    </firstName>
                    <lastName>
                        <![CDATA[Support]]>
                    </lastName>
                    <formattedAmount>$105.00</formattedAmount>
                    <transactionDate>2021-11-23 13:35:33</transactionDate>
                    <transactionStatus>1</transactionStatus>
                </transaction>
            </transactions>
        </booking>
    </methodResponse>
</response>

Request

<request>
	<zapiToken></zapiToken>
	<zapiAccountId></zapiAccountId>
	<zapiUserId></zapiUserId>
	<zapiMethod>
		<methodName>zapiSearchBookingsByBookingNumber</methodName>
		<bookingNumber></bookingNumber>
	</zapiMethod>
</request>

Response

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiSearchBookingsByBookingNumber</methodName>
        <methodErrorCode></methodErrorCode>
        <methodErrorMessage/>
        <totalSearchResults></totalSearchResults>
        <requestedSearchResults></requestedSearchResults>
        <allBookings>
            <booking>
                <bookingNumber></bookingNumber>
                <bookingReference></bookingReference>
                <guestID></guestID>
                <guestHashKey></guestHashKey>
                <lastName></lastName>
                <firstName></firstName>
                <email></email>
                <mobilePrefix></mobilePrefix>
                <mobilePhone></mobilePhone>
                <isCancelled></isCancelled>
                <outstandingBalance></outstandingBalance>
                <bookingBalance>
                    <hasOutstandingBalance></hasOutstandingBalance>
                    <balance></balance>
                    <balanceFormated></balanceFormated>
                </bookingBalance>
                <subTotal></subTotal>
                <tax></tax>
                <activitySurplusFees></activitySurplusFees>
                <total></total>
                <reservationist></reservationist>
                <activities>
                    <activity>
                        <attributeId></attributeId>
                        <activityName></activityName>
                        <activityId></activityId>
                        <activityType></activityType>
                        <packageId></packageId>
                        <packageName></packageName>
                        <activityDate></activityDate>
                        <activityTime></activityTime>
                        <supplierConfirmation></supplierConfirmation>
                        <activityDateTime></activityDateTime>
                        <pickupLocationId></pickupLocationId>
                        <pickupTime></pickupTime>
                        <pickupName></pickupName>
                        <pickupLocationAddress></pickupLocationAddress>
                        <pickupLocationTimeString></pickupLocationTimeString>
                        <dropOffLocationId></dropOffLocationId>
                        <dropoffTime></dropoffTime>
                        <dropoffName></dropoffName>
                        <dropOffLocationAddress></dropOffLocationAddress>
                        <dropOffLocationTimeString></dropOffLocationTimeString>
                        <commissionAgentId></commissionAgentId>
                        <commissionAgentName></commissionAgentName>
                        <commissionAgentCompany></commissionAgentCompany>
                        <notes></notes>
                        <passengers>
                            <seniors></seniors>
                            <adults></adults>
                            <students></students>
                            <children></children>
                            <infants></infants>
                            <passengersAsString></passengersAsString>
                        </passengers>
                        <passengersAsString></passengersAsString>
                        <totalCost></totalCost>
                        <pricingOptions></pricingOptions>
                        <checkedInStatus></checkedInStatus>
                        <onStandby></onStandby>
                        <onWaitList></onWaitList>
                        <waitListId></waitListId>
                        <Airlines/>
                        <guides/>
                    </activity>
                </activities>
                <products/>
                <transactions>
                    <transaction>
                        <transactionId></transactionId>
                        <transactionName></transactionName>
                        <transactionMethod></transactionMethod>
                        <transactionAmount></transactionAmount>
                        <userId></userId>
                        <firstName></firstName>
                        <lastName></lastName>
                        <formattedAmount></formattedAmount>
                        <transactionDate></transactionDate>
                        <transactionStatus></transactionStatus>
                    </transaction>
                </transactions>
            </booking>
            
        </allBookings>
    </methodResponse>
</response>