API Specification Enhancements

New enhancements to the API will be added directly here.

Date of Change
ZAPI Call 
Description
May 2, 2018
​
Addition of real-time inventory numbers as part of the CheckAvailabil-ityResponse
May 1, 2018
​
Addition of dynamic pricing for CheckAvailabilityResponse
April 1, 2018
​
Addition of the SupplierProductTypeCode field as part of the Activity-ListRequest response
January 20, 2018
zapiPackage_DetermineMinimumDatesToBook
Deprecated the <staggerDates>
January 20, 2018
zapiPackage_SetActivity-ComponentDate
Guest Standby logic has been added to many API calls, standardization of the standby details, and extra logic to allow adding a guest to standby:
​
API REQUEST: 
<bookingId> (optional)
<addtoStandBy> (optional)
new logic to allow adding to standby when setting the component travel date
API RESPONSE:
<standBy>
<numberOnStandBy>
January 16, 2018
Booking - Search Results Node
Addition of 
guestId 
guestHashKey
December 13, 2017
​
Removal of the deltaOnly parameter on availability requests.
August 14, 2017
zapiPackage_DetermineMinimumDatesToBook
New fields were added to the return data on this API call, for the stand by, namely, the number of guests currently on standby, and if standby is available for a particular leg of journey.
<numberOnStandby/>
<isStandbyAvailable/>
March 20, 2017
zapiProcessSingleTransaction
For credit card payments, the addition of the XML item . If currencies are configured in your system, then the Cart Object will return, for each currency, a converted total including tax, for each currency. This currency ID, can then be passed along to the payment processing, to indicate the credit card amount is to be trans-acted with a specific (non-based currency) denomination, and the con-verted amount. Currencies can also be configured or a specific payment gateway.
August 26, 2016
zapiGetPackagesByCategoryId
zapiGetPackageDetailsByPackageId
zapiGetActivitiesByCategoryId
zapiGetActivityDetailsByActivityId
Addition of verboseMode flag to the following API calls, default value in all cases is true.
August 21, 2016
zapiGetActivityDetailsByActivityId, zapiAddActivityTo-Cart
Addition of supplierConfirmationNumberSystemManaged and sup-plierConfirmationNumberDisplayed fields indicating how remote supplier confirmation numbers are handled for each activity.
August 14, 2016
zapiBookings_CancelBooking
Addition of a new API call, allowing for cancellation of a booking within the system.
August 11, 2016
zapiPromoCodeApply
zapiGiftCertificateApply
Added as part of the returned payload on applying a promo code, the cart/order object.
August 3, 2016
zapiProcessSingleTransaction
Fixed misspelling of XML nodes.
August 1, 2016
zapiGetSystemInformation
Addition of airlines that are configured within the system.
July 29, 2016
zapiGetSystemInformation
Addition of the passengers configured as part of the overall system settings.
July 21, 2016
​
Remove Supplier Confirmation Number add as part of API calls where the system returns details of any single activity component, part of a booking, or an existing cart order. The field is called supplierConfirmationNumber, which describes the booking reservation number returned from a remote Zaui system, and is part of the Zaui to Zaui project.
July 21, 2016
zapiGetActivityDetailsByActivityId
Addition of new fields operatedByCompanyId and operatedByCompany-Name which describe the operating company for any given activity.
July 18, 2016
Activities Node
Addition of:
isFreeSell
ticketExpiry
ticketPrinterText
June 8, 2016
zapiGetActivitiesByCategoryId
Addition of: 
categoryName,
imageUrl 
description
June 2, 2016
zapiProcessCartWithPayment
zapiProcessSingleTransaction
Addition of the agent Id, that can be passed through for payment transactions that provision for the company ID and agent ID, such as vouchers (optional)
May 9, 2016
​
Addition of rental activity details as part of the returned search details
May 6, 2016
​
Updated the documentation and return data for any search result, specifically the data returned within a single booking, when calling any of the search routines on the API
Added in the section defining the standardized booking data returned as part of the search results.
Addition of transaction details as part of the returned data set for to search results (via booking number, last name, mobile phone) 
On all search results, added the agent details responsible for the booking, their name and company.
March 14, 2016
zapiAddProductToCart
For percentage based product, you can now indicate a linked activity or package, also added to that, for which to base the product price.
March 4, 2016
zapiPackage_DetermineMinimumDates-ToBook
New Call: This routine helps determine, based on a package, and seed date, if all components of the package are bookable.
February 23, 2016
zapiGetPackageDetailsByPackageId
New field: packageType – see package types appendix
New Appendix for package type descriptions 
New Appendix for product type descriptions 
New XML node that describes a single price code 
New XML node that describes the configuration for multi-day itinerary based packages
February 23, 2016
zapiPackage_RetrievePricingRates
Addition of a new API call which will return a complete XML description of all pricing components and details for a single package, regardless of sale or travel date.
February 22, 2016
zapiGuests_GetBookingDetails
Addition of onStandby, onWaitList, waitListId fields
February 22, 2016
zapiGetPackageDetailsByPackageId
Addition of optional seed package date when called
February 1, 2016
zapiGuests_UpdateProfile
Addition of updating a guests gender on the API

