powering tour and activity businesses worldwide

API Documentation

Getting Started

Prerequisites

Use of the Rezgo API assumes that you have an understanding and knowledge of web programming, specifically how to interact with XML or JSON and APIs.  If you are unfamiliar with APIs or how to programmatically interact with XML or JSON, then we recommend you use the Rezgo white label or WordPress application.

Back To Top

Resources

The Rezgo API is used by the consumer facing (front-end) booking engine. The code for the front-end booking engine has been made open source and is available for you to use in your development project. If you are using WordPress, we also have a fully functional plugin that contains all the same features as the front-end booking engine. The Open source PHP parser also contains all the same functions but requires a bit more configuration and development experience to use. You can find them at:

WordPress Plugin

https://www.rezgo.com/rezgo-wordpress-plugin-version-2-0-beta/

Open Source Parser

https://github.com/Rezgo/rezgo-parser

Back To Top

Rate Limitations

Use of the Rezgo API is currently limited to 4000 requests per hour.  This should be more than sufficient for most use cases.  If you believe your account will require a higher rate limit, please contact support to request a limit increase for your account.

Back To Top

Using the API

Accessing the API

The Rezgo API is located at:

For XML

http://api.rezgo.com/xml?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=company

For JSON

http://api.rezgo.com/json?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=company

It can be queried with a standard HTTP Request. All gateway queries require a transcode, key, and an instruction.

Back To Top

Creating Your API Key

If you want to connect with the Rezgo API, you’ll need an API key.

1. Navigate to Settings > API Access in the main menu.

2. Click Create API Key.

This brings up the Create a New API Key window.

2014-09-30_23h39_26

If you intend to restrict your API key access to specific IP addresses, list them in the Permitted IP field (1).

If you want to restrict access to some sections of your Rezgo account, uncheck those sections in the Permissions list (2).

Click Create Key (3).

Back To Top

Edit API Keys

Once you’ve created an API key, you can still change the IPs that have permission to access it and the permissions it allows.

1. Navigate to Settings > API Access in the main menu.

2. Locate the API key you want to edit.

3. Click the edit button to the right of the key.

2014-09-30_01h55_27

4. Make adjustments to IPs or permissions.

2014-09-30_01h56_14

5. Click Save Key.

Back To Top

Delete API Keys

You can also delete API keys you no longer need:

1. Locate the API key you want to delete.

2. Click the trash button to the right of the key.

2014-09-30_01h55_27

3. Click OK to confirm that you want to delete the key.

Back To Top

Instructions

The following is a list of instructions that are available for the API:

i=company

Used to retrieve company information including company contact information, supported payment methods, terms and conditions, base currency, etc.

i=tags

Used to retrieve all tags associated with the Rezgo account.

i=pages

Used to retrieve the custom pages associated with the Rezgo account.  This includes the contact us page, terms, and about us pages.

i=search

Used to retrieve product details as well as date based availability.

i=month

Used to retrieve monthly availability for a specific product.

i=commit

Used to submit a booking to Rezgo.

i=search_bookings

Used to retrieve bookings that match specific search criteria, such as date, date range, email, name, etc.

i=adjustment

Used to add an inventory adjustment (negative or positive) to a specific option.

Back To Top

Company

Description

You can use the Rezgo API to request company information.  The company query returns information including name, address, contact information, terms, branding content, a list of pages, and more.

Back To Top

Arguments

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

Back To Top

Field Definitions

Field Name Description
company_name the name of the company
type company type, either supplier or vendor
domain company registered subdomain (eg. subdomain.rezgo.com)
primary_domain custom domain if set as primary
terms the terms and conditions supplied by the company (may be HTML-formatted)
address_1 first address field
address_2 second address field
city city
state_prov state/province
postal_code postal code
country country
phone phone number
fax fax number
tax_id tax id as entered by company
email primary e-mail address
map map node contains fields for lat, long, and zoom level.
lat latitude
lon longitute
zoom zoom level
email_1 deprecated (replaced with notifications)
email_2 deprecated (replaced with notifications)
email_3 deprecated (replaced with notifications)
account_type billing account type (i for invoice or cc for credit card)
currency_symbol currency symbol used by company
currency_separator symbol used as decimal point/indicator
currency_decimals number of trailing decimal places to display
currency_base the base currency used for all pricing
using_gateway indicates if the site is using a payment gateway
cards credit cards accepted by the company (eg. American Express MasterCard Visa)
payment_methods accepted payment methods (eg. Credit Cards PayPal Cheques)
payment payment node specifies available payment types
method description of accepted credit card type
paypal_email e-mail address to accept PayPal transfers (only if PayPal is selected as a payment method) – only applicable for suppliers
get_cvv 1 = get cvv, 0 = do not get cvv. active only when company uses a payment gateway.
date_format date display format (eg. M d Y)
time_format time zone difference from GMT (eg. +20 -8 +4)
header html of the website template that appears before the Rezgo content
footer html of the website template that appears after the Rezgo content
styles custom stylesheet
pages list of pages including default and custom pages
path the path of the page (used when requesting the specific page using the page instruction)
title the title of the page (used only for custom pages)
site_status 1 = enabled, 0 = disabled
social node for social network credentials
twitter twitter name
cart 1 = on, 0 = off (used for determining if the shopping card should be used)
trigger Indicates whether there are active trigger (promotional) codes. 1 = yes, 0 = no
analytics_general general analytics code entered in settings
v version of the xml api
gt time required to generate the response (for SLA purposes)

Back To Top

Example Request

The following is an example request for company information for the Rezgo account with CID 1446.

For XML

http://api.rezgo.com/xml?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=company

For JSON

http://api.rezgo.com/json?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=company

Back To Top

Example Response

The following is an example response for the Rezgo account with CID 1446.

Example XML Response

 
<?xml version="1.0" encoding="UTF-8"?>
<response>
 <company_name><![CDATA[Adventure Tours]]></company_name>
 <type>supplier</type>
 <domain>adventuredemo</domain>
 <primary_domain>booking.adventuredemo.com</primary_domain>
 <terms><![CDATA[ TERMS AND CONDITIONS CONTENT APPEARS HERE ]]></terms>
 <address_1><![CDATA[718-333 Brooksbank Avenue]]></address_1>
 <address_2><![CDATA[]]></address_2>
 <city><![CDATA[North Vancouver]]></city>
 <state_prov><![CDATA[BC]]></state_prov>
 <postal_code>V7J 3V8</postal_code>
 <country>ca</country>
 <phone>604-983-0083</phone>
 <fax></fax>
 <tax_id>GST# 123456789</tax_id>
 <email>adventuredemo@example.com</email>
 <map>
 <lat>49.30976479725757</lat>
 <lon>-123.04024457931519</lon>
 <zoom>18</zoom>
 </map>
 <email_1></email_1>
 <email_2></email_2>
 <email_3></email_3>
 <account_type>i</account_type>
 <currency_symbol>US $</currency_symbol>
 <currency_separator>,</currency_separator>
 <currency_decimals>2</currency_decimals>
 <currency_base> USD</currency_base>
 <using_gateway>0</using_gateway>
 <cards><![CDATA[Visa, MasterCard]]></cards>
 <payment_methods><![CDATA[Credit Cards, Cash]]></payment_methods>
 <payment>
 <method add="0"><![CDATA[Credit Cards]]></method><method add="0"><![CDATA[Cash]]></method>
 </payment>
 <paypal_email></paypal_email>
 <get_cvv>0</get_cvv>
 <date_format>d M Y</date_format>
 <time_format>+0</time_format>
 <start_week>mon</start_week>
 <header><![CDATA[ HTML HEADER CONTENT APPEARS HERE ]]header>
 <footer><![CDATA[ HTML FOOTER CONTENT APPEARS HERE ]]</footer>
 <styles><![CDATA[ CUSTOM STYLESHEET DECLARATIONS APPEAR HERE ]]></styles>
 <pages></pages>
 <site_status>1</site_status>
 <social>
 <twitter_name>rezgo</twitter_name>
 </social>
 <cart>1</cart>
 <trigger>1</trigger>
 <analytics_general><![CDATA[ GENERAL ANALYTICS CODE APPEARS HERE ]]></analytics_general>
 <v>latest</v>
 <gt>0.03626</gt>
</response>

Example JSON Response

{
 "company_name": "Adventure Tours",
 "type": "supplier",
 "domain": "adventuredemo",
 "primary_domain": "booking.adventuredemo.com",
 "terms": " TERMS AND CONDITIONS CONTENT APPEARS HERE ",
 "address_1": "718-333 Brooksbank Avenue",
 "address_2": {},
 "city": "North Vancouver",
 "state_prov": "BC",
 "postal_code": "V7J 3V8",
 "country": "ca",
 "phone": "604-983-0083",
 "fax": {},
 "tax_id": "GST# 123456789",
 "email": "adventuredemo@example.com",
 "map": {
 "lat": "49.30976479725757",
 "lon": "-123.04024457931519",
 "zoom": "18"
 },
 "email_1": {},
 "email_2": {},
 "email_3": {},
 "account_type": "i",
 "currency_symbol": "US $",
 "currency_separator": ",",
 "currency_decimals": "2",
 "currency_base": " USD",
 "using_gateway": "0",
 "cards": "Visa, MasterCard",
 "payment_methods": "Credit Cards, Cash",
 "payment": {
 "method": [
 "Credit Cards",
 "Cash"
 ]
 },
 "paypal_email": {},
 "get_cvv": "0",
 "date_format": "d M Y",
 "time_format": "+0",
 "start_week": "mon",
 "header": " HTML HEADER CONTENT APPEARS HERE ",
 "footer": " HTML FOOTER CONTENT APPEARS HERE ",
 "styles": " CUSTOM STYLESHEET CONTENT APPEARS HERE ",
 "pages": {},
 "site_status": "1",
 "social": {
 "twitter_name": "rezgo"
 },
 "cart": "1",
 "trigger": "1",
 "analytics_general": {},
 "v": "latest",
 "gt": "0.02877"
}

                                

Back To Top

Tags

Description

You can use the Rezgo API to request tags used to classify inventory.  The tags query returns each tag node along with elements for the tags name, uid, and the number of inventory items associated with the tag.

Back To Top

Arguments

Parameter Value Type Required
transcode CID INTEGER X
key REZGO API KEY VARCHAR X
i tags VARCHAR X

Back To Top

Field Definitions

Field Name Description
total total number of tags returned
tag tag node specifies tag details
name tag name (can contain spaces)
uid URL friendly unique tag identifier
count number of inventory items associated with the tag
v version of the api
gt time required to generate the response (for SLA purposes)

Back To Top

Example Request

The following is an example request for tags for the Rezgo account with CID 1446.

For XML

http://api.rezgo.com/xml?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=tags

For JSON

http://api.rezgo.com/json?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=tags

Back To Top

Example Response

The following is an example response for the Rezgo account with CID 1446.

Example XML Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
<total>2</total>
<tag>
<num>1</num>
<name>activity</name>
<uid>activity</uid>
<count>2</count>
</tag>
<tag>
<num>2</num>
<name>adventure</name>
<uid>adventure</uid>
<count>2</count>
</tag>
<v>latest</v>
<gt>0.02255</gt>
</response>

