Add Package to Cart

Adds a package to the cart order

For overview of package types, please see Package Type IDs in the Appendix.

zapiAddPackageToCart

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

Request Body

Name	Type	Description
activityDate*	integer	The travel date. Format: YYYY:MM:DD.
activityId*	integer	ID of the activity.
activityTime*	integer	Activity departure time. Format: HH:MM:SS.
zapiToken*	integer	Token that must be used for a reseller to communicate with the supplier system.
packageId*	integer	ID of the package.
cartId*	integer	ID of the current cart session to add the activity to.
zapiAccountId*	integer	Generated by the supplier system.
methodName*	string	The method being called.
passengers*	integer	Number of passengers to add to the cart
zapiUserId*	integer	Generated by the supplier system when a new contact is created.
pickupLocationId	integer	ID of the pick up location.
pickupAddress	string	Custom address if applicable.
dropOffLocationId	integer	ID of the drop off location.
dropoffAddress	string	Custom address if applicable.
pricingOptions	string	Additional options available for an activity. If null, do not pass.

200: OK

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiAddPackageToCart</methodName>
        <cart>
            <cartId>08578bc790686b98093137ce1984e514</cartId>
            <customers/>
            <activities>
                <activity>
                    <cartItemId>47285</cartItemId>
                    <packageId>0</packageId>
                    <packageName>
                        <![CDATA[]]>
                    </packageName>
                    <activityId>80</activityId>
                    <activityType>500</activityType>
                    <activityName>
                        <![CDATA[Canyon Icewalk ]]>
                    </activityName>
                    <supplierConfirmationNumber/>
                    <activityDate>2022-05-25</activityDate>
                    <activityTime>13:00:00</activityTime>
                    <formattedActivityDateTime>Wed, May 25 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[ Adding Canyon Icewalk  at 1:00 PM for Wednesday, May 25 2022<br>Commissioned To: Zaui Development - Nadine Dauberman]]>
                    </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>0</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[]]>
                    </passengersAsString>
                    <totalCost>$0.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>0</bookingNumber>
                            <customerName>
                                <![CDATA[ ]]>
                            </customerName>
                            <activityName>
                                <![CDATA[Canyon Icewalk ]]>
                            </activityName>
                            <activityDate>
                                <![CDATA[2022-05-25]]>
                            </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^0_A80|2022-05-25|13:00:00|0^%]]>
                            </barcodeString>
                            <barcodeLabel>
                                <![CDATA[]]>
                            </barcodeLabel>
                            <paxTypeLabel>
                                <![CDATA[]]>
                            </paxTypeLabel>
                            <customCategoryText>
                                <![CDATA[]]>
                            </customCategoryText>
                        </ticket>
                    </tickets>
                    <equipment/>
                    <checkedInStatus>Not Checked In</checkedInStatus>
                </activity>
                <activity>
                    <cartItemId>47286</cartItemId>
                    <packageId>4</packageId>
                    <packageName>
                        <![CDATA[The Best of London]]>
                    </packageName>
                    <activityId>80</activityId>
                    <activityType>500</activityType>
                    <activityName>
                        <![CDATA[Canyon Icewalk ]]>
                    </activityName>
                    <supplierConfirmationNumber/>
                    <activityDate>2022-05-30</activityDate>
                    <activityTime>13:00:00</activityTime>
                    <formattedActivityDateTime>Mon, May 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>1</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[1 (ad)]]>
                    </passengersAsString>
                    <totalCost>$45.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>0</bookingNumber>
                            <customerName>
                                <![CDATA[ ]]>
                            </customerName>
                            <activityName>
                                <![CDATA[Canyon Icewalk ]]>
                            </activityName>
                            <activityDate>
                                <![CDATA[2022-05-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^0_A80|2022-05-30|13:00:00|0^%]]>
                            </barcodeString>
                            <barcodeLabel>
                                <![CDATA[]]>
                            </barcodeLabel>
                            <paxTypeLabel>
                                <![CDATA[1 (ad)* ]]>
                            </paxTypeLabel>
                            <customCategoryText>
                                <![CDATA[]]>
                            </customCategoryText>
                        </ticket>
                    </tickets>
                    <equipment/>
                    <checkedInStatus>Not Checked In</checkedInStatus>
                </activity>
                <activity>
                    <cartItemId>47287</cartItemId>
                    <packageId>4</packageId>
                    <packageName>
                        <![CDATA[The Best of London]]>
                    </packageName>
                    <activityId>123</activityId>
                    <activityType>500</activityType>
                    <activityName>
                        <![CDATA[Harry Potter Magical Walking Tour]]>
                    </activityName>
                    <supplierConfirmationNumber/>
                    <activityDate>2022-05-29</activityDate>
                    <activityTime>18:00:00</activityTime>
                    <formattedActivityDateTime>Sun, May 29 2022 6: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>33</categoryId>
                        <categoryName>
                            <![CDATA[Walking Tours]]>
                        </categoryName>
                    </category>
                    <seniors>0</seniors>
                    <seniorsLabel>
                        <![CDATA[Seniors]]>
                    </seniorsLabel>
                    <adults>1</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[1 (ad)]]>
                    </passengersAsString>
                    <totalCost>$45.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>0</bookingNumber>
                            <customerName>
                                <![CDATA[ ]]>
                            </customerName>
                            <activityName>
                                <![CDATA[Harry Potter Magical Walking Tour]]>
                            </activityName>
                            <activityDate>
                                <![CDATA[2022-05-29]]>
                            </activityDate>
                            <activityTime>
                                <![CDATA[18: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^0_A123|2022-05-29|18:00:00|0^%]]>
                            </barcodeString>
                            <barcodeLabel>
                                <![CDATA[]]>
                            </barcodeLabel>
                            <paxTypeLabel>
                                <![CDATA[1 (ad)* ]]>
                            </paxTypeLabel>
                            <customCategoryText>
                                <![CDATA[]]>
                            </customCategoryText>
                        </ticket>
                    </tickets>
                    <equipment/>
                    <checkedInStatus>Not Checked In</checkedInStatus>
                </activity>
            </activities>
            <products/>
            <remainingBalance>
                <balance>$92.25</balance>
            </remainingBalance>
            <cartTotals>
                <bookingNumber>0</bookingNumber>
                <modifyBookingNumber>0</modifyBookingNumber>
                <bookingSourcedOnline/>
                <activityTotal>$0.00</activityTotal>
                <activityTax>$0.00</activityTax>
                <productTotal>$0.00</productTotal>
                <productTax>$0.00</productTax>
                <packageTotal>$90.00</packageTotal>
                <activitySurplusFees>$0.00</activitySurplusFees>
                <guestFee>$0.00</guestFee>
                <surchargeTotal>$0.00</surchargeTotal>
                <perPersonTax>$0.00</perPersonTax>
                <total>$90.00</total>
                <tax>$2.25</tax>
                <taxUnrounded>$2.25</taxUnrounded>
                <totalIncludingTax>$92.25</totalIncludingTax>
                <totalNetAmount>$0.00</totalNetAmount>
                <zauiMerchantFee>$2.79</zauiMerchantFee>
                <packageTotal_formatted>$90.00</packageTotal_formatted>
                <activityTotal_formatted>$0.00</activityTotal_formatted>
                <productTotal_formatted>$0.00</productTotal_formatted>
                <subtotal_formatted>$90.00</subtotal_formatted>
                <tax_formatted>$2.25</tax_formatted>
                <totalIncludingTax_formatted>$92.25</totalIncludingTax_formatted>
                <totalNetAmount_formatted>$0.00</totalNetAmount_formatted>
                <taxes>
                    <tax>
                        <taxDisplayName>GST</taxDisplayName>
                        <taxAmount>2.25</taxAmount>
                        <taxAmount_formatted>$2.25</taxAmount_formatted>
                    </tax>
                </taxes>
            </cartTotals>
        </cart>
        <currencies/>
        <methodErrorCode>0</methodErrorCode>
        <methodErrorMessage>
            <![CDATA[Package has been added]]>
        </methodErrorMessage>
    </methodResponse>
</response>

Request

<request>
	<zapiToken></zapiToken>
	<zapiAccountId></zapiAccountId>
	<zapiUserId></zapiUserId>
	<zapiMethod>
		<methodName>zapiAddPackageToCart</methodName>
		<cartId></cartId>
		<packageId></packageId>
        	<passengers>
			<seniors></seniors>
			<adults></adults>
			<students></students>
			<children></children>
			<infants></infants>
			<passengersAsString></passengersAsString>
		</passengers>
		<activities>
			<activity>
				<activityId></activityId>
				<activityDate></activityDate>
				<activityTime></activityTime>
				<pickupLocationId></pickupLocationId>
				<pickupAddress/>
				<dropOffLocationId></dropOffLocationId>
				<dropoffAddress/>
				<pricingOptions/>
			</activity>
			<activity>
				<activityId></activityId>
				<activityDate></activityDate>
				<activityTime></activityTime>
				<pickupLocationId></pickupLocationId>
				<pickupAddress/>
				<dropOffLocationId></dropOffLocationId>
				<dropoffAddress/>
				<pricingOptions/>
			</activity>
		</activities>
		<products/>
	</zapiMethod>
</request>

Response