Date of Change	ZAPI Call	Description
May 2, 2018		Addition of real-time inventory numbers as part of the CheckAvailabil-ityResponse
May 1, 2018		Addition of dynamic pricing for CheckAvailabilityResponse
April 1, 2018		Addition of the SupplierProductTypeCode field as part of the Activity-ListRequest response
January 20, 2018	zapiPackage_DetermineMinimumDatesToBook	Deprecated the <staggerDates>
January 20, 2018	zapiPackage_SetActivity-ComponentDate	Guest Standby logic has been added to many API calls, standardization of the standby details, and extra logic to allow adding a guest to standby: API REQUEST: <bookingId> (optional) <addtoStandBy> (optional) new logic to allow adding to standby when setting the component travel date API RESPONSE: <standBy> <numberOnStandBy>
January 16, 2018	Booking - Search Results Node	Addition of guestId guestHashKey
December 13, 2017		Removal of the deltaOnly parameter on availability requests.
August 14, 2017	zapiPackage_DetermineMinimumDatesToBook	New fields were added to the return data on this API call, for the stand by, namely, the number of guests currently on standby, and if standby is available for a particular leg of journey. <numberOnStandby/> <isStandbyAvailable/>
March 20, 2017	zapiProcessSingleTransaction	For credit card payments, the addition of the XML item . If currencies are configured in your system, then the Cart Object will return, for each currency, a converted total including tax, for each currency. This currency ID, can then be passed along to the payment processing, to indicate the credit card amount is to be trans-acted with a specific (non-based currency) denomination, and the con-verted amount. Currencies can also be configured or a specific payment gateway.
August 26, 2016	zapiGetPackagesByCategoryId zapiGetPackageDetailsByPackageId zapiGetActivitiesByCategoryId zapiGetActivityDetailsByActivityId	Addition of verboseMode flag to the following API calls, default value in all cases is true.
August 21, 2016	zapiGetActivityDetailsByActivityId, zapiAddActivityTo-Cart	Addition of supplierConfirmationNumberSystemManaged and sup-plierConfirmationNumberDisplayed fields indicating how remote supplier confirmation numbers are handled for each activity.
August 14, 2016	zapiBookings_CancelBooking	Addition of a new API call, allowing for cancellation of a booking within the system.
August 11, 2016	zapiPromoCodeApply zapiGiftCertificateApply	Added as part of the returned payload on applying a promo code, the cart/order object.
August 3, 2016	zapiProcessSingleTransaction	Fixed misspelling of XML nodes.
August 1, 2016	zapiGetSystemInformation	Addition of airlines that are configured within the system.
July 29, 2016	zapiGetSystemInformation	Addition of the passengers configured as part of the overall system settings.
July 21, 2016		Remove Supplier Confirmation Number add as part of API calls where the system returns details of any single activity component, part of a booking, or an existing cart order. The field is called supplierConfirmationNumber, which describes the booking reservation number returned from a remote Zaui system, and is part of the Zaui to Zaui project.
July 21, 2016	zapiGetActivityDetailsByActivityId	Addition of new fields operatedByCompanyId and operatedByCompany-Name which describe the operating company for any given activity.
July 18, 2016	Activities Node	Addition of: isFreeSell ticketExpiry ticketPrinterText
June 8, 2016	zapiGetActivitiesByCategoryId	Addition of: categoryName, imageUrl description
June 2, 2016	zapiProcessCartWithPayment zapiProcessSingleTransaction	Addition of the agent Id, that can be passed through for payment transactions that provision for the company ID and agent ID, such as vouchers (optional)
May 9, 2016		Addition of rental activity details as part of the returned search details
May 6, 2016		Updated the documentation and return data for any search result, specifically the data returned within a single booking, when calling any of the search routines on the API Added in the section defining the standardized booking data returned as part of the search results. Addition of transaction details as part of the returned data set for to search results (via booking number, last name, mobile phone) On all search results, added the agent details responsible for the booking, their name and company.
March 14, 2016	zapiAddProductToCart	For percentage based product, you can now indicate a linked activity or package, also added to that, for which to base the product price.
March 4, 2016	zapiPackage_DetermineMinimumDates-ToBook	New Call: This routine helps determine, based on a package, and seed date, if all components of the package are bookable.
February 23, 2016	zapiGetPackageDetailsByPackageId	New field: packageType – see package types appendix New Appendix for package type descriptions New Appendix for product type descriptions New XML node that describes a single price code New XML node that describes the configuration for multi-day itinerary based packages
February 23, 2016	zapiPackage_RetrievePricingRates	Addition of a new API call which will return a complete XML description of all pricing components and details for a single package, regardless of sale or travel date.
February 22, 2016	zapiGuests_GetBookingDetails	Addition of onStandby, onWaitList, waitListId fields
February 22, 2016	zapiGetPackageDetailsByPackageId	Addition of optional seed package date when called
February 1, 2016	zapiGuests_UpdateProfile	Addition of updating a guests gender on the API

Getting Started - Previous

API Specification

Next - Getting Started

Glossary of Terms

Last modified 1yr ago