Example JSON Response

{
    "total": "2",
    "tag": [
        {
            "num": "1",
            "name": "activity",
            "uid": "activity",
            "count": "2"
        },
        {
            "num": "2",
            "name": "adventure",
            "uid": "adventure",
            "count": "2"
        }
    ],
    "v": "latest",
    "gt": "0.02808"
}

Back To Top

Page

Description

You can use the Rezgo API to request the content of a specific page. The page query returns the HTML content of a specific page.

Back To Top

Arguments

Parameter Value Type Required
transcode CID INTEGER X
key REZGO API KEY VARCHAR X
i page VARCHAR X
q uid of page being requested VARCHAR X

Back To Top

Field Definitions

Field Name Description
name page name
content HTML page content
v version of the api
gt time required to generate the response (for SLA purposes)

Back To Top

Example Request

The following is an example request for company information for the Rezgo account with CID 1446.

For XML

http://api.rezgo.com/xml?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=page&q=contact

For JSON

http://api.rezgo.com/json?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=page&q=contact

Back To Top

Example Response

The following is an example response for a contact page request for Rezgo account with CID 1446.

Example XML Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
 <name><![CDATA[ PAGE NAME APPEARS HERE ]]></name>
 <content><![CDATA[ HTML PAGE CONTENT APPEARS HERE ]]></content>
 <v>latest</v>
 <gt>0.02169</gt>
</response>

Example JSON Response

{
 "name": {},
 "content": " HTML PAGE CONTENT APPEARS HERE ",
 "v": "latest",
 "gt": "0.02358"
}

 

Back To Top

Search

Description

You can use the Rezgo API to search for inventory as well as query for availability.  The search query returns details of the matching inventory results.  If a date is sent with the query, availability details are returned with the response.

Back To Top

Arguments

Parameter Value Type Required
transcode CID INTEGER X
key REZGO API KEY VARCHAR X
i search VARCHAR X

Optional Parameters

Parameter Value Type
t search target (smart com name uid tag) – the search target “smart” will search the entire record (be careful as this search may result in longer search times) VARCHAR
q query (the search string may contain * wildcards) VARCHAR
d date {Y-m-d format} – search for tours that are available on this date – can be a comma separated start date and end date. DATE

Back To Top

Field Definitions

Field Name Value
total total number of found tours
item an item node of matched tours
num position of the item node in the item array
uid unique numerical item ID
com common ID that groups tour options together
item tour name
option option name
code custom tour code
updated unix time stamp (last updated)
tags comma separated list of tags
starting submitted starting price for tour
group require group/passenger information {request; require; hide} – request: optional; require: required; hide: do not show
per minimum number of people required for booking to be allowed
cutoff minimum number of days in advance that booking must be made
duration text description of duration of the tour
date_selection how dates are selected, always, single_date, date_range
date node of prices for the day in the value attribute(in Y-m-d format) – refer to date node definition; only returned if there is availability for the given date
active indicates whether the date is active or not (1 or 0)
availability total number of available spots for this tour on that day
price_adult cost for adult price option
price_child cost for child price option
price_senior cost for senior price option
price4 – price9 cost for (price4 – price9) price option
adult_label label for adult price option; only returned if date is specified
child_label label for child price option; only returned if date is specified
senior_labe label for senior price option; only returned if date is specified
price4_label – price9_label label for (price4 – price9) price option; only returned if date is specified
adult_required flag to indicate if adult price option is required (0 or 1); only returned if date is specified
child_required flag to indicate if child price option is required (0 or 1); only returned if date is specified
senior_required flag to indicate if senior price option is required (0 or 1); only returned if date is specified
price4_required – price9_required flag to indicate if (price4 – price9) price option is required (0 or 1); only returned if date is specified
currency_symbol currency symbol used by company (eg. $ £ € ¥)
currency_separator symbol used as decimal point/indicator
currency_decimals number of trailing decimal places to display
currency_base the base currency that the company uses – this is for use in portals
location name name of the location
location address address of the location
city location of tour – city
state location of tour – state
country location of tour – country
lat geotag latitude
lon geotag longitude
zoom geotag map zoom level
start_date UNIX timestamp of tour start date
end_date UNIX timestamp of tour end date
line_items node of line items associated with this option
label name of this line item (e.g. Sales Tax, Booking Fee)
amount amount of line item in base currency
percent percent of line item (if no amount declared)
multi flag to indicate that this line item is charged per person (0 or 1)
tax flag to indicate if line item is a tax (0 or 1)
total_adult the total cost sum of adult price option; only returned if date is specified
total_child the total cost sum of child price option; only returned if date is specified
total_senior the total cost sum of senior price option; only returned if date is specified
total_price4 – total_price9 the total cost of (price4 – price9) price option; only returned if date is specified
sub_total calculated sub-total
taxes calculated tax value (returned with a value when passenger info has been passed)
tax_calc calculated tax value (returned with a value when passenger info has been passed)
overall_total the total cost of the booking (only returned when passenger info has been passed); only returned if date is specified
deposit deposit amount required upon booking discrete value or percentage or amount required to be paid as deposit upon booking; only returned if date is specified
deposit_value currently not used
total_availability total number of available spots for this tour on that day; only returned if date is specified
group_forms node of forms given during booking – refer to group forms node definition; only returned if date is specified
id unique numerical form ID
type forms type of input
title title of the form
instructions the instructions associated with the field
require flag to indicate if form is required to be filled (0 or 1)
options for type select, these are the options available with this field
price price of the option (either added or subtracted for enabling this option) – only enabled for checkbox forms
primary_forms node of forms given during booking – refer to primary forms node definition; only returned if date is specified
id unique numerical form ID
type forms type of input
title title of the form
instructions the instructions associated with the field
require flag to indicate if form is required to be filled (0 or 1)
options for type select, these are the options available with this field
price price of the option (either added or subtracted for enabling this option) – only enabled for checkbox forms
details node of detailed info – refer to details node definition
overview text – overview (HTML-formatted)
itinerary text – itinerary (HTML-formatted)
pick_up text – pick-up and departure info
drop_off text – drop-off and return info
bring text – things to bring info
inclusions text – inclusion info
exclusions text – exclusion info
cancellation text – cancellation info
description_name text – name of the customizable additional info field
description text – description of item (HTML-formatted)
specifications node of customized inventory layout fields – these are fields created by the account holder to share additional information about the inventory item
name name of the custom inventory field
value value of the custom inventory field
seo node of seo info
title seo page title for inventory item (used as page title if declared)
introduction meta description for inventory item
related node of related inventory items
item node of individual related item
com SKU of the inventory item (not option level SKU)
name name of the inventory item
media node of images – number of results found included in the value attribute
path absolute path of the image
caption the text caption associated with the image
 cid  unique numerical ID to identify the company that supplies this item
 v  version of the API being used
 gt  time to generate the result (used for SLA purposes)

Back To Top

Example Request – Tag Search

Example 1: The request is for inventory search where the target is “tag” and the tag value is “nature”.

For XML

http://api.rezgo.com/xml?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=search&t=tag&q=nature

For JSON

http://api.rezgo.com/json?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=search&t=tag&q=nature

Back To Top

Example Response – Tag Search

The following is an example response for the Rezgo account with CID 1446.

Example XML Response

<?xml version="1.0" encoding="UTF-8"?>
<response>

<total>1</total>

<item>
 <num>1</num>
 <uid>72547</uid>
 <com>29438</com>
 <item><![CDATA[Family River Rafting]]></item>
 <option><![CDATA[8:00 am]]></option>
 <code><![CDATA[12345]]></code>
 <start_date>11</start_date>
 <end_date>1767168000</end_date>
 <time>8:00 AM</time>
 <updated>1469040498</updated>
 <tags>adventure,activity,water,rafting,nature</tags>
 <starting>129.00</starting>
 <group>request_name</group>
 <per></per>
 <cutoff>2</cutoff>
 <duration><![CDATA[5 hours]]></duration>
 <date_selection>always</date_selection>
 <block_size>5</block_size>
 <spaces>0</spaces>
 <currency_symbol>US $</currency_symbol>
 <currency_separator>,</currency_separator>
 <currency_decimals>2</currency_decimals>
 <currency_base>USD</currency_base>
 <location_name><![CDATA[Meeting Point is under 6th Street]]></location_name>
 <location_address><![CDATA[966 SW 6th St, Grants Pass, OR 97526, USA]]></location_address>
 <city><![CDATA[Grants Pass]]></city>
 <state><![CDATA[OR]]></state>
 <country><![CDATA[US]]></country>
 <lat>42.43179</lat>
 <lon>-123.332</lon>
 <zoom>14</zoom>
 <map_type>ROADMAP</map_type>
 <line_items>
 <line_item>
 <label><![CDATA[GST]]></label>
 <amount>0</amount>
 <percent>5</percent>
 <multi></multi>
 <tax>1</tax>
 </line_item>
 <line_item>
 <label><![CDATA[PST]]></label>
 <amount>0</amount>
 <percent>7.5</percent>
 <multi></multi>
 <tax>1</tax>
 </line_item>
 <line_item>
 <label><![CDATA[Land Use Fee]]></label>
 <amount>0</amount>
 <percent></percent>
 <multi>5.00</multi>
 <tax></tax>
 </line_item>
 <line_item>
 <label><![CDATA[Booking Fee]]></label>
 <amount>0</amount>
 <percent>5</percent>
 <multi></multi>
 <tax></tax>
 </line_item>
 </line_items>
 <details>
 <overview><![CDATA[ OVERVIEW CONTENT APPEARS HERE ]]></overview>
 <highlights><![CDATA[ HIGHLIGHTS CONTENT APPEARS HERE ]]></highlights>
 <itinerary><![CDATA[ ITINERARY CONTENT APPEARS HERE]]></itinerary>
 <pick_up><![CDATA[ PICK-UP CONTENT APPEARS HERE ]]></pick_up>
 <drop_off><![CDATA[ DROP OFF CONTENT APPEARS HERE ]]></drop_off>
 <bring><![CDATA[ THINGS TO BRING CONTENT APPEARS HERE ]]></bring>
 <inclusions><![CDATA[ INCLUSIONS CONTENT APPEARS HERE ]]></inclusions>
 <exclusions><![CDATA[ EXCLUSIONS CONTENT APPEARS HERE ]]></exclusions>
 <cancellation><![CDATA[ CANCELLATION CONTENT APPEARS HERE ]]></cancellation>
 <description_name><![CDATA[This is my custom field]]></description_name>
 <description><![CDATA[ CUSTOM CONTENT APPEARS HERE ]]></description>
 <specifications> 
 <specification> 
 <name><![CDATA[Product Type]]></name> 
 <value><![CDATA[Lessons]]></value> 
 </specification> 
 <specification> 
 <name><![CDATA[Hike Level]]></name> 
 <value><![CDATA[Easy]]></value> 
 </specification> 
 </specifications>
 </details>
 <seo>
 <seo_title><![CDATA[ SEO TITLE APPEARS HERE ]]></seo_title>
 <introduction><![CDATA[ META DESCRIPTION CONTENT APPEARS HERE ]]></introduction>
 </seo>
 <related value="2">
 <item>
 <com>79309</com>
 <name><![CDATA[Whitewater Adventure]]></name>
 </item>
 <item>
 <com>79634</com>
 <name><![CDATA[London Pub Crawl]]></name>
 </item>
 </related>
 <media value="3">
 <image>
 <path>https://s3.amazonaws.com/rezgo/1446/29438/68741.jpg</path>
 <caption><![CDATA[]]></caption>
 </image>
 <image>
 <path>https://s3.amazonaws.com/rezgo/1446/29438/68739.jpg</path>
 <caption><![CDATA[]]></caption>
 </image>
 <image>
 <path>https://s3.amazonaws.com/rezgo/1446/29438/68740.jpg</path>
 <caption><![CDATA[]]></caption>
 </image>
 </media>
 <cid>1446</cid>
