Ticket Data by Booking ID

Retrieve ticket information related to a single booking.

zapiBookings_GetTicketDataByBookingId

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.
bookingId*	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>zapiBookings_GetTicketDataByBookingId</methodName>
        <customers>
            <customerDetails>
                <customerID>1224</customerID>
                <customerHashKey>021f701c0f4d7009740fa7dada2fd478be0758fd</customerHashKey>
                <accountId>
                    <![CDATA[0]]>
                </accountId>
                <expiryDate>
                    <![CDATA[2022-09-03]]>
                </expiryDate>
                <username>
                    <![CDATA[[e-mail]]]>
                </username>
                <firstName>
                    <![CDATA[Harry]]>
                </firstName>
                <lastName>
                    <![CDATA[Potter]]>
                </lastName>
                <gender>
                    <![CDATA[]]>
                </gender>
                <mobilePhone>
                    <![CDATA[]]>
                </mobilePhone>
                <email>
                    <![CDATA[[e-mail]]]>
                </email>
                <addressLine1>
                    <![CDATA[119 W Pender St Suite 423]]>
                </addressLine1>
                <addressLine2>
                    <![CDATA[]]>
                </addressLine2>
                <city>
                    <![CDATA[Vancouver]]>
                </city>
                <state>
                    <![CDATA[]]>
                </state>
                <country>
                    <![CDATA[Canada]]>
                </country>
                <zipCode>
                    <![CDATA[V6B1S5]]>
                </zipCode>
                <birthDate>N/A</birthDate>
                <dateCreated>2021-09-03 13:41:29</dateCreated>
            </customerDetails>
            <activities>
                <activity>
                    <packageId>0</packageId>
                    <packageName>
                        <![CDATA[]]>
                    </packageName>
                    <activityId>80</activityId>
                    <activityType>500</activityType>
                    <activityName>
                        <![CDATA[Canyon Icewalk ]]>
                    </activityName>
                    <supplierConfirmationNumber/>
                    <activityDate>2021-11-29</activityDate>
                    <activityTime>13:00:00</activityTime>
                    <formattedActivityDateTime>Mon, Nov 29 2021 1:00 PM</formattedActivityDateTime>
                    <inventoryRemainsAvailable>true</inventoryRemainsAvailable>
                    <pickupLocationId>0</pickupLocationId>
                    <pickupLocationName>
                        <![CDATA[]]>
                    </pickupLocationName>
                    <pickupLocationAddress>
                        <![CDATA[]]>
                    </pickupLocationAddress>
                    <pickupLocationTimeString>
                        <![CDATA[ ]]>
                    </pickupLocationTimeString>
                    <pickupDestinationId>0</pickupDestinationId>
                    <pickupDestinationName>
                        <![CDATA[]]>
                    </pickupDestinationName>
                    <dropOffLocationId>0</dropOffLocationId>
                    <dropOffLocationName>
                        <![CDATA[]]>
                    </dropOffLocationName>
                    <dropOffAddress>
                        <![CDATA[]]>
                    </dropOffAddress>
                    <dropOffLocationTimeString>
                        <![CDATA[ ]]>
                    </dropOffLocationTimeString>
                    <dropoffDestinationId>0</dropoffDestinationId>
                    <dropoffDestinationName>
                        <![CDATA[]]>
                    </dropoffDestinationName>
                    <notes>
                        <![CDATA[]]>
                    </notes>
                    <bookingHistoryNote>
                        <![CDATA[]]>
                    </bookingHistoryNote>
                    <isFreeSell>false</isFreeSell>
                    <ticketExpiry/>
                    <ticketPrinterText>
                        <![CDATA[Please keep this ticket for your records.]]>
                    </ticketPrinterText>
                    <operatedByCompanyId>1</operatedByCompanyId>
                    <operatedByCompanyName>
                        <![CDATA[Supplier Test System]]>
                    </operatedByCompanyName>
                    <category>
                        <categoryId>8</categoryId>
                        <categoryName>
                            <![CDATA[Canyon Walks]]>
                        </categoryName>
                    </category>
                    <seniors>0</seniors>
                    <seniorsLabel>
                        <![CDATA[Seniors]]>
                    </seniorsLabel>
                    <adults>2</adults>
                    <adultsLabel>
                        <![CDATA[Adults]]>
                    </adultsLabel>
                    <students>0</students>
                    <studentsLabel>
                        <![CDATA[Students]]>
                    </studentsLabel>
                    <children>0</children>
                    <childrenLabel>
                        <![CDATA[Children]]>
                    </childrenLabel>
                    <infants>0</infants>
                    <infantsLabel>
                        <![CDATA[Infants]]>
                    </infantsLabel>
                    <passengersAsString>
                        <![CDATA[2 (ad)]]>
                    </passengersAsString>
                    <totalCost>$100.00</totalCost>
                    <pricingOptions/>
                    <onStandby>false</onStandby>
                    <onWaitList>false</onWaitList>
                    <waitListId>0</waitListId>
                    <tickets>
                        <ticket>
                            <companyName>
                                <![CDATA[Supplier Test System]]>
                            </companyName>
                            <companyPhone>
                                <![CDATA[6045669284]]>
                            </companyPhone>
                            <companyWebsite>
                                <![CDATA[www.zaui.com]]>
                            </companyWebsite>
                            <companyCityAndProvince>
                                <![CDATA[Vancouver, BC]]>
                            </companyCityAndProvince>
                            <bookingNumber>40242</bookingNumber>
                            <customerName>
                                <![CDATA[Harry Potter]]>
                            </customerName>
                            <activityName>
                                <![CDATA[Canyon Icewalk ]]>
                            </activityName>
                            <activityDate>
                                <![CDATA[2021-11-29]]>
                            </activityDate>
                            <activityTime>
                                <![CDATA[13:00:00]]>
                            </activityTime>
                            <pickupLocationTime>
                                <![CDATA[]]>
                            </pickupLocationTime>
                            <dropoffLocationTime>
                                <![CDATA[]]>
                            </dropoffLocationTime>
                            <printerText>
                                <![CDATA[Please keep this ticket for your records.]]>
                            </printerText>
                            <barcodeType>
                                <![CDATA[qrcode]]>
                            </barcodeType>
                            <barcodeString>
                                <![CDATA[%^f0a00e311056a278b559f36c245169c913974cba^40242_A80|2021-11-29|13:00:00|0^%]]>
                            </barcodeString>
                            <barcodeLabel>
                                <![CDATA[]]>
                            </barcodeLabel>
                            <paxTypeLabel>
                                <![CDATA[2 (ad) ]]>
                            </paxTypeLabel>
                            <customCategoryText>
                                <![CDATA[]]>
                            </customCategoryText>
                        </ticket>
                    </tickets>
                    <equipment/>
                    <checkedInStatus>Not Checked In</checkedInStatus>
                </activity>
            </activities>
        </customers>
        <methodErrorCode>0</methodErrorCode>
        <methodErrorMessage>
            <![CDATA[]]>
        </methodErrorMessage>
    </methodResponse>
