# Response The AvailabilityResponse will indicate if there is sufficient space for the requested passenger mix as well as the total cost if the traveler proceeds to the checkout. {% tabs %} {% tab title="Example - Single Date Response" %} ```markup xxxxxxxxxxxxxxxxxxxxxxx 2005 200 1577121674745 SUCCESS ACT_1765 2020-10-31 09:00:00 Zipline Tour 09:00:00 AVAILABLE 100 $481,00 $3.00 $24.20> USD $24.20 $508.20 ``` {% endtab %} {% tab title="Example - Date Range Response" %} ```markup xxxxxxxxxxxxxxxxxxxxxxx 2005 200 1577121674745 SUCCESS ACT_1765 2020-10-30 09:00:00 Zipline Tour 09:00:00 AVAILABLE 100 $481.00 $3.00 $24.20> USD $24.20 $508.20 2020-10-31 09:00:00 Zipline Tour 09:00:00 UNAVAILABLE SOLD_OUT 0 $481.00 $3.00 $24.20> USD $24.20 $508.20 ``` {% endtab %} {% endtabs %} {% hint style="info" %} You must store in your database SupplierProductCode and at least 1 TourOptions value for inventory lookup. You will also want to cache locally the returned inventory. Relying solely on our API, with throttle rate limits, you may see error coddes 503 returned from our system. If you do, you have exceed the allowed API calls. Please refer to the ["Getting Started - API Throttle"](https://docs.zaui.com/io/getting-started/getting-started/api-throttle) section on how to gracefully handle 503 errors. [***Handling 503 errors and working with a API throttle***](https://docs.zaui.com/io/getting-started/getting-started/implementing-exponential-back-off) {% endhint %} ### Response Fields: | XML Node | Parent Node | Description | | --------------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `CheckAvailabilityResponse` | N/A | Root XML node | | `ApiKey` | `CheckAvailabilityResponse` | Your unique API key | | `ResellerId` | `CheckAvailabilityResponse` | Your unique reseller Id | | `SupplierId` | `CheckAvailabilityResponse` | String representing the unique supplier ID within the Zaui Marketplace | | `ExternalReference` | `CheckAvailabilityResponse` | String representing a unique transaction ID. Used to identify your original request | | `TimeStamp` | `CheckAvailabilityResponse` |

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` | `CheckAvailabilityResponse` | 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 | | `SupplierProductCode` | `CheckAvailabilityResponse` | Unique supplier product code | | `TourAvailability` | `CheckAvailabilityResponse` | Root node with the tour availability | | `Date` | `TourAvailability` | Date the tour is available on, in the format YYYY-MM-DD | | `TourOptions` | `TourAvailability` | Tour options root node | | `SupplierOptionCode` | `TourOptions` | String containing the unique supplier option code | | `SupplierOptionName` | `TourOptions` | String containing the supplier option name | | `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 travelers for this product (tour)/product option (tour option) is not met OR when the number of requested passengers cannot be fulfilled, but a lower number can. For example, Status.AvailabilityStatus for 3 people is Unavailable but Status.AvailabilityStatus for 2 is Available.

| | `RemainingInventory` | `AvailabilityStatus` | Number of spots remaining for the product | | `TourPricing` | `CheckAvailabilityResponse` | Root element for pricing data | | `Subtotal` | `TourPricing` | Formatted string with currency for sub-total based on the request | | `Fees` | `TourPricing` | Formatted string with currency for all fees | | `Tax` | `TourPricing` | Formatted string with currency for all taxes | | `Total` | `TourPricing` | Formatted string with currency for total cost if the booking was to be created | | `Currency` | `TourPricing` | The ISO currency code | | `TaxDetails` | `TourPricing` | Root Node | | `TaxDetail` | `TaxDetails` | Single Tax node | | `TaxName` | `TaxDetail` | The name of the tax applied | | `TaxAmount` | `TaxDetail` | The amount of the tax formatted | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.zaui.com/io/api-function-definitions/checking-availability/check-availability-response.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.