</item>
<v>latest</v>
<gt>0.05382</gt>
</response>

Example JSON Response

{
 "total": "8",
 "item": [
 {
 "num": "1",
 "uid": "72547",
 "com": "29438",
 "item": "Family River Rafting",
 "option": "8:00 am",
 "code": "12345",
 "start_date": "11",
 "end_date": "1767168000",
 "time": "8:00 AM",
 "updated": "1469040498",
 "tags": "adventure,activity,water,rafting,nature",
 "starting": "129.00",
 "group": "request_name",
 "per": {},
 "cutoff": "2",
 "duration": "5 hours",
 "date_selection": "always",
 "block_size": "5",
 "spaces": "0",
 "currency_symbol": "US $",
 "currency_separator": ",",
 "currency_decimals": "2",
 "currency_base": "USD",
 "location_name": "Meeting Point is under 6th Street",
 "location_address": "966 SW 6th St, Grants Pass, OR 97526, USA",
 "city": "Grants Pass",
 "state": "OR",
 "country": "US",
 "lat": "42.43179",
 "lon": "-123.332",
 "zoom": "14",
 "map_type": "ROADMAP",
 "line_items": {
 "line_item": [
 {
 "label": "GST",
 "amount": "0",
 "percent": "5",
 "multi": {},
 "tax": "1"
 },
 {
 "label": "PST",
 "amount": "0",
 "percent": "7.5",
 "multi": {},
 "tax": "1"
 },
 {
 "label": "Land Use Fee",
 "amount": "0",
 "percent": {},
 "multi": "5.00",
 "tax": {}
 },
 {
 "label": "Booking Fee",
 "amount": "0",
 "percent": "5",
 "multi": {},
 "tax": {}
 }
 ]
 },
 "details": {
 "overview": " OVERVIEW CONTENT APPEARS HERE ",
 "highlights": " HIGHLIGHTS CONTENT APPEARS HERE ",
 "itinerary": " ITINERARY CONTENT APPEARS HERE ",
 "pick_up": " PICK UP CONTENT APPEARS HERE ",
 "drop_off": " DROP OFF CONTENT APPEARS HERE ",
 "bring": " THINGS TO BRING CONTENT APPEARS HERE ",
 "inclusions": " INCLUSIONS CONTENT APPEARS HERE ",
 "exclusions": " EXCLUSIONS CONTENT APPEARS HERE ",
 "cancellation": " CANCELLATION CONTENT APPEARS HERE ",
 "description_name": "This is my custom field",
 "description": " CUSTOM CONTENT APPEARS HERE ",
 "specifications": {
 "specification": [
 {
 "name": "Product Type",
 "value": "Lessons"
 },
 {
 "name": "Hike Level",
 "value": "Easy"
 }
 ]
 }
 },
 "seo": {
 "seo_title": " SEO TITLE CONTENT APPEARS HERE ",
 "introduction": " META DESCRIPTION APPEARS HERE "
 },
 "related": {
 "@attributes": {
 "value": "2"
 },
 "item": [
 {
 "com": "79309",
 "name": "Whitewater Adventure"
 },
 {
 "com": "79634",
 "name": "London Pub Crawl"
 }
 ]
 },
 "media": {
 "@attributes": {
 "value": "3"
 },
 "image": [
 {
 "path": "https:\/\/s3.amazonaws.com\/rezgo\/1446\/29438\/68741.jpg",
 "caption": {}
 },
 {
 "path": "https:\/\/s3.amazonaws.com\/rezgo\/1446\/29438\/68739.jpg",
 "caption": {}
 },
 {
 "path": "https:\/\/s3.amazonaws.com\/rezgo\/1446\/29438\/68740.jpg",
 "caption": {}
 }
 ]
 },
 "cid": "1446"
 }
 ],
 "v": "latest",
 "gt": "0.04145"
}

Back To Top

Example Request – Smart Search

Example 1: The request is for inventory search where the target is “smart” and the tag value is “nature”.

For XML

http://api.rezgo.com/xml?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=search&t=smart&q=nature

For JSON

http://api.rezgo.com/json?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=search&t=smart&q=nature

Back To Top

Example Response – Smart Search

The following is an example response for the Rezgo account with CID 1446.

Example XML Response

<?xml version="1.0" encoding="UTF-8"?>
<response>

<total>1</total>

<item>
 <num>1</num>
 <uid>72547</uid>
 <com>29438</com>
 <item><![CDATA[Family River Rafting]]></item>
 <option><![CDATA[8:00 am]]></option>
 <code><![CDATA[12345]]></code>
 <start_date>11</start_date>
 <end_date>1767168000</end_date>
 <time>8:00 AM</time>
 <updated>1469040498</updated>
 <tags>adventure,activity,water,rafting,nature</tags>
 <starting>129.00</starting>
 <group>request_name</group>
 <per></per>
 <cutoff>2</cutoff>
 <duration><![CDATA[5 hours]]></duration>
 <date_selection>always</date_selection>
 <block_size>5</block_size>
 <spaces>0</spaces>
 <currency_symbol>US $</currency_symbol>
 <currency_separator>,</currency_separator>
 <currency_decimals>2</currency_decimals>
 <currency_base>USD</currency_base>
 <location_name><![CDATA[Meeting Point is under 6th Street]]></location_name>
 <location_address><![CDATA[966 SW 6th St, Grants Pass, OR 97526, USA]]></location_address>
 <city><![CDATA[Grants Pass]]></city>
 <state><![CDATA[OR]]></state>
 <country><![CDATA[US]]></country>
 <lat>42.43179</lat>
 <lon>-123.332</lon>
 <zoom>14</zoom>
 <map_type>ROADMAP</map_type>
 <line_items>
 <line_item>
 <label><![CDATA[GST]]></label>
 <amount>0</amount>
 <percent>5</percent>
 <multi></multi>
 <tax>1</tax>
 </line_item>
 <line_item>
 <label><![CDATA[PST]]></label>
 <amount>0</amount>
 <percent>7.5</percent>
 <multi></multi>
 <tax>1</tax>
 </line_item>
 <line_item>
 <label><![CDATA[Land Use Fee]]></label>
 <amount>0</amount>
 <percent></percent>
 <multi>5.00</multi>
 <tax></tax>
 </line_item>
 <line_item>
 <label><![CDATA[Booking Fee]]></label>
 <amount>0</amount>
 <percent>5</percent>
 <multi></multi>
 <tax></tax>
 </line_item>
 </line_items>
 <details>
 <overview><![CDATA[ OVERVIEW CONTENT APPEARS HERE ]]></overview>
 <highlights><![CDATA[ HIGHLIGHTS CONTENT APPEARS HERE ]]></highlights>
 <itinerary><![CDATA[ ITINERARY CONTENT APPEARS HERE]]></itinerary>
 <pick_up><![CDATA[ PICK-UP CONTENT APPEARS HERE ]]></pick_up>
 <drop_off><![CDATA[ DROP OFF CONTENT APPEARS HERE ]]></drop_off>
 <bring><![CDATA[ THINGS TO BRING CONTENT APPEARS HERE ]]></bring>
 <inclusions><![CDATA[ INCLUSIONS CONTENT APPEARS HERE ]]></inclusions>
 <exclusions><![CDATA[ EXCLUSIONS CONTENT APPEARS HERE ]]></exclusions>
 <cancellation><![CDATA[ CANCELLATION CONTENT APPEARS HERE ]]></cancellation>
 <description_name><![CDATA[This is my custom field]]></description_name>
 <description><![CDATA[ CUSTOM CONTENT APPEARS HERE ]]></description>
 <specifications> 
 <specification> 
 <name><![CDATA[Product Type]]></name> 
 <value><![CDATA[Lessons]]></value> 
 </specification> 
 <specification> 
 <name><![CDATA[Hike Level]]></name> 
 <value><![CDATA[Easy]]></value> 
 </specification> 
 </specifications>
 </details>
 <seo>
 <seo_title><![CDATA[ SEO TITLE APPEARS HERE ]]></seo_title>
 <introduction><![CDATA[ META DESCRIPTION CONTENT APPEARS HERE ]]></introduction>
 </seo>
 <related value="2">
 <item>
 <com>79309</com>
 <name><![CDATA[Whitewater Adventure]]></name>
 </item>
 <item>
 <com>79634</com>
 <name><![CDATA[London Pub Crawl]]></name>
 </item>
 </related>
 <media value="3">
 <image>
 <path>https://s3.amazonaws.com/rezgo/1446/29438/68741.jpg</path>
 <caption><![CDATA[]]></caption>
 </image>
 <image>
 <path>https://s3.amazonaws.com/rezgo/1446/29438/68739.jpg</path>
 <caption><![CDATA[]]></caption>
 </image>
 <image>
 <path>https://s3.amazonaws.com/rezgo/1446/29438/68740.jpg</path>
 <caption><![CDATA[]]></caption>
 </image>
 </media>
 <cid>1446</cid>
</item>
<v>latest</v>
<gt>0.05382</gt>
</response>

Example JSON Response

