LogoLogo
  • Getting Started
    • Supplier API (ZAPI)
    • Getting Started
      • Implementing Exponential Back-Off
    • API Specification
    • API Specification Enhancements
    • Glossary of Terms
  • Supporting Nodes
    • Supporting Nodes
      • Single Booking Details
      • Currencies
      • Cart
      • Activity Times
      • Products
      • Business Hours
      • Pickup Locations
      • Dropoff Location
      • Rental Date & Times
      • Allowed Guest Types
      • Waitlist
      • Passenger List
      • Guest or Agent Details
      • User Custom Fields
      • Related Bookings
      • Transaction Details
        • Basic Transaction
        • Credit Card Transaction
        • Voucher/Invoice Transaction
        • Discount Transaction
      • Days of the Week
      • Price Code
      • Multi-Day Package Itinerary
      • Booking - Search Results
      • Mobile Data
  • ZAPI Calls
    • Start Here
      • Ping Test
    • Activity Calls
      • All Activities by Date
      • All Activities by Name
      • Activity & Product Catalog
      • Activity Categories
      • Activity Category by ID
      • Cancelled Activities
      • Create Cancellation
      • Check Inventory
      • Single Activity Details
      • Upcoming Activities
      • Remove Cancellation
      • Rental Equipment Calls
        • Equipment Price Quote
        • Equipment Availability
        • Cart Contents
        • Add to Cart
    • Agent Calls
      • Agent Login
      • Authenticate Agent
      • Get Agent Profile
      • Update Agent Username
      • Update Agent Password
    • Booking
      • Batch Availability
      • Booking Search
        • Search Bookings
        • Search by Booking Number
        • Search by Last Name
        • Search by Mobile Number
      • Cancel Booking
      • Email Itinerary
      • Generate Barcode Image
      • Ticket Data by Booking ID
    • Guest Specific
      • Authenticate Guest
      • Booking Details
      • Get Guest Profile
      • Guest Lookup
      • Update Username
      • Update Password
      • Update Profile
    • Interacting with a Cart
      • Add Activity to Cart
      • Add Package to Cart
      • Add Product to Cart
      • Clear Cart Session
      • Create a Unique Cart
      • Get All Cart Sessions
      • Get Cart Contents
      • Load Booking into Cart
      • Remove Activity
      • Remove Product
      • Remove Cart Session
      • Update Notes to Cart
      • Update Customer Details
      • Transactions
        • Process Payment
        • Process Single Transaction
        • Apply Promo Code
        • Apply Gift Card
    • Manifest
      • Entire Day Manifest
      • Activity Manifest
    • Mobile
      • Check In
      • Generate Z Report
      • User Logout
    • Packages
      • Get Package Categories
      • Get Packages by Category
      • Get Package Details
      • Minimum Dates to Book
      • Package Pricing Details
    • Products
      • Product Inventory
      • Product Categories
      • Product by Category
      • Product by Name
      • Single Product Detail
    • System Info
      • All Companies
      • All Equipment
      • Custom Fields List
      • Employee List
      • Get System Info
      • User List
    • Waitlist
      • Single Activity Waitlist
      • Add Guest
      • Convert to Cart
      • Remove Guest
  • Appendix
    • Activity Type IDs
    • Error Codes
    • Package Type IDs
    • Product Type IDs
    • Payment Method Type IDs
    • User Type IDs
Powered by GitBook
On this page

Was this helpful?

  1. ZAPI Calls
  2. Guest Specific

Booking Details

Get single booking details of a single guest.

zapiGuests_GetBookingDetails

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.

zapiAccountId*

integer

Generated by the supplier system.

zapiUserId*

integer

Generated by the supplier system when a new contact is created.

methodName*

string

The method being called.

guestID*

integer

Retrieved by running Authenticate Guest call.

guestHashKey*

integer

Retrieved by running Authenticate Guest call.

bookingNumber*

integer

