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. Activity Calls

Check Inventory

Performs a single inventory check by travel date.

zapiCheckActivityInventoryByDate

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

Request Body

Name
Type
Description

activityId*

integer

ID of the activity.

activityDate

integer

The travel date. If left blank, the current date will be used. Format: YYYY-MM-DD.

activityTime

integer

If left blank, the call will return details for each activity time configured for the activity and activity date. If you provide an activity time, then details for only the requested time slot will be returned. Format: HH:MM:SS.

requestedPassengers.seniors

integer

If left blank, this will be treated as 0. If you provide them, then inventories will be compared and filtered based on the requested passengers.

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.

methodName*

string

The method being called.

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiCheckActivityInventoryByDate</methodName>
        <activityId>80</activityId>
        <activityDate>2022-11-23</activityDate>
        <activityName>
            <![CDATA[Canyon Icewalk ]]>
        </activityName>
        <activityType>500</activityType>
        <totalRequestedPassengers>0</totalRequestedPassengers>
        <activityTimes>
            <activityTime>
                <activityTimeStart>13:00:00</activityTimeStart>
                <activityTimeCancelled>false</activityTimeCancelled>
                <activityTimeAvailable>true</activityTimeAvailable>
                <activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
                <activityTimeAvailableMessage/>
                <inventoryCheckCode>0</inventoryCheckCode>
                <inventoryCheckMessage>OK</inventoryCheckMessage>
                <activityTimeSpotsRemaining>50</activityTimeSpotsRemaining>
                <numberOnStandby>0</numberOnStandby>
                <isStandbyAvailable>false</isStandbyAvailable>
                <status>AVAILABLE</status>
                <fixedDepartureOptions/>
            </activityTime>
        </activityTimes>
        <priceCodeId>400</priceCodeId>
        <allowedPassengers>
            <passengerType>
                <systemTypeId>10</systemTypeId>
                <systemTypeName>seniors</systemTypeName>
                <name>
                    <![CDATA[Seniors]]>
                </name>
                <defaultValue>0</defaultValue>
                <basePrice>$50.00</basePrice>
            </passengerType>
            <passengerType>
                <systemTypeId>11</systemTypeId>
                <systemTypeName>adults</systemTypeName>
                <name>
                    <![CDATA[Adults]]>
                </name>
                <defaultValue>2</defaultValue>
                <basePrice>$50.00</basePrice>
            </passengerType>
            <passengerType>
                <systemTypeId>12</systemTypeId>
                <systemTypeName>students</systemTypeName>
                <name>
                    <![CDATA[Students]]>
                </name>
                <defaultValue>0</defaultValue>
                <basePrice>$50.00</basePrice>
            </passengerType>
            <passengerType>
                <systemTypeId>13</systemTypeId>
                <systemTypeName>children</systemTypeName>
                <name>
                    <![CDATA[Children]]>
                </name>
                <defaultValue>0</defaultValue>
                <basePrice>$50.00</basePrice>
            </passengerType>
            <passengerType>
                <systemTypeId>14</systemTypeId>
                <systemTypeName>infants</systemTypeName>
                <name>
                    <![CDATA[Infants]]>
                </name>
                <defaultValue>0</defaultValue>
                <basePrice>$50.00</basePrice>
            </passengerType>
        </allowedPassengers>
    </methodResponse>
</response>
<request>
   <zapiToken></zapiToken>
   <zapiAccountId></zapiAccountId>
   <zapiUserId></zapiUserId>
   <zapiMethod>
      <methodName>zapiCheckActivityInventoryByDate</methodName>
      <activityId></activityId>
      <activityDate></activityDate>
      <activityTime></activityTime>
      <requestedPassengers>
         <seniors></seniors>
         <adults></adults>
         <students></students>
         <children></children>
         <infants></infants>
      </requestedPassengers>
   </zapiMethod>
</request>
<?xml version="1.0" encoding="utf-8"?>
<response>
	<zapiVersion></zapiVersion>
	<error></error>
	<message></message>
	<methodResponse>
		<methodName>zapiCheckActivityInventoryByDate</methodName>
		<activityId></activityId>
		<activityDate></activityDate>
		<activityName></activityName>
		<activityType></activityType>
		<totalRequestedPassengers></totalRequestedPassengers>
		<activityTimes>
			<activityTime>
				<activityTimeStart></activityTimeStart>
				<activityTimeAvailable></activityTimeAvailable>
				<activityTimeAvailableMessage/>
				<inventoryCheckCode></inventoryCheckCode>
				<inventoryCheckMessage></inventoryCheckMessage>
				<activityTimeSpotsRemaining></activityTimeSpotsRemaining>
			</activityTime>
		</activityTimes>
	</methodResponse>
</response> 
PreviousCreate CancellationNextSingle Activity Details

Last updated 3 years ago

Was this helpful?