{
 "total": "8",
 "item": [
 {
 "num": "1",
 "uid": "72547",
 "com": "29438",
 "item": "Family River Rafting",
 "option": "8:00 am",
 "code": "12345",
 "start_date": "11",
 "end_date": "1767168000",
 "time": "8:00 AM",
 "updated": "1469040498",
 "tags": "adventure,activity,water,rafting,nature",
 "starting": "129.00",
 "group": "request_name",
 "per": {},
 "cutoff": "2",
 "duration": "5 hours",
 "date_selection": "always",
 "block_size": "5",
 "spaces": "0",
 "currency_symbol": "US $",
 "currency_separator": ",",
 "currency_decimals": "2",
 "currency_base": "USD",
 "location_name": "Meeting Point is under 6th Street",
 "location_address": "966 SW 6th St, Grants Pass, OR 97526, USA",
 "city": "Grants Pass",
 "state": "OR",
 "country": "US",
 "lat": "42.43179",
 "lon": "-123.332",
 "zoom": "14",
 "map_type": "ROADMAP",
 "line_items": {
 "line_item": [
 {
 "label": "GST",
 "amount": "0",
 "percent": "5",
 "multi": {},
 "tax": "1"
 },
 {
 "label": "PST",
 "amount": "0",
 "percent": "7.5",
 "multi": {},
 "tax": "1"
 },
 {
 "label": "Land Use Fee",
 "amount": "0",
 "percent": {},
 "multi": "5.00",
 "tax": {}
 },
 {
 "label": "Booking Fee",
 "amount": "0",
 "percent": "5",
 "multi": {},
 "tax": {}
 }
 ]
 },
 "details": {
 "overview": " OVERVIEW CONTENT APPEARS HERE ",
 "highlights": " HIGHLIGHTS CONTENT APPEARS HERE ",
 "itinerary": " ITINERARY CONTENT APPEARS HERE ",
 "pick_up": " PICK UP CONTENT APPEARS HERE ",
 "drop_off": " DROP OFF CONTENT APPEARS HERE ",
 "bring": " THINGS TO BRING CONTENT APPEARS HERE ",
 "inclusions": " INCLUSIONS CONTENT APPEARS HERE ",
 "exclusions": " EXCLUSIONS CONTENT APPEARS HERE ",
 "cancellation": " CANCELLATION CONTENT APPEARS HERE ",
 "description_name": "This is my custom field",
 "description": " CUSTOM CONTENT APPEARS HERE ",
 "specifications": {
 "specification": [
 {
 "name": "Product Type",
 "value": "Lessons"
 },
 {
 "name": "Hike Level",
 "value": "Easy"
 }
 ]
 }
 },
 "seo": {
 "seo_title": " SEO TITLE CONTENT APPEARS HERE ",
 "introduction": " META DESCRIPTION APPEARS HERE "
 },
 "related": {
 "@attributes": {
 "value": "2"
 },
 "item": [
 {
 "com": "79309",
 "name": "Whitewater Adventure"
 },
 {
 "com": "79634",
 "name": "London Pub Crawl"
 }
 ]
 },
 "media": {
 "@attributes": {
 "value": "3"
 },
 "image": [
 {
 "path": "https:\/\/s3.amazonaws.com\/rezgo\/1446\/29438\/68741.jpg",
 "caption": {}
 },
 {
 "path": "https:\/\/s3.amazonaws.com\/rezgo\/1446\/29438\/68739.jpg",
 "caption": {}
 },
 {
 "path": "https:\/\/s3.amazonaws.com\/rezgo\/1446\/29438\/68740.jpg",
 "caption": {}
 }
 ]
 },
 "cid": "1446"
 }
 ],
 "v": "latest",
 "gt": "0.04145"
}

                                

Back To Top

Example Request – Date Search

Example 1: The request is for a specific inventory item (SKU 29438) that is available on a specific date (2017-08-01)

For XML

http://api.rezgo.com/xml?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=search&t=com&q=29438&d=2017-08-01

For JSON

http://api.rezgo.com/json?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=search&t=com&q=29438&d=2017-08-01

Back To Top

Example Response – Date Search

The following is an example response for the Rezgo account with CID 1446.

Example XML Response

<?xml version="1.0" encoding="UTF-8"?>
<response>

<total>3</total>

<item>
 <num>1</num>
 <uid>72547</uid>
 <com>29438</com>
 <item><![CDATA[Family River Rafting]]></item>
 <option><![CDATA[8:00 am]]></option>
 <code><![CDATA[12345]]></code>
 <start_date>11</start_date>
 <end_date>1767168000</end_date>
 <time>8:00 AM</time>
 <updated>1469040498</updated>
 <tags>adventure,activity,water,rafting,nature</tags>
 <starting>129.00</starting>
 <group>request_name</group>
 <per>0</per>
 <cutoff>2</cutoff>
 <duration><![CDATA[5 hours]]></duration>
 <date_selection>always</date_selection>
 <date value="2017-08-02">
 <active>1</active>
 <availability>24</availability>
 <max_availability>150</max_availability>
 <price_adult>237.5</price_adult>
 <price_child>170.63</price_child>
 </date>
 <adult_label><![CDATA[Adult]]></adult_label>
 <child_label><![CDATA[Child (5-11 yrs)]]></child_label>
 <senior_label><![CDATA[]]></senior_label>
 <price4_label><![CDATA[]]></price4_label>
 <price5_label><![CDATA[]]></price5_label>
 <price6_label><![CDATA[]]></price6_label>
 <price7_label><![CDATA[]]></price7_label>
 <price8_label><![CDATA[]]></price8_label>
 <price9_label><![CDATA[]]></price9_label>
 <adult_required>1</adult_required>
 <child_required>0</child_required>
 <senior_required>0</senior_required>
 <price4_required>0</price4_required>
 <price5_required>0</price5_required>
 <price6_required>0</price6_required>
 <price7_required>0</price7_required>
 <price8_required>0</price8_required>
 <price9_required>0</price9_required>
 <block_size>5</block_size>
 <spaces>0</spaces>
 <currency_symbol>US $</currency_symbol>
 <currency_separator>,</currency_separator>
 <currency_decimals>2</currency_decimals>
 <currency_base>USD</currency_base>
 <location_name><![CDATA[Meeting Point is under 6th Street]]></location_name>
 <location_address><![CDATA[966 SW 6th St, Grants Pass, OR 97526, USA]]></location_address>
 <city><![CDATA[Grants Pass]]></city>
 <state><![CDATA[OR]]></state>
 <country><![CDATA[US]]></country>
 <lat>42.43179</lat>
 <lon>-123.332</lon>
 <zoom>14</zoom>
 <map_type>ROADMAP</map_type>
 <line_items>
 <line_item>
 <label><![CDATA[GST]]></label>
 <amount>0</amount>
 <percent>5</percent>
 <multi></multi>
 <tax>1</tax>
 </line_item>
 <line_item>
 <label><![CDATA[PST]]></label>
 <amount>0</amount>
 <percent>7.5</percent>
 <multi></multi>
 <tax>1</tax>
 </line_item>
 <line_item>
 <label><![CDATA[Land Use Fee]]></label>
 <amount>0</amount>
 <percent></percent>
 <multi>5.00</multi>
 <tax></tax>
 </line_item>
 <line_item>
 <label><![CDATA[Booking Fee]]></label>
 <amount>0</amount>
 <percent>5</percent>
 <multi></multi>
 <tax></tax>
 </line_item>
 </line_items>
 <total_adult>0</total_adult>
 <total_child>0</total_child>
 <total_senior>0</total_senior>
 <total_price4>0</total_price4>
 <total_price5>0</total_price5>
 <total_price6>0</total_price6>
 <total_price7>0</total_price7>
 <total_price8>0</total_price8>
 <total_price9>0</total_price9>
 <sub_total>0</sub_total>
 <taxes>0</taxes>
 <tax_calc>0</tax_calc>
 <overall_total>0</overall_total>
 <deposit></deposit>
 <deposit_value></deposit_value>
 <total_availability>24</total_availability>