Confirmation number assigned once booking is confirmed.

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiGuests_GetBookingDetails</methodName>
        <bookingDetails>
            <bookingNumber>40235</bookingNumber>
            <bookingReference>3BBNWEN</bookingReference>
            <activities>
                <activity>
                    <attributeId>71719</attributeId>
                    <packageId>0</packageId>
                    <packageName>
                        <![CDATA[]]>
                    </packageName>
                    <activityId>128</activityId>
                    <activityType>505</activityType>
                    <activityName>
                        <![CDATA[Electric Bike Rentals]]>
                    </activityName>
                    <activityDate>2021-12-16</activityDate>
                    <activityDateTime>2021-12-16 00:00:00</activityDateTime>
                    <activityTime>09:00:00</activityTime>
                    <rentalStartDate>2021-12-16</rentalStartDate>
                    <rentalStartTime>09:00:00</rentalStartTime>
                    <rentalEndDate>2021-12-16</rentalEndDate>
                    <rentalEndTime>13:00:00</rentalEndTime>
                    <checkedInStatus>Not Checked In</checkedInStatus>
                    <pickupLocationId>0</pickupLocationId>
                    <pickupName>
                        <![CDATA[]]>
                    </pickupName>
                    <pickupLocationAddress>
                        <![CDATA[]]>
                    </pickupLocationAddress>
                    <pickupTime>
                        <![CDATA[]]>
                    </pickupTime>
                    <dropOffLocationId>0</dropOffLocationId>
                    <dropoffName>
                        <![CDATA[]]>
                    </dropoffName>
                    <dropoffTime>
                        <![CDATA[]]>
                    </dropoffTime>
                    <dropOffLocationAddress>
                        <![CDATA[]]>
                    </dropOffLocationAddress>
                    <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>
                    <totalCost>$50.00</totalCost>
                    <pricingOptions/>
                    <onStandby>false</onStandby>
                    <onWaitList>false</onWaitList>
                    <waitListId>0</waitListId>
                </activity>
            </activities>
            <products/>
            <transactions/>
            <outstandingBalance>$52.50</outstandingBalance>
            <bookingBalance>
                <hasOutstandingBalance>false</hasOutstandingBalance>
                <balance>0</balance>
                <balanceFormated>$0.00</balanceFormated>
            </bookingBalance>
            <subTotal>$50.00</subTotal>
            <tax>$2.50</tax>
            <total>$52.50</total>
        </bookingDetails>
        <methodErrorCode>0</methodErrorCode>
        <methodErrorMessage>
            <![CDATA[]]>
        </methodErrorMessage>
    </methodResponse>
</response>
<request>
	<zapiToken></zapiToken>
	<zapiAccountId></zapiAccountId>
	<zapiUserId></zapiUserId>
	<zapiMethod>
		<methodName>zapiGuests_GetBookingDetails</methodName>
		<guestID></guestID >
		<guestHashKey></guestHashKey >
		<bookingNumber></bookingNumber>
	</zapiMethod>
</request>
<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiGuests_GetBookingDetails</methodName>
        <bookingDetails>
            <bookingNumber></bookingNumber>
            <bookingReference></bookingReference>
            <activities>
                <activity>
                    <attributeId></attributeId>
                    <packageId></packageId>
                    <packageName></packageName>
                    <activityId></activityId>
                    <activityType></activityType>
                    <activityName></activityName>
                    <activityDate></activityDate>
                    <activityDateTime></activityDateTime>
                    <activityTime></activityTime>
                    <checkedInStatus></checkedInStatus>
                    <pickupLocationId></pickupLocationId>
                    <pickupName></pickupName>
                    <pickupLocationAddress></pickupLocationAddress>
                    <pickupTime></pickupTime>
                    <dropOffLocationId></dropOffLocationId>
                    <dropoffName></dropoffName>
                    <dropoffTime></dropoffTime>
                    <dropOffLocationAddress></dropOffLocationAddress>
                    <notes></notes>
                    <passengers>
                        <seniors></seniors>
                        <adults></adults>
                        <students></students>
                        <children></children>
                        <infants></infants>
                        <passengersAsString></passengersAsString>
                    </passengers>
                    <totalCost></totalCost>
                    <pricingOptions></pricingOptions>
                    <onStandby></onStandby>
                    <onWaitList></onWaitList>
                    <waitListId></waitListId>
                </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>
            <outstandingBalance></outstandingBalance>
            <bookingBalance>
                <hasOutstandingBalance></hasOutstandingBalance>
                <balance></balance>
                <balanceFormated>/balanceFormated>
            </bookingBalance>
            <subTotal></subTotal>
            <tax></tax>
            <total></total>
        </bookingDetails>
        <methodErrorCode></methodErrorCode>
        <methodErrorMessage></methodErrorMessage>
    </methodResponse>
</response>
PreviousAuthenticate GuestNextGet Guest Profile

Last updated 3 years ago

Was this helpful?