powering tour and activity businesses worldwide

XML API – Request – Get Item Monthly Availability

in Tags: Developers

Description

The month query returns availability information for a specified tour. This query has one required argument in order to find specific month availability. There are two optional arguments that can provide access to all the items in the group and/or a date to indicate for which month to check availability.

Arguments

Parameter Value
key REZGO API KEY (Required)
transcode CID (Required)
i month(Required)

Required arguments:

Parameter Value
q sku – sku of tour option to search for

Optional arguments:

Parameter Value
g group {1} – if this is set to 1 then return all matching items/tour options in the same tour; else it will only return results for that tour option
d date {Y-m-d format} – if this is set then the search will be for the given month else it will search the current month
trigger_code a code used to apply/enable a rule

Field Definitions

Field Name Value
name full name of the tour
com sku/uid of primary tour
month the returned month in full text format
year the returned year in full text format
day node of availability for day of the month in the value attribute; the value attribute holds the availability for the day; the condition attribute determines the type of availability (refer to day node definition)

Day Node

Parameter Value
item availability information containing the name of the item – the value attribute holds the spot availability for the item; (number): number of spots available if 0 it is fully booked}
uid tour uid (aka sku)
name name of the tour

Day Node Availability conditions

Condition Value Definition
a available
i inactive item availability reduced to 0 without bookings;
u unavailable item is outside the availability window;
p past date date is in the past;
c cutoff the date is no longer available to be booked because it has passed the booking cutoff;
h hidden the availability for this item is hidden but there are still spots available

Example request

http://api.rezgo.com/xml?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=month&g=1&q=29438&d=2015-08-01

 

We would love your feedback