<group_forms>
<form>
<id>0</id>
<type>checkbox_price</type>
<title><![CDATA[Custom Photo Package]]></title>
<instructions><![CDATA[]]></instructions>
<require>0</require>
<options><![CDATA[]]></options>
<price>+30</price>
</form>
<form>
<id>1</id>
<type>checkbox_price</type>
<title><![CDATA[Lunch Add-on]]></title>
<instructions><![CDATA[Would you like the featured lunch?]]></instructions>
<require>0</require>
<options><![CDATA[]]></options>
<price>+25</price>
</form>
<form>
<id>2</id>
<type>select</type>
<title><![CDATA[Life Jacket Size]]></title>
<instructions><![CDATA[Please choose your life jacket size]]></instructions>
<require>0</require>
<options><![CDATA[S, M, L, XL]]></options>
<price></price>
</form>
<form>
<id>3</id>
<type>text</type>
<title><![CDATA[Weight]]></title>
<instructions><![CDATA[Enter participant's weight in pounds.]]></instructions>
<require>1</require>
<options><![CDATA[]]></options>
<price></price>
</form>
<form>
<id>4</id>
<type>select</type>
<title><![CDATA[Do you have food allergies?]]></title>
<instructions><![CDATA[]]></instructions>
<require>1</require>
<options><![CDATA[Yes,No]]></options>
<price></price>
</form>
</group_forms>
<primary_forms>
<form>
<id>0</id>
<type>select</type>
<title><![CDATA[Pick-up Location]]></title>
<instructions><![CDATA[Choose your hotel and pick-up time.]]></instructions>
<require>0</require>
<options><![CDATA[Hyatt (9:00am),Hilton (9:15),Marriot (9:30),Hyatt (10:00)]]></options>
<price></price>
</form>
<form>
<id>1</id>
<type>select</type>
<title><![CDATA[How did you hear about us?]]></title>
<instructions><![CDATA[]]></instructions>
<require>1</require>
<options><![CDATA[Alaska Guide,Homer Guide,Newspaper,Google,Word of Mouth,Friend Referral,Social Media]]></options>
<price></price>
</form>
</primary_forms>
 <details>
 <overview><![CDATA[ OVERVIEW CONTENT APPEARS HERE ]]></overview>
 <highlights><![CDATA[ HIGHLIGHTS CONTENT APPEARS HERE ]]></highlights>
 <itinerary><![CDATA[ ITINERARY CONTENT APPEARS HERE]]></itinerary>
 <pick_up><![CDATA[ PICK-UP CONTENT APPEARS HERE ]]></pick_up>
 <drop_off><![CDATA[ DROP OFF CONTENT APPEARS HERE ]]></drop_off>
 <bring><![CDATA[ THINGS TO BRING CONTENT APPEARS HERE ]]></bring>
 <inclusions><![CDATA[ INCLUSIONS CONTENT APPEARS HERE ]]></inclusions>
 <exclusions><![CDATA[ EXCLUSIONS CONTENT APPEARS HERE ]]></exclusions>
 <cancellation><![CDATA[ CANCELLATION CONTENT APPEARS HERE ]]></cancellation>
 <description_name><![CDATA[This is my custom field]]></description_name>
 <description><![CDATA[ CUSTOM CONTENT APPEARS HERE ]]></description>
 <specifications> 
 <specification> 
 <name><![CDATA[Product Type]]></name> 
 <value><![CDATA[Lessons]]></value> 
 </specification> 
 <specification> 
 <name><![CDATA[Hike Level]]></name> 
 <value><![CDATA[Easy]]></value> 
 </specification> 
 </specifications>
 </details>
 <seo>
 <seo_title><![CDATA[ SEO TITLE APPEARS HERE ]]></seo_title>
 <introduction><![CDATA[ META DESCRIPTION CONTENT APPEARS HERE ]]></introduction>
 </seo>
 <related value="2">
 <item>
 <com>79309</com>
 <name><![CDATA[Whitewater Adventure]]></name>
 </item>
 <item>
 <com>79634</com>
 <name><![CDATA[London Pub Crawl]]></name>
 </item>
 </related>
 <media value="3">
 <image>
 <path>https://s3.amazonaws.com/rezgo/1446/29438/68741.jpg</path>
 <caption><![CDATA[]]></caption>
 </image>
 <image>
 <path>https://s3.amazonaws.com/rezgo/1446/29438/68739.jpg</path>
 <caption><![CDATA[]]></caption>
 </image>
 <image>
 <path>https://s3.amazonaws.com/rezgo/1446/29438/68740.jpg</path>
 <caption><![CDATA[]]></caption>
 </image>
 </media>
 <cid>1446</cid>
</item>
<v>latest</v>
<gt>0.04255</gt>
</response>

Example JSON Response

{
 "total": "3",
 "item": [
 {
 "num": "1",
 "uid": "72547",
 "com": "29438",
 "item": "Family River Rafting",
 "option": "8:00 am",
 "code": "12345",
 "start_date": "11",
 "end_date": "1767168000",
 "time": "8:00 AM",
 "updated": "1469040498",
 "tags": "adventure,activity,water,rafting,nature",
 "starting": "129.00",
 "group": "request_name",
 "per": "0",
 "cutoff": "2",
 "duration": "5 hours",
 "date_selection": "always",
 "date": {
 "@attributes": {
 "value": "2017-08-02"
 },
 "active": "1",
 "availability": "24",
 "max_availability": "150",
 "price_adult": "237.5",
 "price_child": "170.63"
 },
 "adult_label": "Adult",
 "child_label": "Child (5-11 yrs)",
 "senior_label": {},
 "price4_label": {},
 "price5_label": {},
 "price6_label": {},
 "price7_label": {},
 "price8_label": {},
 "price9_label": {},
 "adult_required": "1",
 "child_required": "0",
 "senior_required": "0",
 "price4_required": "0",
 "price5_required": "0",
 "price6_required": "0",
 "price7_required": "0",
 "price8_required": "0",
 "price9_required": "0",
 "block_size": "5",
 "spaces": "0",
 "currency_symbol": "US $",
 "currency_separator": ",",
 "currency_decimals": "2",
 "currency_base": "USD",
 "location_name": "Meeting Point is under 6th Street",
 "location_address": "966 SW 6th St, Grants Pass, OR 97526, USA",
 "city": "Grants Pass",
 "state": "OR",
 "country": "US",
 "lat": "42.43179",
 "lon": "-123.332",
 "zoom": "14",
 "map_type": "ROADMAP",
 "line_items": {
 "line_item": [
 {
 "label": "GST",
 "amount": "0",
 "percent": "5",
 "multi": {},
 "tax": "1"
 },
 {
 "label": "PST",
 "amount": "0",
 "percent": "7.5",
 "multi": {},
 "tax": "1"
 },
 {
 "label": "Land Use Fee",
 "amount": "0",
 "percent": {},
 "multi": "5.00",
 "tax": {}
 },
 {
 "label": "Booking Fee",
 "amount": "0",
 "percent": "5",
 "multi": {},
 "tax": {}
 }
 ]
 },
 "total_adult": "0",
 "total_child": "0",
 "total_senior": "0",
 "total_price4": "0",
 "total_price5": "0",
 "total_price6": "0",
 "total_price7": "0",
 "total_price8": "0",
 "total_price9": "0",
 "sub_total": "0",
 "taxes": "0",
 "tax_calc": "0",
 "overall_total": "0",
 "deposit": {},
 "deposit_value": {},
 "total_availability": "24",
 "group_forms": {
 "form": [
 {
 "id": "0",
 "type": "checkbox_price",
 "title": "Custom Photo Package",
 "instructions": {},
 "require": "0",
 "options": {},
 "price": "+30"
 },
 {
 "id": "1",
 "type": "checkbox_price",
 "title": "Lunch Add-on",
 "instructions": "Would you like the featured lunch?",
 "require": "0",
 "options": {},
 "price": "+25"
 },
 {
 "id": "2",
 "type": "select",
 "title": "Life Jacket Size",
 "instructions": "Please choose your life jacket size",
 "require": "0",
 "options": "S, M, L, XL",
 "price": {}
 },
 {
 "id": "3",
 "type": "text",
 "title": "Weight",
 "instructions": "Enter participant's weight in pounds.",
 "require": "1",
 "options": {},
 "price": {}
 },
 {
 "id": "4",
 "type": "select",
 "title": "Do you have food allergies?",
 "instructions": {},
 "require": "1",
 "options": "Yes,No",
 "price": {}
 }
 ]
 },
 "primary_forms": {
 "form": [
 {
 "id": "0",
 "type": "select",
 "title": "Pick-up Location",
 "instructions": "Choose your hotel and pick-up time.",
 "require": "0",
 "options": "Hyatt (9:00am),Hilton (9:15),Marriot (9:30),Hyatt (10:00)",
 "price": {}
 },
 {
 "id": "1",
 "type": "select",
 "title": "How did you hear about us?",
 "instructions": {},
 "require": "1",
 "options": "Alaska Guide,Homer Guide,Newspaper,Google,Word of Mouth,Friend Referral,Social Media",
 "price": {}
 }
 ]
 },
 "details": {
 "overview": " OVERVIEW CONTENT APPEARS HERE ",
 "highlights": " HIGHLIGHTS CONTENT APPEARS HERE ",
 "itinerary": " ITINERARY CONTENT APPEARS HERE ",
 "pick_up": " PICK UP CONTENT APPEARS HERE ",
 "drop_off": " DROP OFF CONTENT APPEARS HERE ",
 "bring": " THINGS TO BRING CONTENT APPEARS HERE ",
 "inclusions": " INCLUSIONS CONTENT APPEARS HERE ",
 "exclusions": " EXCLUSIONS CONTENT APPEARS HERE ",
 "cancellation": " CANCELLATION CONTENT APPEARS HERE ",
 "description_name": "This is my custom field",
 "description": " CUSTOM CONTENT APPEARS HERE ",
 "specifications": {
 "specification": [
 {
 "name": "Product Type",
 "value": "Lessons"
 },
 {
 "name": "Hike Level",
 "value": "Easy"
 }
 ]
 }
 },
 "seo": {
 "seo_title": " SEO TITLE CONTENT APPEARS HERE ",
 "introduction": " META DESCRIPTION APPEARS HERE "
 },
 "related": {
 "@attributes": {
 "value": "2"
 },
 "item": [
 {
 "com": "79309",
 "name": "Whitewater Adventure"
 },
 {
 "com": "79634",
 "name": "London Pub Crawl"
 }
 ]
 },
 "media": {
 "@attributes": {
 "value": "3"
 },
 "image": [
 {
 "path": "https:\/\/s3.amazonaws.com\/rezgo\/1446\/29438\/68741.jpg",
 "caption": {}
 },
 {
 "path": "https:\/\/s3.amazonaws.com\/rezgo\/1446\/29438\/68739.jpg",
 "caption": {}
 },
 {
 "path": "https:\/\/s3.amazonaws.com\/rezgo\/1446\/29438\/68740.jpg",
 "caption": {}
 }
 ]
 },
 "cid": "1446"
 }
 ],
 "v": "latest",
 "gt": "0.04256"
}

 

Back To Top

Month

Description

The month query returns availability information for a specified item. 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.

Back To Top

Arguments

Parameter Value
transcode CID (Required)
key REZGO API KEY (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

Back To Top

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)
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}
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
uid tour uid (aka sku)
name name of the tour

Back To Top

Example Request

The following is an example request for company information for the Rezgo account with CID 1446.

For XML

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

For JSON

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

Back To Top

Example Response

The following is an example response for the Rezgo account with CID 1446.

Example XML Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
 <name><![CDATA[Family River Rafting]]></name>
 <com>29438</com>
 <month>August</month>
 <year>2017</year>
 <day value="1" condition="u"></day>
 <day value="2" condition="u"></day>
 <day value="3" condition="u"></day>
 <day value="4" condition="u"></day>
 <day value="5" condition="u"></day>
 <day value="6" condition="u"></day>
 <day value="7" condition="u"></day>
 <day value="8" condition="u"></day>
 <day value="9" condition="u"></day>
 <day value="10" condition="u"></day>
 <day value="11" condition="u"></day>
 <day value="12" condition="u"></day>
 <day value="13" condition="u"></day>
 <day value="14" condition="u"></day>
 <day value="15" condition="u"></day>
 <day value="16" condition="u"></day>
 <day value="17" condition="u"></day>
 <day value="18" condition="u"></day>
 <day value="19" condition="u"></day>
 <day value="20" condition="u"></day>
 <day value="21" condition="u"></day>
 <day value="22" condition="u"></day>
 <day value="23" condition="u"></day>
 <day value="24" condition="u"></day>
 <day value="25" condition="u"></day>
 <day value="26" condition="u"></day>
 <day value="27" condition="u"></day>
 <day value="28" condition="u"></day>
 <day value="29" condition="u"></day>
 <day value="30" condition="u"></day>
 <day value="31" condition="u"></day>
 <active>0</active>
 <v>latest</v>
 <gt>0.03012</gt>
</response>

Example JSON Response

{
    "name": "Family River Rafting",
    "com": "29438",
    "month": "August",
    "year": "2017",
    "day": [
        {
            "@attributes": {
                "value": "1",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "2",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "3",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "4",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "5",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "6",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "7",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "8",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "9",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "10",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "11",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "12",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "13",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "14",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "15",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "16",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "17",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "18",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "19",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "20",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "21",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "22",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "23",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "24",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "25",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "26",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "27",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "28",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "29",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "30",
                "condition": "u"
            },
            "0": "\n"
        },
        {
            "@attributes": {
                "value": "31",
                "condition": "u"
            },
            "0": "\n"
        }
    ],
    "active": "0",
    "v": "latest",
    "gt": "0.04652"
}

 

Back To Top

Commit

Description

The commit query processes the booking data in order to create a booking. This query should be transferred as secure data using https. Required arguments must be enough to identify an item and the booking details. There are other required/optional arguments depending on the item. The variables sent must be urlencoded.

Back To Top

Arguments

Parameter Value Type Required
transcode CID
key REZGO API KEY
i company
date booking date
book item uid to book for
adult_num number of spots to book for adult
child_num number of spots to book for child
senior_num number of spots to book for seniors
price4_num – price9_num number of spots to book for {price4 – price9}
tour_first_name Billing info – First name
tour_last_name Billing info – Last name
tour_address_1 Billing info – Address
tour_address_2 Billing info – Address 2 (Optional)
tour_city Billing info – City
tour_stateprov Billing info – State/Province
tour_country Billing info – Country (ISO two letter code)
tour_postal_code Billing info – Postal Code
tour_phone_number Billing info – Phone Number
tour_email_address Billing info – E-mail address
tour_group [price_option] [x][field] Passenger info for sequential price option passenger (these could be required/optional depending on form field settings for the item) – these fields should not be shown if group is set to hide (in the item info)
tour_group [price_option] [x][forms] [form_field] Form info for sequential price option passenger for form field named form_field (these could be required/optional depending on form field settings for the item) – these are presented to each passenger
tour_forms [form_field] Form info for group (shown only once per booking when the form is set to show=primary)
payment_method One of the payment methods supported by the supplier. This list is provided in the Get Company API request.
tour_card_token If the payment is via credit card, this is the token returned from the Rezgo payment server. This value is generated using a Rezgo processing server API. (please contact Rezgo directly for details regarding this call).
force_status used to set status on commit. 1 = received, 2 = pending, 3 = cancelled
agree_terms this must be set to 1 to confirm that the user has agreed to the terms

Back To Top

Field Definitions

Field Definition
status success = 1; failed = 0
message the status of the booking
trans_num transaction reference number
error reason for the error if the status is 0
warning warning message if status is 1
txid the transaction ID
analytics_convert HTML/Javascript code for booking conversion tracking (or transaction analytics) (returned only if set in backend)

Back To Top

Example Request

The following is an example request for company information for the Rezgo account with CID 1446.  This example uses a manual “Cash” transaction.

For XML

<?xml version="1.0" encoding="UTF-8"?>
<request>
	<transcode>1446</transcode>
	<key>4U6-S6M2-T1V6-Y7M</key>
	<instruction>commit</instruction>
	<booking>
		<date>2015-03-26</date>
		<book>72547</book>
		<adult_num>2</adult_num>
		<child_num>1</child_num>
		<senior_num>0</senior_num>
		<tour_group>
			<adult num="1">
				<first_name>Samuel</first_name>
				<last_name>Jackson</last_name>
			</adult>
			<adult num="2">
				<first_name>John</first_name>
				<last_name>Smith</last_name>
			</adult>
			<child num="1">
				<first_name>Sally</first_name>
				<last_name>Smith</last_name>
			</child>
		</tour_group>
	</booking>
	<payment>
		<tour_first_name>Samuel</tour_first_name>
		<tour_last_name>Jackson</tour_last_name>
		<tour_address_1>123 Elm Street</tour_address_1>
		<tour_address_2>Suite 456</tour_address_2>
		<tour_city>Grand Rapids</tour_city>
		<tour_stateprov>Michigan</tour_stateprov>
		<tour_country>US</tour_country>
		<tour_postal_code>49501</tour_postal_code>
		<tour_phone_number>616-555-6677</tour_phone_number>
		<tour_email_address>sam.jackson@example.com</tour_email_address>
		<payment_method>Cash</payment_method>
		<agree_terms>1</agree_terms>
		<ip>10.28.107.230</ip>
		<refid>test</refid>
	</payment>
</request>

 

Back To Top

Example Response

The following is an example response for the Rezgo account with CID 1446.

Example XML Response

<?xml version="1.0" encoding="UTF-8"?>
<response>

<company_name><![CDATA[Adventure Tours]]></company_name>
<type>supplier</type>

<domain>adventuredemo</domain>

<terms><![CDATA[<p>FARES AND PRICES<br /> <br /> All fares and prices quoted are subject to availability. Prices are subject to change until full payment is received and voucher(s) are issued. Prices that are quoted include all taxes and fees unless we advises otherwise. New information.<br /> <br /> YOUR VOUCHER AND DEPARTURE POINT <br /> <br /> Please present your voucher 15-20 minutes before departure to the staff at departure point of your tour. The location of the departure point can be found in the description of the tour and is stated on your booking confirmation. We can not be held responsible for clients showing up late for their tours.<br /> <br /> AVAILABILITY<br /> <br /> The travel products and services sold through this site are subject to availability and can be withdrawn without notice. Tour is confirmed when full payment is received.<br /> <br /> IMPORTANT<br /> <br /> We request that you carefully check the dates on your voucher and to contact us immediately if these are not correct.<br /> <br /> CANCELLATION POLICY<br /> <br /> * Cancellation more than a week in advance : 15% administration fee<br /> * Cancellation between a week and 48 hours prior to departure date: 50% of the total amount plus administration fees that might be imposed<br /> * Cancellation less than 48 hours prior to departure date and time or no-show : 100% of the total amount <br /> * Tickets for Events or Attractions are non-refundable <br /> * Airport, Limousine or Coach - transfer services are non-refundable</p>]]></terms>
<address_1><![CDATA[718-333 Brooksbank Avenue]]></address_1>
<address_2><![CDATA[]]></address_2>
<city><![CDATA[North Vancouver]]></city>
<state_prov><![CDATA[BC]]></state_prov>
<postal_code>V7J 3V8</postal_code>
<country>ca</country>
<phone>604-983-0083</phone>
<fax></fax>
<tax_id>GST# 123456789</tax_id>
<email>stephenajoyce@gmail.com</email>
<map>
<lat>49.30976479725757</lat>
<lon>-123.04024457931519</lon>
<zoom>18</zoom>
</map>
<email_1></email_1>
<email_2></email_2>
<email_3></email_3>
<account_type>i</account_type>
<currency_symbol>US $</currency_symbol>
<currency_separator>,</currency_separator>
<currency_decimals>2</currency_decimals>
<currency_base> USD</currency_base>
<using_gateway>1</using_gateway>
<cards><![CDATA[Visa, MasterCard]]></cards>
<payment_methods><![CDATA[Credit Cards]]></payment_methods>
<payment>
<method add="0"><![CDATA[Credit Cards]]></method></payment>
<paypal_email></paypal_email>
<get_cvv>1</get_cvv>
<date_format>d M Y</date_format>
<time_format>+0</time_format>
<start_week>mon</start_week>
<header><![CDATA[<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="Rezgo | Tour and Activity Booking">
    <meta name="author" content="Rezgo">
    [meta]
    <title>Adventure Tours | [navigation]</title>
    <link href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css" rel="stylesheet">
    <link href="//netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" rel="stylesheet">
    <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
    <script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
    <!-- Rezgo default template stylesheet -->
    <style>
 			body { 
				padding-top: 50px;
			}
			#rezgo-default-header .rezgo-default-brand {
				font-size:24px;
				font-weight:800;
				color:#FFCC00;
				white-space: nowrap;
				overflow: hidden;
			}
			#rezgo-default-header .rezgo-default-brand:hover {
				color:#FFF;
			}
			.rezgo-default-wrapper {
				max-width:1170px;
				margin:0 auto;
			}
			footer {
			  padding-top: 20px;
				background-color:#000;
			}
			.rezgo-footer-brand, .rezgo-footer-brand a {
			  color: #888;
			}
			.rezgo-footer-brand a:hover {
			  color: #FFF;
			  text-decoration:none;
			}
			@media only screen 
			and (min-device-width : 320px) 
			and (max-device-width : 480px) {
				#rezgo-default-header .rezgo-default-brand {
					text-overflow: ellipsis;
					width:80%;
				}
			}
    </style>
  </head>
  <body>
    <!-- Start: HEADER -->    
    <header>
	    <div id="rezgo-default-header" class="navbar navbar-fixed-top navbar-inverse" role="navigation">
	      <div class="container-fluid">
	        <div class="navbar-header">
	          <a class="navbar-brand rezgo-default-brand" href="/">Adventure Tours</a>
	          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
	            <span class="sr-only">Toggle navigation</span>
	            <span class="icon-bar"></span>
	            <span class="icon-bar"></span>
	            <span class="icon-bar"></span>
	          </button>
	        </div>
	        <div class="collapse navbar-collapse">
	          <ul class="nav navbar-nav navbar-right">
	            <li><a href="/">Home</a></li>
	            <li><a href="/about">About</a></li><li><a href="/contact">Contact</a></li><li><a href="/page/history-of-the-raft">history-of-the-raft</a></li><li><a href="/page/the-adventuredemo-advantage">The AdventureDemo Advantage</a></li>	          </ul>
	        </div><!-- /.nav-collapse -->
	      </div><!-- /.container -->
	    </div><!-- /.navbar -->
    </header>   
    <!-- End: HEADER -->
    
    <!-- Start: REZGO -->
    <div class="rezgo-default-wrapper">
    ]]></header>
