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

Batch Availability

This call will allow checking availability for a single activity, across many days.

zapiBatchAvailability

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.

activityEndDate*

integer

The last date to check for availability. End date must be greater than or equal to the start date. Format: YYYY:MM:DD.

activityStartDate*

integer

The first date to check for availability. If the start date is less then the current system date, it will be reset to the current date. Format: YYYY:MM:DD.

zapiAccountId*

integer

Generated by the supplier system.

activityId*

integer

ID of the activity.

methodName*

string

The method being called.

zapiUserId*

integer

Generated by the supplier system when a new contact is created.

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiBatchAvailability</methodName>
        <activities>
            <activity>
                <activityName>
                    <![CDATA[Canyon Icewalk ]]>
                </activityName>
                <activityId>80</activityId>
                <batchAvailability>
                    <dates>
                        <date>
                            <activityDate>2021-12-01</activityDate>
                            <availability>
                                <activityTime>
                                    <activityTimeStart>13:00:00</activityTimeStart>
                                    <activityTimeCancelled>false</activityTimeCancelled>
                                    <activityTimeAvailable>true</activityTimeAvailable>
                                    <activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
                                    <activityTimeAvailableMessage>Available</activityTimeAvailableMessage>
                                    <inventoryCheckCode>0</inventoryCheckCode>
                                    <inventoryCheckMessage/>
                                    <activityTimeSpotsRemaining>0</activityTimeSpotsRemaining>
                                    <numberOnStandby>0</numberOnStandby>
                                    <isStandbyAvailable>false</isStandbyAvailable>
                                    <status>SOLD_OUT</status>
                                    <fixedDepartureOptions/>
                                </activityTime>
                            </availability>
                        </date>
                        <date>
                            <activityDate>2021-12-02</activityDate>
                            <availability>
                                <activityTime>
                                    <activityTimeStart>13:00:00</activityTimeStart>
                                    <activityTimeCancelled>false</activityTimeCancelled>
                                    <activityTimeAvailable>true</activityTimeAvailable>
                                    <activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
                                    <activityTimeAvailableMessage>Available</activityTimeAvailableMessage>
                                    <inventoryCheckCode>0</inventoryCheckCode>
                                    <inventoryCheckMessage/>
                                    <activityTimeSpotsRemaining>0</activityTimeSpotsRemaining>
                                    <numberOnStandby>0</numberOnStandby>
                                    <isStandbyAvailable>false</isStandbyAvailable>
                                    <status>SOLD_OUT</status>
                                    <fixedDepartureOptions/>
                                </activityTime>
                            </availability>
                        </date>
                        <date>
                            <activityDate>2021-12-03</activityDate>
                            <availability>
                                <activityTime>
                                    <activityTimeStart>13:00:00</activityTimeStart>
                                    <activityTimeCancelled>false</activityTimeCancelled>
                                    <activityTimeAvailable>true</activityTimeAvailable>
                                    <activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
                                    <activityTimeAvailableMessage>Available</activityTimeAvailableMessage>
                                    <inventoryCheckCode>0</inventoryCheckCode>
                                    <inventoryCheckMessage/>
                                    <activityTimeSpotsRemaining>0</activityTimeSpotsRemaining>
                                    <numberOnStandby>0</numberOnStandby>
                                    <isStandbyAvailable>false</isStandbyAvailable>
                                    <status>SOLD_OUT</status>
                                    <fixedDepartureOptions/>
                                </activityTime>
                            </availability>
                        </date>
                        <date>
                            <activityDate>2021-12-04</activityDate>
                            <availability>
                                <activityTime>
                                    <activityTimeStart>13:00:00</activityTimeStart>
                                    <activityTimeCancelled>false</activityTimeCancelled>
                                    <activityTimeAvailable>true</activityTimeAvailable>
                                    <activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
                                    <activityTimeAvailableMessage>Available</activityTimeAvailableMessage>
                                    <inventoryCheckCode>0</inventoryCheckCode>
                                    <inventoryCheckMessage/>
                                    <activityTimeSpotsRemaining>0</activityTimeSpotsRemaining>
                                    <numberOnStandby>0</numberOnStandby>
                                    <isStandbyAvailable>false</isStandbyAvailable>
                                    <status>SOLD_OUT</status>
                                    <fixedDepartureOptions/>
                                </activityTime>
                            </availability>
                        </date>
                        <date>
                            <activityDate>2021-12-05</activityDate>
                            <availability>
                                <activityTime>
                                    <activityTimeStart>13:00:00</activityTimeStart>
                                    <activityTimeCancelled>false</activityTimeCancelled>
                                    <activityTimeAvailable>true</activityTimeAvailable>
                                    <activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
                                    <activityTimeAvailableMessage>Available</activityTimeAvailableMessage>
                                    <inventoryCheckCode>0</inventoryCheckCode>
                                    <inventoryCheckMessage/>
                                    <activityTimeSpotsRemaining>0</activityTimeSpotsRemaining>
                                    <numberOnStandby>0</numberOnStandby>
                                    <isStandbyAvailable>false</isStandbyAvailable>
                                    <status>SOLD_OUT</status>
                                    <fixedDepartureOptions/>
                                </activityTime>
                            </availability>
                        </date>
                    </dates>
                </batchAvailability>
            </activity>
        </activities>
    </methodResponse>
