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. Interacting with a Cart

Add Activity to Cart

Adds a single activity to the cart order

PreviousInteracting with a CartNextAdd Package to Cart

Last updated 2 years ago

Was this helpful?

As part of successfully updating or adding an activity to the cart, the response will contain the updated cart contents. See the details in for the details for this particular callback.

For overview of activity types, please see in the Appendix.

zapiAddActivityToCart

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

Adds a single activity to the cart order

Request Body

Name
Type
Description

activityId*

integer

ID of the activity.

activityDate*

integer

The travel start date. Format: YYYY:MM:DD.

activityTime*

integer

Activity departure time. Required for activity type Ids 502 and 503 only. Format: HH:MM:SS.

passengers*

integer

Number of passengers to add to the cart

CategoryId*

integer

ID for a category of equipment. Required for equipment-based rental activity types.

equipmentCategoryName

string

Name of a category of equipment

equipmentId

integer

ID for a specific piece of equipment.

activityTimeOptionId*

integer

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.

zapiToken*

integer

Token that must be used for a reseller to communicate with the supplier system.

cartId*

integer

ID of the current cart session to add the activity to.

activityEndDate*

integer

The travel end date. Required for ALL rental activity types only. Format: YYYY:MM:DD.

rentalStartTime*

integer

The start time of the rental activity. Required for ALL rental activity types only. Format: HH:MM:SS.

rentalEndTime*

integer

The end time of the rental activity. Required for ALL rental activity types only. Format: HH:MM:SS.

dropOffLocationId*

integer

ID of the drop off location. Required for activity type Ids 504 only.

pickupLocationId*

integer

ID of the pick up location. Required for activity type Ids 504 only.

pricingOptions

string

Additional options available for an activity. If null, do not pass.

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiAddActivityToCart</methodName>
        <cart>
            <cartId>08578bc790686b98093137ce1984e514</cartId>
            <customers/>
            <activities>
                <activity>
                    <cartItemId>47280</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>
            </activities>
            <products/>
            <remainingBalance>
                <balance>$0.00</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>$0.00</packageTotal>
                <activitySurplusFees>$0.00</activitySurplusFees>
                <guestFee>$0.00</guestFee>
                <surchargeTotal>$0.00</surchargeTotal>
                <perPersonTax>$0.00</perPersonTax>
                <total>$0.00</total>
                <tax>$0.00</tax>
                <taxUnrounded>$0.00</taxUnrounded>
                <totalIncludingTax>$0.00</totalIncludingTax>
                <totalNetAmount>$0.00</totalNetAmount>
                <zauiMerchantFee>$0.30</zauiMerchantFee>
                <packageTotal_formatted>$0.00</packageTotal_formatted>
                <activityTotal_formatted>$0.00</activityTotal_formatted>
                <productTotal_formatted>$0.00</productTotal_formatted>
                <subtotal_formatted>$0.00</subtotal_formatted>
                <tax_formatted>$0.00</tax_formatted>
                <totalIncludingTax_formatted>$0.00</totalIncludingTax_formatted>
                <totalNetAmount_formatted>$0.00</totalNetAmount_formatted>
                <taxes>
                    <tax>
                        <taxDisplayName>GST</taxDisplayName>
                        <taxAmount>0</taxAmount>
                        <taxAmount_formatted>$0.00</taxAmount_formatted>
                    </tax>
                </taxes>
            </cartTotals>
        </cart>
        <currencies/>
        <methodErrorCode>0</methodErrorCode>
        <methodErrorMessage>
            <![CDATA[Added ]]>
        </methodErrorMessage>
    </methodResponse>
</response
<request>
   <zapiToken></zapiToken>
   <zapiAccountId></zapiAccountId>
   <zapiUserId></zapiUserId>
   <zapiMethod>
    <methodName>zapiAddActivityToCart</methodName>
    <cartId></cartId>
    <activityId></activityId>
    <activityDate></activityDate>
    <activityEndDate></activityEndDate>
    <activityTime></activityTime>
    <activityTimeOptionId></activityTimeOptionId>
    <rentalStartTime></rentalStartTime>
    <rentalEndTime></rentalEndTime>
    <pricingOptions></pricingOptions>
    <pickupLocationId></pickupLocationId>
    <pickupAddress/>
    <dropOffLocationId></dropOffLocationId>
    <dropoffAddress/>
    <passengers>
        <seniors></seniors>
        <adults></adults>
        <students></students>
        <children></children>
        <infants></infants>
    </passengers>
    <equipment>
      <equipmentCategory>
        <CategoryId></CategoryId>
        <equipmentCategoryName></equipmentCategoryName>
        <quantity></quantity>
      </equipmentCategory>
      <selectedEquipment>
        <equipmentId></equipmentId>
      </selectedEquipment>
    </equipment>
    <checkOnlineThresholds></checkOnlineThresholds>
  </zapiMethod>
</request>
<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiAddActivityToCart</methodName>
        <cart>
            <cartId></cartId>
            <customers/>
            <activities>
                <activity>
                    <cartItemId></cartItemId>
                    <packageId></packageId>
                    <packageName></packageName>
                    <activityId></activityId>
                    <activityType></activityType>
                    <activityName></activityName>
                    <supplierConfirmationNumber/>
                    <activityDate></activityDate>
                    <activityTime></activityTime>
                    <formattedActivityDateTime></formattedActivityDateTime>
                    <inventoryRemainsAvailable></inventoryRemainsAvailable>
                    <pickupLocationId>0</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>
                    <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/>
                    <onStandby></onStandby>
                    <onWaitList></onWaitList>
                    <waitListId></waitListId>
                    <tickets>
                        <ticket>
                            <companyName></companyName>
                            <companyPhone></companyPhone>
                            <companyWebsite></companyWebsite>
                            <companyCityAndProvince></companyCityAndProvince>
                            <bookingNumber>0</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>
            <products/>
            <remainingBalance>
                <balance></balance>
            </remainingBalance>
            <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/>
        <methodErrorCode></methodErrorCode>
        <methodErrorMessage></methodErrorMessage>
    </methodResponse>
</response>

Activity Time option ID. Retrieved by running the call.

zapiGetCartContents
Activity Type IDs
zapiGetActivityDetailsByActivityId