<footer><![CDATA[
    </div>
    <!-- End: REZGO -->
    
    <!-- Start: FOOTER -->
    <footer>
      <div class="container-fluid">
        <p class="rezgo-footer-brand">&copy; Adventure Tours 2016 | <a href="/terms">Terms &amp; Conditions</a></p>
      </div>
    </footer>
    <!-- End: FOOTER -->
  </body>
</html>]]></footer>
<styles><![CDATA[]]></styles>
<pages><page><path>aboutus</path><title></title></page><page><path>contact</path><title></title></page><page><path>history-of-the-raft</path><title>history-of-the-raft</title></page><page><path>the-adventuredemo-advantage</path><title>The AdventureDemo Advantage</title></page></pages><site_status>1</site_status>
<social>
<twitter_name>rezgo</twitter_name>
</social>
<cart>1</cart>
<trigger>1</trigger>
<analytics_general><![CDATA[]]></analytics_general>
<v>latest</v><gt>0.02928</gt></response>

Example JSON Response

{
    "company_name": "Adventure Tours",
    "type": "supplier",
    "domain": "adventuredemo",
    "terms": "<p>FARES AND PRICES<br /> <br /> All fares and prices quoted are subject to availability. Prices are subject to change until full payment is received and voucher(s) are issued. Prices that are quoted include all taxes and fees unless we advises otherwise. New information.<br /> <br /> YOUR VOUCHER AND DEPARTURE POINT <br /> <br /> Please present your voucher 15-20 minutes before departure to the staff at departure point of your tour. The location of the departure point can be found in the description of the tour and is stated on your booking confirmation. We can not be held responsible for clients showing up late for their tours.<br /> <br /> AVAILABILITY<br /> <br /> The travel products and services sold through this site are subject to availability and can be withdrawn without notice. Tour is confirmed when full payment is received.<br /> <br /> IMPORTANT<br /> <br /> We request that you carefully check the dates on your voucher and to contact us immediately if these are not correct.<br /> <br /> CANCELLATION POLICY<br /> <br /> * Cancellation more than a week in advance : 15% administration fee<br /> * Cancellation between a week and 48 hours prior to departure date: 50% of the total amount plus administration fees that might be imposed<br /> * Cancellation less than 48 hours prior to departure date and time or no-show : 100% of the total amount <br /> * Tickets for Events or Attractions are non-refundable <br /> * Airport, Limousine or Coach - transfer services are non-refundable</p>",
    "address_1": "718-333 Brooksbank Avenue",
    "address_2": {},
    "city": "North Vancouver",
    "state_prov": "BC",
    "postal_code": "V7J 3V8",
    "country": "ca",
    "phone": "604-983-0083",
    "fax": {},
    "tax_id": "GST# 123456789",
    "email": "stephenajoyce@gmail.com",
    "map": {
        "lat": "49.30976479725757",
        "lon": "-123.04024457931519",
        "zoom": "18"
    },
    "email_1": {},
    "email_2": {},
    "email_3": {},
    "account_type": "i",
    "currency_symbol": "US $",
    "currency_separator": ",",
    "currency_decimals": "2",
    "currency_base": " USD",
    "using_gateway": "1",
    "cards": "Visa, MasterCard",
    "payment_methods": "Credit Cards",
    "payment": {
        "method": "Credit Cards"
    },
    "paypal_email": {},
    "get_cvv": "1",
    "date_format": "d M Y",
    "time_format": "+0",
    "start_week": "mon",
    "header": "<!DOCTYPE html>n<html lang="en">n  <head>n    <meta charset="utf-8">n    <meta name="viewport" content="width=device-width, initial-scale=1.0">n    <meta name="description" content="Rezgo | Tour and Activity Booking">n    <meta name="author" content="Rezgo">n    [meta]n    <title>Adventure Tours | [navigation]</title>n    <link href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css" rel="stylesheet">n    <link href="//netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" rel="stylesheet">n    <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>n    <script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>n    <!-- Rezgo default template stylesheet -->n    <style>n tttbody { nttttpadding-top: 50px;nttt}nttt#rezgo-default-header .rezgo-default-brand {nttttfont-size:24px;nttttfont-weight:800;nttttcolor:#FFCC00;nttttwhite-space: nowrap;nttttoverflow: hidden;nttt}nttt#rezgo-default-header .rezgo-default-brand:hover {nttttcolor:#FFF;nttt}nttt.rezgo-default-wrapper {nttttmax-width:1170px;nttttmargin:0 auto;nttt}ntttfooter {nttt  padding-top: 20px;nttttbackground-color:#000;nttt}nttt.rezgo-footer-brand, .rezgo-footer-brand a {nttt  color: #888;nttt}nttt.rezgo-footer-brand a:hover {nttt  color: #FFF;nttt  text-decoration:none;nttt}nttt@media only screen ntttand (min-device-width : 320px) ntttand (max-device-width : 480px) {ntttt#rezgo-default-header .rezgo-default-brand {nttttttext-overflow: ellipsis;ntttttwidth:80%;ntttt}nttt}n    </style>n  </head>n  <body>n    <!-- Start: HEADER -->    n    <header>nt    <div id="rezgo-default-header" class="navbar navbar-fixed-top navbar-inverse" role="navigation">nt      <div class="container-fluid">nt        <div class="navbar-header">nt          <a class="navbar-brand rezgo-default-brand" href="/">Adventure Tours</a>nt          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">nt            <span class="sr-only">Toggle navigation</span>nt            <span class="icon-bar"></span>nt            <span class="icon-bar"></span>nt            <span class="icon-bar"></span>nt          </button>nt        </div>nt        <div class="collapse navbar-collapse">nt          <ul class="nav navbar-nav navbar-right">nt            <li><a href="/">Home</a></li>nt            <li><a href="/about">About</a></li><li><a href="/contact">Contact</a></li><li><a href="/page/history-of-the-raft">history-of-the-raft</a></li><li><a href="/page/the-adventuredemo-advantage">The AdventureDemo Advantage</a></li>t          </ul>nt        </div><!-- /.nav-collapse -->nt      </div><!-- /.container -->nt    </div><!-- /.navbar -->n    </header>   n    <!-- End: HEADER -->n    n    <!-- Start: REZGO -->n    <div class="rezgo-default-wrapper">n    ",
    "footer": "n    </div>n    <!-- End: REZGO -->n    n    <!-- Start: FOOTER -->n    <footer>n      <div class="container-fluid">n        <p class="rezgo-footer-brand">&copy; Adventure Tours 2016 | <a href="/terms">Terms &amp; Conditions</a></p>n      </div>n    </footer>n    <!-- End: FOOTER -->n  </body>n</html>",
    "styles": {},
    "pages": {
        "page": [
            {
                "path": "aboutus",
                "title": {}
            },
            {
                "path": "contact",
                "title": {}
            },
            {
                "path": "history-of-the-raft",
                "title": "history-of-the-raft"
            },
            {
                "path": "the-adventuredemo-advantage",
                "title": "The AdventureDemo Advantage"
            }
        ]
    },
    "site_status": "1",
    "social": {
        "twitter_name": "rezgo"
    },
    "cart": "1",
    "trigger": "1",
    "analytics_general": {},
    "v": "latest",
    "gt": "0.03021"
}

 