</response>

This callback does have the following restrictions:

  • Dates must be greater than or equal to the current system date.

  • The difference in start to end date can not exceed 31 days.

  • The end date can not exceed 31 days from the current date.

<request>
	<zapiToken></zapiToken>
	<zapiAccountId></zapiAccountId>
	<zapiUserId></zapiUserId>
	<zapiMethod>
		<methodName>zapiBatchAvailability</methodName>
		<activityId></activityId>
		<activityStartDate></activityStartDate>
		<activityEndDate></activityEndDate>
	</zapiMethod>
</request>
<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiBatchAvailability</methodName>
        <activities>
            <activity>
                <activityName></activityName>
                <activityId></activityId>
                <batchAvailability>
                    <dates>
                        <date>
                            <activityDate></activityDate>
                            <availability>
                                <activityTime>
                                    <activityTimeStart></activityTimeStart>
                                    <activityTimeCancelled></activityTimeCancelled>
                                    <activityTimeAvailable></activityTimeAvailable>
                                    <activityTimeCancelledOnlineOnly></activityTimeCancelledOnlineOnly>
                                    <activityTimeAvailableMessage></activityTimeAvailableMessage>
                                    <inventoryCheckCode></inventoryCheckCode>
                                    <inventoryCheckMessage/>
                                    <activityTimeSpotsRemaining></activityTimeSpotsRemaining>
                                    <numberOnStandby></numberOnStandby>
                                    <isStandbyAvailable></isStandbyAvailable>
                                    <status></status>
                                    <fixedDepartureOptions/>
                                </activityTime>
                            </availability>
                        </date>
                        <date>
                            <activityDate></activityDate>
                            <availability>
                                <activityTime>
                                    <activityTimeStart></activityTimeStart>
                                    <activityTimeCancelled></activityTimeCancelled>
                                    <activityTimeAvailable></activityTimeAvailable>
                                    <activityTimeCancelledOnlineOnly></activityTimeCancelledOnlineOnly>
                                    <activityTimeAvailableMessage></activityTimeAvailableMessage>
                                    <inventoryCheckCode></inventoryCheckCode>
                                    <inventoryCheckMessage/>
                                    <activityTimeSpotsRemaining></activityTimeSpotsRemaining>
                                    <numberOnStandby></numberOnStandby>
                                    <isStandbyAvailable></isStandbyAvailable>
                                    <status></status>
                                    <fixedDepartureOptions/>
                                </activityTime>
                            </availability>
                    </dates>
                </batchAvailability>
            </activity>
        </activities>
    </methodResponse>
</response>
PreviousBookingNextBooking Search

Last updated 3 years ago

Was this helpful?