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

Cancelled Activities

Performs a fetch of a single cancelled activity or all cancelled activities by date.

zapiActivity_GetCancellations

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

Request Body

Name
Type
Description

zapiToken*

integerng

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.

cancellationStartDate*

integer

Start date of cancellation window. Format: YYYY-MM-DD

cancellationEndDate*

integer

End date of cancellation window. Format: YYYY-MM-DD

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiActivity_GetCancellations</methodName>
        <cancellations>
            <cancellation>
                <cancellationId>243</cancellationId>
                <activityId>80</activityId>
                <activityName>Canyon Icewalk </activityName>
                <cancellationStartDate>2022-04-21</cancellationStartDate>
                <cancellationEndDate>2022-04-21</cancellationEndDate>
                <cancellationStartTime>13:00:00</cancellationStartTime>
                <cancellationEndTime>17:00:00</cancellationEndTime>
                <daysOfWeek>
                    <sunday>true</sunday>
                    <monday>true</monday>
                    <tuesday>true</tuesday>
                    <wednesday>true</wednesday>
                    <thursday>true</thursday>
                    <friday>true</friday>
                    <saturday>true</saturday>
                </daysOfWeek>
            </cancellation>
        </cancellations>
        <methodErrorCode>0</methodErrorCode>
        <methodErrorMessage>
            <![CDATA[]]>
        </methodErrorMessage>
    </methodResponse>
</response>
<request>
	<zapiToken></zapiToken>
	<zapiAccountId></zapiAccountId>
	<zapiUserId></zapiUserId>
	<zapiMethod>
		<methodName>zapiActivity_GetCancellations</methodName>
		<activityId></activityId>
		<cancellationStartDate></cancellationStartDate>
		<cancellationEndDate></cancellationEndDate>
	</zapiMethod>
</request>
<?xml version="1.0" encoding="utf-8"?>
<response>
	<zapiVersion>2.1</zapiVersion>
	<error>0</error>
	<message>OK</message>
	<methodResponse>
		<methodName>zapiActivity_GetCancellations</methodName>
		<cancellations>
			<cancellation>
				<cancellationId></cancellationId>
				<activityId></activityId>
				<activityName></activityName>
				<cancellationStartDate></cancellationStartDate>
				<cancellationEndDate></cancellationEndDate>
				<cancelltionStartTime></cancelltionStartTime>
				<cancellationEndTime></cancellationEndTime>
				<daysOfWeek>
					<sunday></sunday>
					<monday></monday>
					<tuesday></tuesday>
					<wednesday></wednesday>
					<thursday></thursday>
					<friday></friday>
					<saturday></saturday>
				</daysOfWeek>
			</cancellation>
		</cancellations>
		<methodErrorCode>0</methodErrorCode>
		<methodErrorMessage></methodErrorMessage>
	</methodResponse>
</response> 
PreviousActivity Category by IDNextCreate Cancellation

Last updated 3 years ago

Was this helpful?