Create Cancellation

Create a cancellation for a specific activity for a single date or date range.

zapiActivity_CreateCancellation

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

Request Body

Name
Type
Description

activityId*

integer

ID of the activity.

methodName*

string

The method being called.

zapiToken*

integer

Token that must be used for a reseller to communicate with the supplier system.

applyToAllDaysOfTheWeek

string

True or False. Default value is True

cancellationStartTime*

integer

Start time of activity to cancel. For Interval activities, start time would need to include all timeslots to cancel. Format: HH:MM:SS.

cancellationStartDate*

integer

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

zapiAccountId*

integer

Generated by the supplier system.

daysOfWeek

string

True or False - Used to cancel only select days within a window.

cancellationEndDate*

integer

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

zapiUserId*

integer

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

cancellationEndTime*

integer

End time of activity to cancel. For Interval activities, end time would need to include all timeslots to cancel. Format: HH:MM:SS.

canceledOnlineOnly

string

True or False. Default value is False.

cancelWithBookings

string

True or False. Default value is False.

skipDaysWithBookings

string

True or False. Default value is True.

<?xml version="1.0" encoding="utf-8"?>
<response>
    <zapiVersion>2.1</zapiVersion>
    <error>0</error>
    <message>OK</message>
    <methodResponse>
        <methodName>zapiActivity_CreateCancellation</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[Cancellation(s) created]]>
        </methodErrorMessage>
    </methodResponse>
</response>
<request>
	<zapiToken></zapiToken>
	<zapiAccountId></zapiAccountId>
	<zapiUserId></zapiUserId>
	<zapiMethod>
		<methodName>zapiActivity_CreateCancellation</methodName>
		<activityId></activityId>
		<cancellationStartDate></cancellationStartDate>
		<cancellationEndDate></cancellationEndDate>
		<cancellationStartTime></cancellationStartTime>
		<cancellationEndTime></cancellationEndTime>
        	<daysOfWeek>
			<sunday></sunday>
			<monday></monday>
			<tuesday></tuesday>
			<wednesday></wednesday>
			<thursday></thursday>
			<friday></friday>
			<saturday></saturday>
		</daysOfWeek>
		<flags>
			<applyToAllDaysOfTheWeek></applyToAllDaysOfTheWeek>
			<canceledOnlineOnly></canceledOnlineOnly>
			<cancelWithBookings></cancelWithBookings>
			<skipDaysWithBookings></skipDaysWithBookings>
		</flags>
	</zapiMethod>
</request>
PreviousCancelled ActivitiesNextCheck Inventory

Last updated