Back To Top

Search Bookings

Description

You can use the Rezgo API to request booking information.  The search booking query returns bookings based on a number of available search criteria.

Back To Top

Arguments

Parameter Value Field Type Required
transcode CID INTEGER X
key REZGO API KEY VARCHAR X
i search_bookings VARCHAR X
t date_purchased – search bookings based on start date/end date combination VARCHAR X
q startdate (YYYY-MM-DD) end date (YYYY-MM-DD) VARCHAR X

Back To Top

Field Definitions

Field Name Value
total returns 1 (or transaction count) if transaction is found else returns 0
trans_num booking reference number
item_id the item uid
cid company cid
tour_name Full name of the tour booked
option_name Full name of the option booked
date UNIX timestamp of item booking date
time local time of the item booked (if 0, then no time has been set)
date_range UNIX timestamp of item booking date
date_purchased UNIX timestamp of date when booking was made
date_purchased_local UNIX timestamp of date when booking was made in the supplier local time
note booking note associated with this booking
updated UNIX timestamp of last update to the booking
prices node of prices agreed upon for the booking
adult_price price level 1 (adult) price
child_price price level 2 (child) price
senior_price price level 3 (senior) price
price4 price level 4 price
price5 price level 5 price
price6 price level 6 price
price7 price level 7 price
price8 price level 8 price
price9 price level 9 price
adult_num total number of price level 1 (adults) booked
adult_label price 1 (adult) label
child_num total number of price level 2 (children) booked
child_label price 2 (child) label
senior_num total number of price level 3 (senior) booked
senior_label price 3 (senior) label
price4_num total number of price 4 booked
price4_label price 4 label
price5_num total number of price 5 booked
price5_label price 5 label
price6_num total number of price 6 booked
price6_label price 6 label
price7_num total number of price 7 booked
price7_label price 7 label
price8_num total number of price 8 booked
price8_label price 8 label
price9_num total number of price 9 booked
price9_label price 9 label
pax total number of passengers booked
spaces total number of spaces booked (applies when block size is in effect)
currency_symbol Supplier currency symbol (used for display purposes)
currency_seperator The currency seperator
currency_decimal The number of decimal places the currency supports
currency_base Supplier base currency
sub_total subtotal of the booking prior to additional line items
fees deprecated
line_items Node containing individual booking line items. These can be either taxes or fees that can added at the time of check-out.
line_item Node containing details about each line item.
label  name of this line item (e.g. Sales Tax, Booking Fee)
amount  amount of line item in base currency
percent  percent of line item (if no amount declared)
multi  flag to indicate that this line item is charged per person (0 or 1)
tax  flag to indicate if line item is a tax (0 or 1)
first_name Billing info – First name
last_name Billing info – Last name
address_1 Billing info – Address
address_2 Billing info – Address 2 (Optional)
city Billing info – City
stateprov Billing info – State/Province
country Billing info – Country
postal_code Billing info – Postal Code
phone_number Billing info – Phone Number
email_address Billing info – E-mail address
passengers Node containing separate passengers and their details
passenger Node containing details for a specific passenger
type  the price level associated with this passenger
first_name  the first name of the passenger (available if first name is required or optional)
last_name  the last name of the passenger (available if last name is required or optional)
phone_number  the phone number of the passenger (available if phone number is required or optional)
email_address  the email address of the passenger (available if email address is required or optional)
total_forms  the total number of passenger form fields
forms  Node containing the individual form fields
form Node containing specific form field details
id The incremental id of the form field (starting at 0)
type The type of form field (text, multi-select, etc.)
question The question asked in the form field.
answer The answer provided by the booking customer.
price_labels List containing price labels set at the time of booking
price_range Node containing price range at the time of booking
price_adult Price level 1 (Adult) price
price_child Price level 2 (Child) price
price_senior Price level 3 (Senior) price
price4 Price level 4 price
price5 Price level 5 price
price6 Price level 6 price
price7 Price level 7 price
price8 Price level 8 price
price9 Price level 9 price
overall_total total cost of booking
transactions Node of transactions applied to this booking
total  total number of transactions associated with this booking
transaction Node containing individual transactions
label  The payment method used for the transaction
date  UNIX timestamp of the date of the transaction
amount  The amount of the transaction (in base currency)
overall_paid amount paid to date
deposit amount of deposit required
trigger_code trigger/coupon code used with this booking; only shown if a trigger code is submitted
payment_method payment method used {eg. PayPal}statusstatus of payment (numeric code)
status status of payment (1 = confirmed, 2 = pending, 3 = cancelled)
status_text status text of payment (text version eg. Payment Pending)
checkin_status has the booking been checked in (if yes then value = 1)
primary_forms Node of primary form fields
form Node containing specific form field details
id The incremental id of the form field (starting at 0)
type The type of form field (text, multi-select, etc.)
question The question asked in the form field.
answer The answer provided by the booking customer.
refid is there a refid with the booking
v version of the API being used
gt time to generate the result (used for SLA purposes)

Back To Top

Example Request

The following is an example request for bookings for the Rezgo account with CID 1446.

Search by Date

For XML

https://api.rezgo.com/xml?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=search_bookings&t=date_purchased&q=2014-05-01,2014-05-31

For JSON

https://api.rezgo.com/json?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=search_bookings&t=date_purchased&q=2014-05-01,2014-05-31

Search by Order ID

For XML

http://api.rezgo.com/xml?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=search_bookings&t=order_code&q=4I2R9F7X3K5M7J1C

For JSON

http://api.rezgo.com/json?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=search_bookings&t=order_code&q=4I2R9F7X3K5M7J1C

Search by Trans Num (Booking ID)

For XML

http://api.rezgo.com/xml?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=search_bookings&t=trans_num&q=2V2A3I6C5D

For JSON

http://api.rezgo.com/json?transcode=1446&key=0U1-V4W9-L2S5-E4S&i=search_bookings&t=trans_num&q=2V2A3I6C5D

Back To Top

Example Response

The following is an example response for the Rezgo account with CID 1446.

Example XML Response

<?xml version="1.0" encoding="UTF-8"?>
<response>

<total>1</total>

<booking>
<trans_num>2V2A3I6C5D</trans_num>
<order_code>4I2R9F7X3K5M7J1C</order_code>
<checkin>10510721977</checkin>
<item_id>29438</item_id>
<cid>1446</cid>
<tour_name><![CDATA[Family River Rafting Adventure]]></tour_name>
<option_name><![CDATA[8:00 am]]></option_name>
<availability_type>date</availability_type>
<date>1416384000</date>
<time>0</time>
<date_range>1416384000</date_range>
<date_purchased>1415391506</date_purchased>

<date_purchased_local>1415391480</date_purchased_local>

<note><![CDATA[]]></note>

<updated>1416857958</updated>

<prices>
 <price_adult>66</price_adult>
 <base_prices>
 <price_adult>38</price_adult>
 </base_prices>
</prices>
<adult_num>2</adult_num>
<adult_label><![CDATA[Adult (21 yrs.+)]]></adult_label>
<pax>2</pax>
 <spaces>2</spaces>
 <currency_symbol>US $</currency_symbol>
 <currency_separator>,</currency_separator>
 <currency_decimals>2</currency_decimals>
 <currency_base>USD</currency_base>
 <sub_total>66</sub_total>
<fees></fees>

<line_items>
 <line_item>
 <label><![CDATA[Booking Fee]]></label>
 <amount>3.3</amount>
 <percent>5</percent>
 <multi></multi>
 <tax></tax>
 </line_item>
 <line_item>
 <label><![CDATA[Sales Tax]]></label>
 <amount>2.08</amount>
 <percent>3</percent>
 <multi></multi>
 <tax>1</tax>
 </line_item>
</line_items>

