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. Packages

Minimum Dates to Book

Determine when a package needs to be booked by.

zapiPackage_DetermineMinimumDatesToBook

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.

packageId*

integer

ID of the package.

passengers

object

Object describing the type and number of passengers to add to the cart

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiPackage_DetermineMinimumDatesToBook</methodName>
        <packageId>4</packageId>
        <packageName>
            <![CDATA[The Best of London]]>
        </packageName>
        <startDate>2021-11-25</startDate>
        <passengers>
            <seniors/>
            <adults/>
            <students/>
            <children/>
            <infants/>
        </passengers>
        <activityStartId>0</activityStartId>
        <activityEndId>0</activityEndId>
        <isPackageBookable>true</isPackageBookable>
        <isBookableMinimumStartDate>2021-11-25</isBookableMinimumStartDate>
        <activities>
            <activity>
                <activityName>Canyon Icewalk </activityName>
                <activityId>80</activityId>
                <activityType>500</activityType>
                <activityTypeAsString>Regular</activityTypeAsString>
                <isBookable>true</isBookable>
                <isStandbyAvailable>false</isStandbyAvailable>
                <activityDate>2021-11-25</activityDate>
                <activityDateFormatted>Thursday, November 25 2021</activityDateFormatted>
                <activityTimes>
                    <activityTime>
                        <activityTime>13:00:00</activityTime>
                        <isBookable>true</isBookable>
                        <isBookableMessage/>
                        <spotsRemaining>50</spotsRemaining>
                        <isStandbyAvailable>false</isStandbyAvailable>
                        <numberOnStandby>0</numberOnStandby>
                    </activityTime>
                </activityTimes>
                <isAvailable>true</isAvailable>
            </activity>
            <activity>
                <activityName>Harry Potter Magical Walking Tour</activityName>
                <activityId>123</activityId>
                <activityType>500</activityType>
                <activityTypeAsString>Regular</activityTypeAsString>
                <isBookable>true</isBookable>
                <isStandbyAvailable>false</isStandbyAvailable>
                <activityDate>2021-11-25</activityDate>
                <activityDateFormatted>Thursday, November 25 2021</activityDateFormatted>
                <activityTimes>
                    <activityTime>
                        <activityTime>18:00:00</activityTime>
                        <isBookable>true</isBookable>
                        <isBookableMessage/>
                        <spotsRemaining>50</spotsRemaining>
                        <isStandbyAvailable>false</isStandbyAvailable>
                        <numberOnStandby>0</numberOnStandby>
                    </activityTime>
                </activityTimes>
                <isAvailable>true</isAvailable>
            </activity>
        </activities>
        <methodErrorCode>0</methodErrorCode>
        <methodErrorMessage>
            <![CDATA[OK]]>
        </methodErrorMessage>
    </methodResponse>
</response>
<request>
	<zapiToken></zapiToken>
	<zapiAccountId></zapiAccountId>
	<zapiUserId></zapiUserId>
	<zapiMethod>
		<methodName>zapiPackage_DetermineMinimumDatesToBook</methodName>
		<packageId></packageId>
		<startDate></startDate>
		<passengers> 
			<seniors></seniors>
			<adults></adults>
			<students></students>
			<children></children>
			<infants></infants>
		</passengers>
	</zapiMethod>
</request>
<?xml version="1.0" encoding="utf-8"?>
<response>
	<zapiVersion>2.1</zapiVersion>
	<error>0</error>
	<message>OK</message>
	<methodResponse>
	<methodName>zapiPackage_DetermineMinimumDatesToBook</methodName>
		<packageId></packageId>
		<startDate></startDate>
		<passengers>
			<seniors></seniors>
			<adults></adults>
			<students></students>
			<children></children>
			<infants></infants>
		</passengers>
		<activityStartId></activityStartId>
		<activityEndId></activityEndId>
		<isPackageBookable></isPackageBookable>
		<isBookableMinimumStartDate></isBookableMinimumStartDate>
		<activities>
			<activity>
				<activityName></activityName>
				<activityId></activityId>
				<activityType></activityType>
				<activityTypeAsString></activityTypeAsString>
				<isBookable></isBookable>
				<activityDate></activityDate>
				<activityTimes>
					<activityTime>
						<activityTime></activityTime>
						<isBookable></isBookable>
						<isBookableMessage></isBookableMessage>
						<spotsRemaining></spotsRemaining>
						<numberOnStandby></numberOnStandby>
						<isStandbyAvailable></isStandbyAvailable>
					</activityTime>
				</activityTimes>
				<isAvailable></isAvailable>
				<isBookableDate></isBookableDate>
			</activity>
		</activities>
		<methodErrorCode>0</methodErrorCode>
		<methodErrorMessage></methodErrorMessage>
	</methodResponse>
</response> 
PreviousGet Package DetailsNextPackage Pricing Details

Last updated 3 years ago

Was this helpful?