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. Activity Calls
  3. Rental Equipment Calls

Cart Contents

zapiGetCartContents

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.

cartId*

integer

ID of the cart

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiGetCartContents</methodName>
        <methodErrorCode>0</methodErrorCode>
        <methodErrorMessage/>
        <cart>
            <cartId>bbe52b2e4f8ed9ff24864d5fac089615</cartId>
            <customers>
                <customer>
                    <clientFirstName>
                        <![CDATA[Hermione]]>
                    </clientFirstName>
                    <clientLastName>
                        <![CDATA[Granger]]>
                    </clientLastName>
                    <homePhone>
                        <![CDATA[]]>
                    </homePhone>
                    <homePrefix>
                        <![CDATA[1]]>
                    </homePrefix>
                    <homeIdd>
                        <![CDATA[]]>
                    </homeIdd>
                    <mobilePhone>
                        <![CDATA[]]>
                    </mobilePhone>
                    <mobilePrefix>
                        <![CDATA[6045669284]]>
                    </mobilePrefix>
                    <mobileIdd>
                        <![CDATA[]]>
                    </mobileIdd>
                    <primAddress>
                        <![CDATA[119 W Pender St Suite 423]]>
                    </primAddress>
                    <primPostal>
                        <![CDATA[V6B1S5]]>
                    </primPostal>
                    <primProvince>
                        <![CDATA[BC]]>
                    </primProvince>
                    <secAddress>
                        <![CDATA[]]>
                    </secAddress>
                    <city>
                        <![CDATA[Vancouver]]>
                    </city>
                    <email>
                        <![CDATA[support@zaui.com]]>
                    </email>
                    <height>
                        <![CDATA[N/A]]>
                    </height>
                    <weight>
                        <![CDATA[N/A]]>
                    </weight>
                    <gender>
                        <![CDATA[]]>
                    </gender>
                    <birthDate>
                        <![CDATA[0000-00-00]]>
                    </birthDate>
                    <clientId>1229</clientId>
                    <about>0</about>
                    <countryId>0</countryId>
                    <countryISO>
                        <![CDATA[CA]]>
                    </countryISO>
                    <loyaltyProgram>0</loyaltyProgram>
                    <newsLetter>0</newsLetter>
                    <allowsPrivateDataSharing>0</allowsPrivateDataSharing>
                    <customFields/>
                </customer>
            </customers>
            <activities>
                <activity>
                    <cartItemId>47273</cartItemId>
                    <packageId>0</packageId>
                    <packageName>
                        <![CDATA[]]>
                    </packageName>
                    <activityId>80</activityId>
                    <activityType>500</activityType>
                    <activityName>
                        <![CDATA[Canyon Icewalk ]]>
                    </activityName>
                    <supplierConfirmationNumber/>
                    <activityDate>2022-04-30</activityDate>
                    <activityTime>13:00:00</activityTime>
                    <formattedActivityDateTime>Sat, Apr 30 2022 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>40240</bookingNumber>
                            <customerName>
                                <![CDATA[Hermione Granger]]>
                            </customerName>
                            <activityName>
                                <![CDATA[Canyon Icewalk ]]>
                            </activityName>
                            <activityDate>
                                <![CDATA[2022-04-30]]>
                            </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^40240_A80|2022-04-30|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>
            <products/>
            <remainingBalance>
                <balance>$0.00</balance>
            </remainingBalance>
            <transactions>
                <transaction>
                    <transactionId>99776</transactionId>
                    <transactionName>
                        <![CDATA[Cash]]>
                    </transactionName>
                    <transactionMethod>2002</transactionMethod>
                    <transactionAmount>$105.00</transactionAmount>
                    <userId>5</userId>
                    <firstName>
                        <![CDATA[Zaui]]>
                    </firstName>
                    <lastName>
                        <![CDATA[Support]]>
                    </lastName>
                    <formattedAmount>$105.00</formattedAmount>
                    <transactionDate>2021-11-22 15:14:17</transactionDate>
                    <transactionStatus>1</transactionStatus>
                </transaction>
            </transactions>
            <cartTotals>
                <bookingNumber>40240</bookingNumber>
                <modifyBookingNumber>40240</modifyBookingNumber>
                <bookingSourcedOnline/>
                <activityTotal>$100.00</activityTotal>
                <activityTax>$0.00</activityTax>
                <productTotal>$0.00</productTotal>
                <productTax>$0.00</productTax>
                <packageTotal>$0.00</packageTotal>
                <activitySurplusFees>$0.00</activitySurplusFees>
                <guestFee>$0.00</guestFee>
                <surchargeTotal>$0.00</surchargeTotal>
                <perPersonTax>$0.00</perPersonTax>
                <total>$100.00</total>
                <tax>$5.00</tax>
                <taxUnrounded>$5.00</taxUnrounded>
                <totalIncludingTax>$105.00</totalIncludingTax>
                <totalNetAmount>$0.00</totalNetAmount>
                <zauiMerchantFee>$0.00</zauiMerchantFee>
                <packageTotal_formatted>$0.00</packageTotal_formatted>
                <activityTotal_formatted>$100.00</activityTotal_formatted>
                <productTotal_formatted>$0.00</productTotal_formatted>
                <subtotal_formatted>$100.00</subtotal_formatted>
                <tax_formatted>$5.00</tax_formatted>
                <totalIncludingTax_formatted>$105.00</totalIncludingTax_formatted>
                <totalNetAmount_formatted>$0.00</totalNetAmount_formatted>
                <taxes>
                    <tax>
                        <taxDisplayName>GST</taxDisplayName>
                        <taxAmount>5</taxAmount>
                        <taxAmount_formatted>$5.00</taxAmount_formatted>
                    </tax>
                </taxes>
            </cartTotals>
        </cart>
        <currencies/>
    </methodResponse>