<triggered_fees>
 <total_triggered_fees>2</total_triggered_fees>
 <triggered_fee>
 <label><![CDATA[Custom Photo Package]]></label>
 <amount></amount>
 <total_amount>60</total_amount>
 </triggered_fee>
 <triggered_fee>
 <label><![CDATA[Lunch Add-on]]></label>
 <amount></amount>
 <total_amount>50</total_amount>
 </triggered_fee>
</triggered_fees>

<first_name><![CDATA[John]]></first_name>
<last_name><![CDATA[Doe]]></last_name>
<address_1><![CDATA[123 Anywhere]]></address_1>
<address_2><![CDATA[]]></address_2>
<city><![CDATA[Some Town]]></city>
<stateprov><![CDATA[CA]]></stateprov>
<country>us</country>
<postal_code>90210</postal_code>
<phone_number><![CDATA[604-555-5555]]></phone_number>
<email_address><![CDATA[Stephen@thejoyces.org]]></email_address>

 <passengers>
 <passenger>
 <type num="1">adult</type>
 <first_name><![CDATA[Jane]]></first_name>
 <last_name><![CDATA[Doe]]></last_name>
 <phone_number><![CDATA[]]></phone_number>
 <email_address><![CDATA[]]></email_address>
 <total_forms>5</total_forms>
 <forms>
 <form num="1">
 <id>0</id>
 <type>checkbox_price</type>
 <question><![CDATA[Custom Photo Package]]></question>
 <answer><![CDATA[on]]></answer>
 </form>
 <form num="2">
 <id>1</id>
 <type>checkbox_price</type>
 <question><![CDATA[Lunch Add-on]]></question>
 <answer><![CDATA[on]]></answer>
 </form>
 <form num="3">
 <id>2</id>
 <type>select</type>
 <question><![CDATA[Life Jacket Size]]></question>
 <answer><![CDATA[S]]></answer>
 </form>
 <form num="4">
 <id>3</id>
 <type>text</type>
 <question><![CDATA[Weight]]></question>
 <answer><![CDATA[170]]></answer>
 </form>
 <form num="5">
 <id>4</id>
 <type>checkbox</type>
 <question><![CDATA[21 Years and Over]]></question>
 <answer><![CDATA[on]]></answer>
 </form>
 </forms>
 </passenger>
 <passenger>
 <type num="2">adult</type>
 <first_name><![CDATA[Jim]]></first_name>
 <last_name><![CDATA[Doe]]></last_name>
 <phone_number><![CDATA[]]></phone_number>
 <email_address><![CDATA[]]></email_address>
 <total_forms>5</total_forms>
 <forms>
 <form num="1">
 <id>0</id>
 <type>checkbox_price</type>
 <question><![CDATA[Custom Photo Package]]></question>
 <answer><![CDATA[on]]></answer>
 </form>
 <form num="2">
 <id>1</id>
 <type>checkbox_price</type>
 <question><![CDATA[Lunch Add-on]]></question>
 <answer><![CDATA[on]]></answer>
 </form>
 <form num="3">
 <id>2</id>
 <type>select</type>
 <question><![CDATA[Life Jacket Size]]></question>
 <answer><![CDATA[S]]></answer>
 </form>
 <form num="4">
 <id>3</id>
 <type>text</type>
 <question><![CDATA[Weight]]></question>
 <answer><![CDATA[180]]></answer>
 </form>
 <form num="5">
 <id>4</id>
 <type>checkbox</type>
 <question><![CDATA[21 Years and Over]]></question>
 <answer><![CDATA[on]]></answer>
 </form>
 </forms>
 </passenger>
 </passengers>

<price_labels><![CDATA[price_adult, price_child, price_senior, price4, price5, price6, price7, price8, price9]]></price_labels>

<price_range>
 <date value="2014-11-19">
 <price_adult>33</price_adult>
 <price_child></price_child>
 <price_senior></price_senior>
 <price4></price4>
 <price5></price5>
 <price6></price6>
 <price7></price7>
 <price8></price8>
 <price9></price9>
 </date>

</price_range>
<overall_total>181.38</overall_total>
<transactions>
 <total>1</total>
 <transaction>
 <label><![CDATA[Credit Cards]]></label>
 <date>1415391576</date>
 <amount>181.38</amount>
 </transaction>
</transactions>
<overall_paid>181.38</overall_paid>
<trigger_code>SUMMERPROMO</trigger_code>
<payment_method><![CDATA[Credit Cards]]></payment_method>
<card_number><![CDATA[1111]]></card_number>
<status>1</status>
<status_text>Payment Received</status_text>
<checkin_state>1416857958</checkin_state>

<primary_forms>
 <total_forms>4</total_forms>
 <form num="1">
 <id>0</id>
 <type>text</type>
 <question><![CDATA[Mobile Number when in location]]></question>
 <answer><![CDATA[604-555-5555]]></answer>
 </form>
 <form num="2">
 <id>1</id>
 <type>select</type>
 <question><![CDATA[Pick-up Location]]></question>
 <answer><![CDATA[Hyatt (9:00am)]]></answer>
 </form>
 <form num="3">
 <id>2</id>
 <type>select</type>
 <question><![CDATA[How did you hear about us?]]></question>
 <answer><![CDATA[Alaska Guide]]></answer>
 </form>
 <form num="4">
 <id>3</id>
 <type>select</type>
 <question><![CDATA[Cruise Ship]]></question>
 <answer><![CDATA[Disney]]></answer>
 </form>
</primary_forms>
<refid><![CDATA[]]></refid>
</booking>

<v>latest</v>
<gt>0.03084</gt>
</response>

Example JSON Response

{
 "total": "1",
 "booking": {
 "trans_num": "2V2A3I6C5D",
 "order_code": "4I2R9F7X3K5M7J1C",
 "checkin": "10510721977",
 "item_id": "29438",
 "cid": "1446",
 "tour_name": "Family River Rafting Adventure",
 "option_name": "8:00 am",
 "availability_type": "date",
 "date": "1416384000",
 "time": "0",
 "date_range": "1416384000",
 "date_purchased": "1415391506",
 "date_purchased_local": "1415391480",
 "note": {},
 "updated": "1416857958",
 "prices": {
 "price_adult": "66",
 "base_prices": {
 "price_adult": "38"
 }
 },
 "adult_num": "2",
 "adult_label": "Adult (21 yrs.+)",
 "pax": "2",
 "spaces": "2",
 "currency_symbol": "US $",
 "currency_separator": ",",
 "currency_decimals": "2",
 "currency_base": "USD",
 "sub_total": "66",
 "fees": {},
 "line_items": {
 "line_item": [
 {
 "label": "Booking Fee",
 "amount": "3.3",
 "percent": "5",
 "multi": {},
 "tax": {}
 },
 {
 "label": "Sales Tax",
 "amount": "2.08",
 "percent": "3",
 "multi": {},
 "tax": "1"
 }
 ]
 },
 "triggered_fees": {
 "total_triggered_fees": "2",
 "triggered_fee": [
 {
 "label": "Custom Photo Package",
 "amount": {},
 "total_amount": "60"
 },
 {
 "label": "Lunch Add-on",
 "amount": {},
 "total_amount": "50"
 }
 ]
 },
 "first_name": "John",
 "last_name": "Doe",
 "address_1": "123 Anywhere",
 "address_2": {},
 "city": "Some Town",
 "stateprov": "CA",
 "country": "us",
 "postal_code": "90210",
 "phone_number": "604-555-5555",
 "email_address": "Stephen@thejoyces.org",
 "passengers": {
 "passenger": [
 {
 "type": "adult",
 "first_name": "Jane",
 "last_name": "Doe",
 "phone_number": {},
 "email_address": {},
 "total_forms": "5",
 "forms": {
 "form": [
 {
 "@attributes": {
 "num": "1"
 },
 "id": "0",
 "type": "checkbox_price",
 "question": "Custom Photo Package",
 "answer": "on"
 },
 {
 "@attributes": {
 "num": "2"
 },
 "id": "1",
 "type": "checkbox_price",
 "question": "Lunch Add-on",
 "answer": "on"
 },
 {
 "@attributes": {
 "num": "3"
 },
 "id": "2",
 "type": "select",
 "question": "Life Jacket Size",
 "answer": "S"
 },
 {
 "@attributes": {
 "num": "4"
 },
 "id": "3",
 "type": "text",
 "question": "Weight",
 "answer": "170"
 },
 {
 "@attributes": {
 "num": "5"
 },
 "id": "4",
 "type": "checkbox",
 "question": "21 Years and Over",
 "answer": "on"
 }
 ]
 }
 },
 {
 "type": "adult",
 "first_name": "Jim",
 "last_name": "Doe",
 "phone_number": {},
 "email_address": {},
 "total_forms": "5",
 "forms": {
 "form": [
 {
 "@attributes": {
 "num": "1"
 },
 "id": "0",
 "type": "checkbox_price",
 "question": "Custom Photo Package",
 "answer": "on"
 },
 {
 "@attributes": {
 "num": "2"
 },
 "id": "1",
 "type": "checkbox_price",
 "question": "Lunch Add-on",
 "answer": "on"
 },
 {
 "@attributes": {
 "num": "3"
 },
 "id": "2",
 "type": "select",
 "question": "Life Jacket Size",
 "answer": "S"
 },
 {
 "@attributes": {
 "num": "4"
 },
 "id": "3",
 "type": "text",
 "question": "Weight",
 "answer": "180"
 },
 {
 "@attributes": {
 "num": "5"
 },
 "id": "4",
 "type": "checkbox",
 "question": "21 Years and Over",
 "answer": "on"
 }
 ]
 }
 }
 ]
 },
 "price_labels": "price_adult, price_child, price_senior, price4, price5, price6, price7, price8, price9",
 "price_range": {
 "date": {
 "@attributes": {
 "value": "2014-11-19"
 },
 "price_adult": "33",
 "price_child": {},
 "price_senior": {},
 "price4": {},
 "price5": {},
 "price6": {},
 "price7": {},
 "price8": {},
 "price9": {}
 }
 },
 "overall_total": "181.38",
 "transactions": {
 "total": "1",
 "transaction": {
 "label": "Credit Cards",
 "date": "1415391576",
 "amount": "181.38"
 }
 },
 "overall_paid": "181.38",
 "trigger_code": "SUMMERPROMO",
 "payment_method": "Credit Cards",
 "card_number": "1111",
 "status": "1",
 "status_text": "Payment Received",
 "checkin_state": "1416857958",
 "primary_forms": {
 "total_forms": "4",
 "form": [
 {
 "@attributes": {
 "num": "1"
 },
 "id": "0",
 "type": "text",
 "question": "Mobile Number when in location",
 "answer": "604-555-5555"
 },
 {
 "@attributes": {
 "num": "2"
 },
 "id": "1",
 "type": "select",
 "question": "Pick-up Location",
 "answer": "Hyatt (9:00am)"
 },
 {
 "@attributes": {
 "num": "3"
 },
 "id": "2",
 "type": "select",
 "question": "How did you hear about us?",
 "answer": "Alaska Guide"
 },
 {
 "@attributes": {
 "num": "4"
 },
 "id": "3",
 "type": "select",
 "question": "Cruise Ship",
 "answer": "Disney"
 }
 ]
 },
 "refid": {}
 },
 "v": "latest",
 "gt": "0.02314"
}

 

Back To Top