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
  3. Rental Equipment Calls

Equipment Availability

Availability for a specific piece of equipment, equipment within a category or equipment used by the activity

zapi_GetEquipmentAvailability

GET https://{yourdomain}.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.

activityId*

integer

ID of the activity.

startDate*

integer

The start date of the rental activity. Format: YYYY:MM:DD.

startTime*

integer

The start time of the rental activity. Format: HH:MM:SS.

equipmentQuantity

integer

The number of pieces of equipment requested.

endDate*

integer

The end date of the rental activity. Format: YYYY:MM:DD.

endTime*

integer

The end time of the rental activity. Format: HH:MM:SS.

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapi_GetEquipmentAvailability</methodName>
        <methodErrorCode/>
        <methodErrorMessage/>
        <eventCount>##</eventCount>
        <startTime>YYYY-MM-DD HH:ii:ss</startTime>
        <endTime>YYYY-MM-DD HH:ii:ss</endTime>
        <rentalDuration>HH:ii:ss</rentalDuration>
        <requestTime>##.###############</requestTime>
        <activityName>XXXXXXX</activityName>
        <equipmentAvailable>
            <equipmentCategories>
                <equipmentCategory>
                    <equipmentCategoryId>###</equipmentCategoryId>
                    <equipmentCategoryName>XXXXXX</equipmentCategoryName>
                    <equipment>##</equipment>
                    ...
                </equipmentCategory>
                ...
            </equipmentCategories>
        </equipmentAvailable>
    </methodResponse>
</response>
<request>
   <zapiToken></zapiToken>
   <zapiAccountId></zapiAccountId>
   <zapiUserId></zapiUserId>
        <zapiMethod>
            <methodName>zapi_GetEquipmentAvailability</methodName>
            <activityId></activityId>
            <startDate></startDate>
            <startTime></startTime>
            <equipmentQuantity></equipmentQuantity>
            <endDate></endDate>
            <endTime></endTime>
        </zapiMethod>
</request>
<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapi_GetEquipmentAvailability</methodName>
        <methodErrorCode/>
        <methodErrorMessage/>
        <eventCount></eventCount>
        <startTime></startTime>
        <endTime></endTime>
        <rentalDuration></rentalDuration>
        <requestTime></requestTime>
        <activityName></activityName>
        <equipmentAvailable>
            <equipmentCategories>
                <equipmentCategory>
                    <equipmentCategoryId></equipmentCategoryId>
                    <equipmentCategoryName></equipmentCategoryName>
                    <equipment>
                        <equipment>
                            <id></id>
                            <name></name>
                        </equipment>
                    </equipment>
                </equipmentCategory>
                <equipmentCategory>
                    <equipmentCategoryId></equipmentCategoryId>
                    <equipmentCategoryName></equipmentCategoryName>
                    <equipment>
                        <equipment>
                            <id></id>
                            <name></name>
                        </equipment>
                    </equipment>
                </equipmentCategory>
                <equipmentCategory>
                    <equipmentCategoryId></equipmentCategoryId>
                    <equipmentCategoryName></equipmentCategoryName>
                    <equipment>
                        <equipment>
                            <id></id>
                            <name></name>
                        </equipment>
                        <equipment>
                            <id></id>
                            <name></name>
                        </equipment>
                    </equipment>
                </equipmentCategory>
            </equipmentCategories>
        </equipmentAvailable>
    </methodResponse>
</response>
PreviousEquipment Price QuoteNextCart Contents

Last updated 3 years ago

Was this helpful?