</response>

Request

<request>
   <zapiToken></zapiToken>
   <zapiAccountId></zapiAccountId>
   <zapiUserId></zapiUserId>
   <zapiMethod>
      <methodName>zapiBookings_GetTicketDataByBookingId</methodName>
      <bookingId></bookingId>
   </zapiMethod>
</request>

Response

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiBookings_GetTicketDataByBookingId</methodName>
        <customers>
            <customerDetails>
                <customerID></customerID>
                <customerHashKey></customerHashKey>
                <accountId></accountId>
                <expiryDate></expiryDate>
                <username></username>
                <firstName></firstName>
                <lastName></lastName>
                <gender></gender>
                <mobilePhone></mobilePhone>
                <email></email>
                <addressLine1></addressLine1>
                <addressLine2></addressLine2>
                <city></city>
                <state></state>
                <country></country>
                <zipCode></zipCode>
                <birthDate></birthDate>
                <dateCreated></dateCreated>
            </customerDetails>
            <activities>
                <activity>
                    <packageId></packageId>
                    <packageName></packageName>
                    <activityId></activityId>
                    <activityType></activityType>
                    <activityName></activityName>
                    <supplierConfirmationNumber/>
                    <activityDate></activityDate>
                    <activityTime></activityTime>
                    <formattedActivityDateTime></formattedActivityDateTime>
                    <inventoryRemainsAvailable></inventoryRemainsAvailable>
                    <arrivalAirlineId></arrivalAirlineId>
                    <arrivalAirlineName></arrivalAirlineName>
                    <arrivalFlightNumber></arrivalFlightNumber>
                    <arrivalFlightTime></arrivalFlightTime>
                    <pickupLocationId></pickupLocationId>
                    <pickupLocationName></pickupLocationName>
                    <pickupLocationAddress></pickupLocationAddress>
                    <pickupLocationTimeString></pickupLocationTimeString>
                    <pickupDestinationId></pickupDestinationId>
                    <pickupDestinationName></pickupDestinationName>
                    <dropOffLocationId></dropOffLocationId>
                    <dropOffLocationName></dropOffLocationName>
                    <dropOffAddress></dropOffAddress>
                    <dropOffLocationTimeString></dropOffLocationTimeString>
                    <dropoffDestinationId></dropoffDestinationId>
                    <dropoffDestinationName></dropoffDestinationName>
                    <notes></notes>
                    <bookingHistoryNote></bookingHistoryNote>
                    <isFreeSell></isFreeSell>
                    <ticketExpiry/>
                    <ticketPrinterText></ticketPrinterText>
                    <operatedByCompanyId></operatedByCompanyId>
                    <operatedByCompanyName></operatedByCompanyName>
                    <category>
                        <categoryId></categoryId>
                        <categoryName></categoryName>
                    </category>
                    <adults></adults>
                    <adultsLabel></adultsLabel>
                    <passengersAsString></passengersAsString>
                    <totalCost></totalCost>
                    <pricingOptions/>
                    <onStandby></onStandby>
                    <onWaitList></onWaitList>
                    <waitListId></waitListId>
                    <tickets>
                        <ticket>
                            <companyName></companyName>
                            <companyPhone></companyPhone>
                            <companyWebsite></companyWebsite>
                            <companyCityAndProvince></companyCityAndProvince>
                            <bookingNumber></bookingNumber>
                            <customerName></customerName>
                            <activityName></activityName>
                            <activityDate></activityDate>
                            <activityTime></activityTime>
                            <pickupLocationTime></pickupLocationTime>
                            <dropoffLocationTime></dropoffLocationTime>
                            <printerText></printerText>
                            <barcodeType></barcodeType>
                            <barcodeString></barcodeString>
                            <barcodeLabel></barcodeLabel>
                            <paxTypeLabel></paxTypeLabel>
                            <customCategoryText></customCategoryText>
                        </ticket>
                    </tickets>
                    <equipment/>
                    <checkedInStatus></checkedInStatus>
                </activity>
            </activities>
        </customers>
        <methodErrorCode>0</methodErrorCode>
        <methodErrorMessage></methodErrorMessage>
    </methodResponse>
</response>