</response>
<request>
   <zapiToken></zapiToken>
   <zapiAccountId></zapiAccountId>
   <zapiUserId></zapiUserId>
   <zapiMethod>
   <methodName>zapiGetCartContents</methodName>
       <cartId></cartId>
   </zapiMethod>
</request>
<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiGetCartContents</methodName>
        <methodErrorCode></methodErrorCode>
        <methodErrorMessage></methodErrorMessage>
        <cart>
            <cartId></cartId>
            <customers>
                <customer>
                    <clientFirstName></clientFirstName>
                    <clientLastName></clientLastName>
                    <homePhone></homePhone>
                    <homePrefix></homePrefix>
                    <homeIdd></homeIdd>
                    <mobilePhone></mobilePhone>
                    <mobilePrefix></mobilePrefix>
                    <mobileIdd></mobileIdd>
                    <primAddress></primAddress>
                    <primPostal></primPostal>
                    <primProvince></primProvince>
                    <secAddress></secAddress>
                    <city></city>
                    <email></email>
                    <height></height>
                    <weight></weight>
                    <gender></gender>
                    <birthDate></birthDate>
                    <clientId></clientId>
                    <about></about>
                    <countryId></countryId>
                    <countryISO></countryISO>
                    <loyaltyProgram</loyaltyProgram>
                    <newsLetter>0</newsLetter>
                    <allowsPrivateDataSharing></allowsPrivateDataSharing>
                    <customFields/>
                </customer>
            </customers>
            <activities>
                <activity>
                    <cartItemId></cartItemId>
                    <packageId></packageId>
                    <packageName></packageName>
                    <activityId></activityId>
                    <activityType></activityType>
                    <activityName></activityName>
                    <supplierConfirmationNumber></supplierConfirmationNumber>
                    <activityDate></activityDate>
                    <activityTime></activityTime>
                    <formattedActivityDateTime></formattedActivityDateTime>
                    <inventoryRemainsAvailable></inventoryRemainsAvailable>
                    <rentalStartDate></rentalStartDate>
                    <rentalStartTime></rentalStartTime>
                    <rentalEndDate></rentalEndDate>
                    <rentalEndTime></rentalEndTime>
                    <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></ticketExpiry>
                    <ticketPrinterText></ticketPrinterText>
                    <operatedByCompanyId></operatedByCompanyId>
                    <operatedByCompanyName></operatedByCompanyName>
                    <category>
                        <categoryId></categoryId>
                        <categoryName></categoryName>
                    </category>
                    <seniors></seniors>
                    <seniorsLabel></seniorsLabel>
                    <adults></adults>
                    <adultsLabel></adultsLabel>
                    <students></students>
                    <studentsLabel></studentsLabel>
                    <children></children>
                    <childrenLabel></childrenLabel>
                    <infants></infants>
                    <infantsLabel></infantsLabel>
                    <passengersAsString></passengersAsString>
                    <totalCost></totalCost>
                    <pricingOptions></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>
                        <equipmentCategories>
                            <equipmentCategoryId></equipmentCategoryId>
                            <equipmentCategoryName></equipmentCategoryName>
                            <reservedEquipment>
                                <equipmentItem>
                                    <equipmentId></equipmentId>
                                    <equipmentName></equipmentName>
                                </equipmentItem>
                            </reservedEquipment>
                        </equipmentCategories>
                    </equipment>
                    <checkedInStatus></checkedInStatus>
                </activity>
            </activities>
            <products/>
            <remainingBalance>
                <balance></balance>
            </remainingBalance>
            <transactions/>
            <cartTotals>
                <bookingNumber></bookingNumber>
                <modifyBookingNumber></modifyBookingNumber>
                <bookingSourcedOnline/>
                <activityTotal></activityTotal>
                <activityTax></activityTax>
                <productTotal></productTotal>
                <productTax></productTax>
                <packageTotal></packageTotal>
                <activitySurplusFees></activitySurplusFees>
                <guestFee></guestFee>
                <surchargeTotal></surchargeTotal>
                <perPersonTax></perPersonTax>
                <total></total>
                <tax></tax>
                <taxUnrounded></taxUnrounded>
                <totalIncludingTax></totalIncludingTax>
                <totalNetAmount></totalNetAmount>
                <zauiMerchantFee></zauiMerchantFee>
                <packageTotal_formatted></packageTotal_formatted>
                <activityTotal_formatted></activityTotal_formatted>
                <productTotal_formatted></productTotal_formatted>
                <subtotal_formatted></subtotal_formatted>
                <tax_formatted></tax_formatted>
                <totalIncludingTax_formatted></totalIncludingTax_formatted>
                <totalNetAmount_formatted></totalNetAmount_formatted>
                <taxes>
                    <tax>
                        <taxDisplayName></taxDisplayName>
                        <taxAmount></taxAmount>
                        <taxAmount_formatted></taxAmount_formatted>
                    </tax>
                </taxes>
            </cartTotals>
        </cart>
        <currencies/>
    </methodResponse>
</response>
PreviousEquipment AvailabilityNextAdd to Cart

Last updated 3 years ago

Was this helpful?