Request
Checking availability request
Example - Single Date Request
Example - Date Range Request
<CheckAvailabilityRequest>
xmlns="https://api.zaui.io/api/01">
<ApiKey>xxxxxxxxxxxxxxxxxxxxxxx</ApiKey>
<ResellerId>2005</ResellerId>
<SupplierId>200</SupplierId>
<Timestamp>1577121674745</Timestamp>
<StartDate>2020-10-31</StartDate>
<EndDate></EndDate>
<SupplierProductCode>ACT_1765</SupplierProductCode>
<TourOptions>
<SupplierOptionCode>09:00:00</SupplierOptionCode>
<SupplierOptionName>Zipline Tour</SupplierOptionName>
<TourDepartureTime>09:00:00</TourDepartureTime>
<TourDuration>PT1H</TourDuration>
</TourOptions>
<TravellerMix>
<Senior>0</Senior>
<Adult>1</Adult>
<Student>0</Student>
<Child>1</Child>
<Infant>0</Infant>
<Total>2</Total>
</TravellerMix>
</CheckAvailabilityRequest>
<CheckAvailabilityRequest>
xmlns="https://api.zaui.io/api/01">
<ApiKey>xxxxxxxxxxxxxxxxxxxxxxx</ApiKey>
<ResellerId>2005</ResellerId>
<SupplierId>200</SupplierId>
<Timestamp>1577121674745</Timestamp>
<StartDate>2020-10-30</StartDate>
<EndDate>2020-11-10</EndDate>
<SupplierProductCode>ACT_1801</SupplierProductCode>
<TourOptions>
<SupplierOptionCode>08:00:00</SupplierOptionCode>
</TourOptions>
<TravellerMix>
<Senior>0</Senior>
<Adult>1</Adult>
<Student>0</Student>
<Child>1</Child>
<Infant>0</Infant>
<Total>2</Total>
</TravellerMix>
<PickupLocation>
<SupplierPickupCode>23</SupplierPickupCode>
</PickupLocation>
<DropoffLocation>
<SupplierDropoffCode>45</SupplierDropoffCode>
</DropoffLocation>
</CheckAvailabilityRequest>
XML Node | Parent Node | Description | Optionality |
CheckAvailabilityRequest | N/A | Root XML node | Mandatory |
API Key | CheckAvailabilityRequest | Your Unique API Key | Mandatory |
ResellerId | CheckAvailabilityRequest | Your Unique Reseller Id | Mandatory |
SupplierId | CheckAvailabilityRequest | String representing the unique supplier ID within the Zaui Marketplace | Mandatory |
ExternalReference | CheckAvailabilityRequest | String representing a unique transaction ID. Used to identify your original request | Optional |
TimeStamp | CheckAvailabilityRequest | 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 | Mandatory |
StartDate | CheckAvailabilityRequest | Date for which to check. Date format: YYYY-MM-DD | Mandatory |
EndDate | CheckAvailabilityRequest | Date for which to end checking. Date format:
YYYY-MM-DD | Optional |
SupplierProductCode | CheckAvailabilityRequest | The unique product code for the supplier | Mandatory |
TourOptions | CheckAvailabilityRequest | Tour option root XML node | Optional |
SupplierOptionCode | TourOptions | String representing the unique supplier option code | Optional |
SupplierOptionName | TourOptions | String representing the supplier option name | Optional |
TourDepartureTime | TourOptions | Time of the activity de-parture; must be in the format of HH:MM:SS | Optional |
TourDuration | TourOptions | Option duration; must be in the format of PnYnMnDTnHnMnS | Optional |
TravellerMix | CheckAvailabilityRequest | Root XML element that contains the details of the passenger types to query for inventory | Mandatory |
Senior | TravellerMix | Number of seniors | Optional |
Adult | TravellerMix | Number of adults | Optional |
Student | TravellerMix | Number of students | Optional |
Child | TravellerMix | Number of children | Optional |
Infant | TravellerMix | Number of infants | Optional |
Total | TravellerMix | Total Travellers | Mandatory |
PickupLocation | CheckAvailabilityRequest | Root node for the pickup location | Optional, but required for transportation products |
SupplierPickupCode | PickupLocation | The supplier pickup location ID, which is returned as part of the ActivytListRequest | Optional, but required for transportation products |
DropoffLocation | CheckAvailabilityRequest | Root node for the dropoff location | Optional, but required for transportation products |
SupplierDropoffCode | SupplierDropoffCode | The supplier dropoff location ID, which is returned as part of the ActivytListRequest | Optional, but required for transportation products |
Last modified 2yr ago