Response
Batch availability response
The below sample is the response provided by the supplier system for a batch availability request where the tour has multiple departure times. In this response, the product is sold out at certain times, therefore not available.
<?xml version="1.0" encoding="UTF-8"?>
<BatchCheckAvailabilityResponse xmlns="https://api.zaui.io/api/01">
<ApiKey>xxxxxxxxxxxxxxxxxxxxxxx</ApiKey>
<ResellerId>2005</ResellerId>
<SupplierId>200</SupplierId>
<ExternalReference>10051374722992616</ExternalReference>
<Timestamp>1577121674745</Timestamp>
<RequestStatus>
<Status>SUCCESS</Status>
</RequestStatus>
<BatchTourAvailability>
<Date>2020-10-01</Date>
<AvailabilityStatus>
<Status>UNAVAILABLE</Status>
<UnavailabilityReason>SOLD_OUT</UnavailabilityReason>
</AvailabilityStatus>
<SupplierProductCode>ACT_1765</SupplierProductCode>
<TourOptions>
<TourDepartureTime>09:00:00</TourDepartureTime>
</TourOptions>
</BatchTourAvailability>
<BatchTourAvailability>
<Date>2020-10-01</Date>
<AvailabilityStatus>
<Status>AVAILABLE</Status>
</AvailabilityStatus>
<SupplierProductCode>ACT_1765</SupplierProductCode>
<TourOptions>
<TourDepartureTime>10:00:00</TourDepartureTime>
</TourOptions>
</BatchTourAvailability>
</BatchCheckAvailabilityResponse>XML Node
Parent Node
Description
BatchCheckAvailabilityResponse
N/A
Root XML node
ApiKey
BatchCheckAvailabilityResponse
Your unique API key
ResellerId
BatchCheckAvailabilityResponse
Your unique reseller Id
SupplierId
BatchCheckAvailabilityResponse
String representing the unique supplier ID within the Zaui Marketplace
ExternalReference
BatchCheckAvailabilityResponse
String representing a unique transaction ID. Used to identify your original request
TimeStamp
BatchCheckAvailabilityResponse
Time of creation of request
• yyyy-MMddTHH:mm:ss.SSSZ(in UTC time)
or
• yyyy-MMddTHH:mm:ss.SSS[+/- ]hh:mm
Example:
2020-04- 28T13:10:12.123Z (UTC time)
2020-04- 28T13:10:12.123+10:00
RequestStatus
BatchCheckAvailabilityResponse
Request status root XML element
Status
RequestStatus
Status value for the request. Values are:
• Success
• Error
Error
RequestStatus
Root node for the error details on a non-successful request
ErrorCode
Error
String with the error code
ErrorMessage
Error
String with the error message
ErrorDetails
Error
String with additional details, and recommendation on the error
BatchTourAvailability
BatchCheckAvailabilityResponse
Root node with the tour availability
Date
TourAvailability
Date the tour is available on, in the format YYYY-MM-DD
SupplierProductCode
BatchCheckAvailabilityResponse
Unique supplier product code
TourOptions
TourAvailability
Tour options root node
TourDepartureTime
TourOptions
Time of the tour departure, in the format HH:MM:SS
AvailbilityStatus
CheckAvailabilityResponse
Root element for the availability status
Status
AvailabilityStatus
Status of the availability request. Values can be:
• Available - when available for the given date and traveller mix
• Unavailable - when not available for the given date and traveller mix
UnavailabilityReason
AvailabilityStatus
Reason why the requested activity is NOT available. Valid values:
• SOLD_OUT
• BLOCKED_OUT - when the product (tour)/product option (tour option) has been blocked out (not taking place on this date)
• INACTIVE - when the product (tour)/product option (tour option) is no longer active. Recommend to run an ActivityListRequest to refresh the supplier product codes to obtain the latest product (tour)/ product option (tour option) that is shared
• PAST_CUTOFF_DATE - when the booking cut-off date has been reached for this product (tour)/product option (tour option)
• TRAVELLER_MISMATCH - when the required combination of travellers for this product (tour)/product option (tour option) is not met
Last updated
Was this helpful?