Apply Gift Card
zapiGiftCertificateApply
POST 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.
giftCertificate*
string
Gift Card number.
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.
cartId*
integer
ID of the current cart session to add the gift card to.
<?xml version="1.0" encoding="utf-8"?>
<response>
<zapiVersion>2.1</zapiVersion>
<error>0</error>
<message>OK</message>
<methodResponse>
<methodName>zapiGiftCertificateApply</methodName>
<methodErrorCode>0</methodErrorCode>
<methodErrorMessage>Gift certificate applied</methodErrorMessage>
<cart>
<cartId>10b5bc886670340aa9418c17556ca7d3</cartId>
<customers>
<customer>
<clientFirstName>
<![CDATA[Johnny]]>
</clientFirstName>
<clientLastName>
<![CDATA[Bravo]]>
</clientLastName>
<homePhone>
<![CDATA[]]>
</homePhone>
<homePrefix>
<![CDATA[1]]>
</homePrefix>
<homeIdd>
<![CDATA[]]>
</homeIdd>
<mobilePhone>
<![CDATA[6045667896]]>
</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[connectivity@zaui.com]]>
</email>
<height>
<![CDATA[N/A]]>
</height>
<weight>
<![CDATA[N/A]]>
</weight>
<gender>
<![CDATA[]]>
</gender>
<birthDate>
<![CDATA[0000-00-00]]>
</birthDate>
<clientId>1236</clientId>
<about>0</about>
<countryId>0</countryId>
<countryISO>
<![CDATA[BY]]>
</countryISO>
<loyaltyProgram>0</loyaltyProgram>
<newsLetter>0</newsLetter>
<allowsPrivateDataSharing>0</allowsPrivateDataSharing>
<customFields/>
</customer>
</customers>
<activities>
<activity>
<cartItemId>47297</cartItemId>
<packageId>0</packageId>
<packageName>
<![CDATA[]]>
</packageName>
<activityId>80</activityId>
<activityType>500</activityType>
<activityName>
<![CDATA[Canyon Icewalk ]]>
</activityName>
<supplierConfirmationNumber/>
<activityDate>2022-01-13</activityDate>
<activityTime>13:00:00</activityTime>
<formattedActivityDateTime>Thu, Jan 13 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>40244</bookingNumber>
<customerName>
<![CDATA[Johnny Bravo]]>
</customerName>
<activityName>
<![CDATA[Canyon Icewalk ]]>
</activityName>
<activityDate>
<![CDATA[2022-01-13]]>
</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^40244_A80|2022-01-13|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>
<activity>
<cartItemId>47298</cartItemId>
<packageId>0</packageId>
<packageName>
<![CDATA[]]>
</packageName>
<activityId>25</activityId>
<activityType>507</activityType>
<activityName>
<![CDATA[Vancouver Hop On Hop Off - 2 Day Pass]]>
</activityName>
<supplierConfirmationNumber/>
<activityDate>2022-01-14</activityDate>
<activityTime>09:00:00</activityTime>
<formattedActivityDateTime>Fri, Jan 14 2022 9:00 AM</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>true</isFreeSell>
<ticketExpiry/>
<ticketPrinterText>
<![CDATA[Please keep this ticket for your records.]]>
</ticketPrinterText>
<operatedByCompanyId>1</operatedByCompanyId>
<operatedByCompanyName>
<![CDATA[Supplier Test System]]>
</operatedByCompanyName>
<category>
<categoryId>1</categoryId>
<categoryName>
<![CDATA[City Sightseeing]]>
</categoryName>
</category>
<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>$240.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>40244</bookingNumber>
<customerName>
<![CDATA[Johnny Bravo]]>
</customerName>
<activityName>
<![CDATA[Vancouver Hop On Hop Off - 2 Day Pass]]>
</activityName>
<activityDate>
<![CDATA[2022-01-14]]>
</activityDate>
<activityTime>
<![CDATA[09: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^40244_A25|2022-01-14|09:00:00|1eaec96d5136f8d4e41c00736ccceb65^%]]>
</barcodeString>
<barcodeLabel>
<![CDATA[]]>
</barcodeLabel>
<paxTypeLabel>
<![CDATA[1 Adults]]>
</paxTypeLabel>
<customCategoryText>
<![CDATA[]]>
</customCategoryText>
</ticket>
<ticket>
<companyName>
<![CDATA[Supplier Test System]]>
</companyName>
<companyPhone>
<![CDATA[6045669284]]>
</companyPhone>
<companyWebsite>
<![CDATA[www.zaui.com]]>
</companyWebsite>
<companyCityAndProvince>
<![CDATA[Vancouver, BC]]>
</companyCityAndProvince>
<bookingNumber>40244</bookingNumber>
<customerName>
<![CDATA[Johnny Bravo]]>
</customerName>
<activityName>
<![CDATA[Vancouver Hop On Hop Off - 2 Day Pass]]>
</activityName>
<activityDate>
<![CDATA[2022-01-14]]>
</activityDate>
<activityTime>
<![CDATA[09: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^40244_A25|2022-01-14|09:00:00|c3d00d432dda8c2a63b8ca96015b25ed^%]]>
</barcodeString>
<barcodeLabel>
<![CDATA[]]>
</barcodeLabel>
<paxTypeLabel>
<![CDATA[1 Adults]]>
</paxTypeLabel>
<customCategoryText>
<![CDATA[]]>
</customCategoryText>
</ticket>
</tickets>
<equipment/>
<checkedInStatus>Not Checked In</checkedInStatus>
</activity>
</activities>
<products/>
<remainingBalance>
<balance>$357.00</balance>
</remainingBalance>
<transactions>
<transaction>
<transactionId>99782</transactionId>
<transactionName>
<![CDATA[Override - Pay Later]]>
</transactionName>
<transactionMethod>2003</transactionMethod>
<transactionAmount>$357.00</transactionAmount>
<userId>5</userId>
<firstName>
<![CDATA[Zaui]]>
</firstName>
<lastName>
<![CDATA[Support]]>
</lastName>
<formattedAmount>$357.00</formattedAmount>
<transactionDate>2021-11-24 10:51:52</transactionDate>
<transactionStatus>1</transactionStatus>
</transaction>
</transactions>
<cartTotals>
<bookingNumber>40244</bookingNumber>
<modifyBookingNumber>40244</modifyBookingNumber>
<bookingSourcedOnline/>
<activityTotal>$340.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>$340.00</total>
<tax>$17.00</tax>
<taxUnrounded>$17.00</taxUnrounded>
<totalIncludingTax>$7.00</totalIncludingTax>
<totalNetAmount>$0.00</totalNetAmount>
<zauiMerchantFee>$0.00</zauiMerchantFee>
<packageTotal_formatted>$0.00</packageTotal_formatted>
<activityTotal_formatted>$340.00</activityTotal_formatted>
<productTotal_formatted>$0.00</productTotal_formatted>
<subtotal_formatted>$340.00</subtotal_formatted>
<tax_formatted>$17.00</tax_formatted>
<totalIncludingTax_formatted>$357.00</totalIncludingTax_formatted>
<totalNetAmount_formatted>$0.00</totalNetAmount_formatted>
<giftCertificateAmountToBeApplied>$350.00</giftCertificateAmountToBeApplied>
<taxes>
<tax>
<taxDisplayName>GST</taxDisplayName>
<taxAmount>17</taxAmount>
<taxAmount_formatted>$17.00</taxAmount_formatted>
</tax>
</taxes>
</cartTotals>
</cart>
<currencies/>
</methodResponse>
</response><request>
<zapiToken></zapiToken>
<zapiAccountId></zapiAccountId>
<zapiUserId></zapiUserId>
<zapiMethod>
<methodName>zapiGiftCertificateApply</methodName>
<giftCertificate></giftCertificate>
<cartId></cartId>
</zapiMethod>
</request><?xml version="1.0" encoding="utf-8"?>
<response>
<zapiVersion>2.1</zapiVersion>
<error>0</error>
<message>OK</message>
<methodResponse>
<methodName>zapiGiftCertificateApply</methodName>
<methodErrorCode>0</methodErrorCode>
<methodErrorMessage></methodErrorMessage>
<cart>
<cartId></cartId>
<customers>
<customer></customer>
</customers>
<activities></activities>
<products></products>
<transactions></transactions>
<remainingBalance>
<balance></balance>
</remainingBalance>
<cartTotals>
<bookingNumber></bookingNumber>
<modifyBookingNumber></modifyBookingNumber>
<activityTotal>$0.00</activityTotal>
<activityTax>$0.00</activityTax>
<productTotal>$0.00</productTotal>
<productTax>$0.00</productTax>
<packageTotal>$0.00</packageTotal>
<activitySurplusFees>$0.00</activitySurplusFees>
<surchargeTotal>$0.00</surchargeTotal>
<perPersonTax>$0.00</perPersonTax>
<total>$0.00</total>
<tax>$0.00</tax>
<totalIncludingTax>$0.00</totalIncludingTax>
</cartTotals>
<currencies>
<currency>
<currencyName></currencyName>
<currencySymbol></currencySymbol>
<isoCode></isoCode>
<paymentGatewayId></paymentGatewayId>
<rateId></rateId>
<rate></rate>
<totalConvertedWithRate></totalConvertedWithRate>
</currency>
</currencies>
</cart>
</methodResponse>
</response>Last updated