Introduction

Welcome to the Grand Canyon OnePoint API service. This API can be used to check availbility and book reservations on Papillon Helicopters, Grand Canyon Airlines, Grand Canyon Helicopters, and Scenic Airlines.

The service presents a single endpoint (https://api.grandcanyononepoint.com/) and all messages should be POSTed there as JSON. We typically provide a single set of authentiation credentials and - initially - place your account into 'test' mode. This permits developers to build integrations against production data and eliminate remapping resources for production.

Authentication

Nearly every call in the GCOP API requires a valid sessionKey, which will be generated for you by the "authenticate" message. By default session keys expire 24 hours from the time they are created. As a developer, you are free to override this default with either a shorter or longer expiration depending on your needs. Note that requesting a password reset from our technical support staff will cause all currently-issued session keys to be invalidated.

Request Fields

To get an security key POST the following request filling in the appropriate fields with your information: Note that the lifetime key is optional. By default the session key will expire in 24 hours from its creation. However, you are free to define how long you wish this session key to be valid. Values are in seconds.

{
  "request":"authenticate",
  "userName":"yourUserName",
  "password":"yourPassword",
  "agencyID":"yourAgencyID",
  "lifetime":86400
}

Response Fields

You should get a result similar to the following:

{
  "success": 1,
  "errors": [],
  "sessionKey": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXBpbGxvbkdyb3VwIiwic3ViIjoiRGlyZWN0Q29ubmVjdEFjY2VzcyIsImF1ZCI6ImQ0OGQ3MDA4LTA2ZTktMTFlOC1iYTg5LTBlZDVmODlmNzE4YiIsImV4cCI6MTU1NDgzNjA4NiwibmJmIjoxNTIzMzAwMDg2LCJpYXQiOjE1MjMzMDAwODZ9.801602c0b13d246cce4c88f8a1e5a35d9d6b00ddeb66510ed8dbfe423b9e5587"
}

Errors

The 'success' field is the primary indicator if the call requested succeeded or not.

{
  "success": 0,
  "errors" : {
    message: "An error message describing what went wrong.",
    "code": 801092
  }
}

Errors are rendered using a simple datamodel illustrated here. All calls are entirely succesful or complete failure. All responses from our API contain a "success" field that will be either 1 or 0 depending on the call's success or failure. An error will also provide a message describing the problem and an error code. Should you run into any odd or unsolveable errors we will need both the message and the error code.

Products Catalog

Product Universes

{
  "sessionKey":"yourSessionKey",
  "request":"listProductUniverses"
}

The above command returns JSON structured like this:

{
  "success": 1,
  "universe": [
    {
      "name": "Universe name #1",
      "uuid": "25280c6a-b58a-493b-bd24-7adb497c1fe7"
    },
    {
      "name": "Universe name #2",
      "uuid": "7f7b624b-e21f-487c-bd3f-bce724fbda7f"
    }
  ]
}

In our API, the term 'Universe' and 'Category' are often used interchangably. A product universe is simply a collection of products that share a common attribute. In the case of the most current version of our API the universes group together the tours that are offered by our different brands. Thus all tours offered by Grand Canyon Helicopters will be contained within a single universe as would all products by Scenic Airlines. The only exception to this rule is that we may, from time to time, create a universe to house promotional tours.

Request Fields

Response Fields

Universe Object Structure

Product Universe Contents

{
  "request":"showProductUniverse",
  "sessionKey":"yourSessionKey",
  "universeID":"aProductUniverseUUID"
}

The above command returns JSON structured like this:

{
  "success": 1,
  "universeID": "25280c6a-b58a-493b-bd24-7adb497c1fe7",
  "products": [
      {
        "name": "Grand Celebration",
        "code": "PBW4",
        "productID": "925d8ee4-6bb6-4779-b8b5-aaa23498ea08",
        "cityCode": "LAS",
        "airportCode": "BVU"
      },
    ...
    ...

Each product universe will contain a list of productIDs and some meta information about that product such as the name, originating city & airport code, as well as the products code (similar to product SKU).

Request Fields

Response Fields

Product Object Structure:

Get All Categories & Products

{
  "request":"getEntireCatalog",
  "sessionKey":"yourSessionKey"
}

The above command returns JSON structured like this:

{
  "success": 1,
  "catalog": [
      {
        "name": "To West Rim External",
        "uuid": "25280c6a-b58a-493b-bd24-7adb497c1fe7",
        "products": [
            {
              "name": "Grand Celebration G1",
              "code": "PBW4",
              "productID": "925d8ee4-6bb6-4779-b8b5-aaa23498ea08",
              "cityCode": "LAS",
              "airportCode": "BVU"
            },
            {
              "name": "Golden Eagle G1",
              "code": "PBW1",
              "productID": "c456c056-06e7-11e8-ba89-0ed5f89f718b",
              "cityCode": "LAS",
              "airportCode": "BVU"
           }
        ],
    },
    {
      "name": "To South Rim External",
      "uuid": "7f7b624b-e21f-487c-bd3f-bce724fbda7f",
      "products": [
        {
          "name": "Canyon Conniessour G1",
          "code": "SBG4",
          "productID": "e0f2e7df-0a21-4cec-a5f2-e1da4e53c487",
          "cityCode": "LAS",
          "airportCode": "BVU"
        },
        ...
        ...

By far the easiest and most direct way to find all the products and categories an agency is subscribed to is the "getEntireCatalog" call. Primarily a convenience feature, it wraps the functionality of both "listProductUniverses" and "showProductUniverse" into a single result.

Request Fields

Response Fields

Universe Structure:

Get Product Descriptions

{
  "request":"getEntireCatalog",
  "sessionKey":"yourSessionKey",
  "productID":"productUUID"
}

The above command returns JSON structured like this:

{
  "success":1,
  "shortDesc":"A undecorated short line of description that will be less that 350 characters",
  "longDesc":"A possibly lengthy description that may contain simple html formatting like bold, paragraph, and the like",
  "textAvailable":true,
  "imagesAvailable":false,
  "duration": 540,
  "bookingCutoff": 240,
  "minCancellation": 2880,
  "hash":"e914a315882e3a7df45fa19bf10ec8633d1c1403"
}

The call will return several fields that, at the moment, return a short and long description of the product id passed in. In addition we provide a hash of the values so that consumers can quickly check to see if either the descriptions or images have changed. If the hash does not match your stored hash you should consider that all fields in the return values have changed.

Request Fields

Response Fields

Availability & Price

Our tours, availability structure, and pricing are built around a day model and are contingent upon how many passengers you are looking for. While this might seem strange, one must understand that - for the most part - our tours and experiences are operated on smaller and more personal aircraft; thus we make every effort to ensure that groups and families are not separated. Thus it is important for us to know how many of each (adult vs child) are planning to take the experience so we can validate space for them.

When presented with the requirement (eg: 2 adults, 1 child, on August 10) we will process your request and return ONLY the itineraries that match your criteria.

The "getCalendar" request is the only exception to this rule. The "getCalendar" call will show you all itineraries that have at least 2 seats available.

Single Day Availability Search

Request

{
  "request": "checkAvailability",
  "sessionKey": "yourSessionKey",
  "productID": "aProductUUID",
  "adult": 1,
  "child": 1,
  "date": "YYYY-MM-DD",
  "withHotels": true
}

Response

{
  "success": 1,
  "Attributes": [{
    "AttributeId": "test1",
    "Name": "ext1"
  }, {
    "AttributeId": "1a119a38-ffbe-11e7-ba89-0ed5f89f718b",
    "Name": "Special Service Notes"
  }, {
    "AttributeId": "2dea9802-ffbe-11e7-ba89-0ed5f89f718b",
    "Name": "VoucherID"
  }],
  "Itineraries": [{
    "ItineraryID": 390,
    "NoAdults": 1,
    "NoChildren": 1,
    "StartRangeTime": "06:30",
    "EndRangeTime": "06:30",
    "EstPickupTime": false,
    "PickupClass": "PC303",
    "AdultPrice": 259,
    "AdultFees": 85,
    "ChildPrice": 239,
    "ChildFees": 85,
    "TotalPrice": 668,
    "DeptTime": "Early Bird Fare at 06:30"
  }, 
  ...
  ...
  {
    "ItineraryID": 1080,
    "NoAdults": 1,
    "NoChildren": 1,
    "StartRangeTime": "18:00",
    "EndRangeTime": "18:00",
    "EstPickupTime": false,
    "PickupClass": "PC304",
    "AdultPrice": 294,
    "AdultFees": 85,
    "ChildPrice": 274,
    "ChildFees": 85,
    "TotalPrice": 738,
    "DeptTime": "Sunset Fare at 18:00"
  }],
  "PickupServiceAvailable": true,
  "PickupClassHotelList": {
    "PC303": [{
      "id": "1067",
      "lable": "Alexis Park",
      "estimatedMinsPrior": 80
    }, {
      "id": "1070",
      "lable": "Americana 5 At Industrial Rd",
      "estimatedMinsPrior": 75
    }, {
      "id": "1232",
      "lable": "Americas Best Value Inn",
      "estimatedMinsPrior": 75
    }, {
      "id": "1843",
      "lable": "Aria Resort",
      "estimatedMinsPrior": 90
    }, {
      "id": "192",
      "lable": "Arizona Charlie's (Boulder Hwy)",
      "estimatedMinsPrior": 65
    }, {
      "id": "193",
      "lable": "Arizona Charlie's (Decatur)",
      "estimatedMinsPrior": 125
    }, {
      "id": "1505",
      "lable": "Artisan Hotel Boutique",
      "estimatedMinsPrior": 90
    },
    ...
  }
}

This call will return all available itineraries for a specific day, any additional attributes necessary to book the product, and if desired or necessary the hotel pickup lists (yes, potentially plural).

Request Fields

Response Fields

Root Response Object

Attributes

Itineraries

Pickup Classes

All itineraries return a PickupClass value in their itineraries and that value serves as a lookup for values in the PickupClassHotelList. This is necessary because pickup availability and the estimated mins before pickup can change from itinerary to itinerary due to known weather patterns, traffic patterns, airspace congestion, shuttle size, and a variety of other variables. We do our best to ensure that passengers spend as little time in shuttles and as much time as possible on their actual experince.

Hotel Structure

Date Span Availabity Search

Single Product Request

{
  "request":"checkAvailabilitySpan",
  "sessionKey":"",
  "productID":"925d8ee4-6bb6-4779-b8b5-aaa23498ea08",
  "adult": 1,
  "child": 1,
  "startDate": "2018-06-01",
  "endDate":"2018-06-30",
  "withHotels": true
}

Single Product Response

{
  "PickupClassHotelList": {
    "PC303": [{
      "id": "1067",
      "lable": "Alexis Park",
      "estimatedMinsPrior": 80
    }, {
      "id": "1070",
      "lable": "Americana 5 At Industrial Rd",
      "estimatedMinsPrior": 75
    }
    ...
  },
  "Dates": {
    "2018-06-01": [
      {
        "ItineraryID": 390,
        "NoAdults": 1,
        "NoChildren": 1,
        "StartRangeTime": "06:30",
        "EndRangeTime": "06:30",
        "EstPickupTime": false,
        "PickupClass": "PC303",
        "AdultPrice": 259,
        "AdultFees": 85,
        "ChildPrice": 239,
        "ChildFees": 85,
        "TotalPrice": 668,
        "DeptTime": "Early Bird Fare at 06:30",
    }, ...]
    ...
    ...
    "2018-06-30": [{
      "ItineraryID": 390,
      "NoAdults": 1,
      "NoChildren": 1,
      "StartRangeTime": "06:30",
      "EndRangeTime": "06:30",
      "EstPickupTime": false,
      "PickupClass": "PC303",
      "AdultPrice": 259,
      "AdultFees": 85,
      "ChildPrice": 239,
      "ChildFees": 85,
      "TotalPrice": 668,
      "DeptTime": "Early Bird Fare at 06:30"
    },

Multi-Product Request

{
  "request":"checkAvailabilitySpan",
  "sessionKey":"",
  "productList":"925d8ee4-6bb6-4779-b8b5-aaa23498ea08,925d8ee4-6bb6-4779-b8b5-aaa23498ea08,925d8ee4-6bb6-4779-b8b5-aaa23498ea08",
  "adult": 1,
  "child": 1,
  "startDate": "2018-06-01",
  "endDate":"2018-06-30",
  "withHotels": true
}

Multi-Product Response

{
  "success":1,
  "errors":{},
  "productList":["925d8ee4-6bb6-4779-b8b5-aaa23498ea08","925d8ee4-6bb6-4779-b8b5-aaa23498ea08","925d8ee4-6bb6-4779-b8b5-aaa23498ea08"],
  "productAvailability":{
    "925d8ee4-6bb6-4779-b8b5-aaa23498ea08": {
      "PickupClassHotelList":{
        ... see single product response
      },
      "Dates":{
        ... see single product response
      }
    }
  }
}

In addition to the single day search, developers can now get batch availability by specifying a start date and an end date. Note that the end date is INCLUSIVE! Currently the distance between the start date and end date cannot exceed 180 days.

Request Fields

Response Fields

Root Response Object

Date Specific Object

For the description of the itinerary object see 'Single Day Availability' search documentation above.

Get Calendar

Request

{
  "request":"getCalendar",
  "sessionKey":"",
  "productID":"925d8ee4-6bb6-4779-b8b5-aaa23498ea08",
  "month":6,
  "year":2018
}

Response

{
  "success": 1,
  "dayArray": {
    "1": [{
      "ItineraryID": 390,
      "NoAdults": 1,
      "NoChildren": 1,
      "StartRangeTime": "06:30",
      "EndRangeTime": "06:30",
      "EstPickupTime": false,
      "PickupClass": false,
      "AdultPrice": 259,
      "AdultFees": 85,
      "ChildPrice": 239,
      "ChildFees": 85,
      "TotalPrice": 668,
      "DeptTime": "Early Bird Fare at 06:30",
      "seatsAvailable": 44
    }, {
      "ItineraryID": 1095,
      "NoAdults": 1,
      "NoChildren": 1,
      "StartRangeTime": "18:15",
      "EndRangeTime": "18:15",
      "EstPickupTime": false,
      "PickupClass": false,
      "AdultPrice": 294,
      "AdultFees": 85,
      "ChildPrice": 274,
      "ChildFees": 85,
      "TotalPrice": 738,
      "DeptTime": "Sunset Fare at 18:15",
      "seatsAvailable": 54
    }],
    ...
    "30": [{
      "ItineraryID": 390,
      "NoAdults": 1,
      "NoChildren": 1,
      "StartRangeTime": "06:30",
      "EndRangeTime": "06:30",
      "EstPickupTime": false,
      "PickupClass": false,
      "AdultPrice": 259,
      "AdultFees": 85,
      "ChildPrice": 239,
      "ChildFees": 85,
      "TotalPrice": 668,
      "DeptTime": "Early Bird Fare at 06:30",
      "seatsAvailable": 46
    }, {
      "ItineraryID": 1110,
      "NoAdults": 1,
      "NoChildren": 1,
      "StartRangeTime": "18:30",
      "EndRangeTime": "18:30",
      "EstPickupTime": false,
      "PickupClass": false,
      "AdultPrice": 294,
      "AdultFees": 85,
      "ChildPrice": 274,
      "ChildFees": 85,
      "TotalPrice": 738,
      "DeptTime": "Sunset Fare at 18:30",
      "seatsAvailable": 54
    }]
  },
  "dateArray": {
    "2018-06-01": [{
      "ItineraryID": 390,
      "NoAdults": 1,
      "NoChildren": 1,
      "StartRangeTime": "06:30",
      "EndRangeTime": "06:30",
      "EstPickupTime": false,
      "PickupClass": false,
      "AdultPrice": 259,
      "AdultFees": 85,
      "ChildPrice": 239,
      "ChildFees": 85,
      "TotalPrice": 668,
      "DeptTime": "Early Bird Fare at 06:30",
      "seatsAvailable": 44
    }, {
      "ItineraryID": 555,
      "NoAdults": 1,
      "NoChildren": 1,
      "StartRangeTime": "09:15",
      "EndRangeTime": "09:15",
      "EstPickupTime": false,
      "PickupClass": false,
      "AdultPrice": 284,
      "AdultFees": 85,
      "ChildPrice": 264,
      "ChildFees": 85,
      "TotalPrice": 718,
      "DeptTime": "Prime Time Fare at 09:15",
      "seatsAvailable": 37
    }],
    ...
    "2018-06-30": [{
      "ItineraryID": 390,
      "NoAdults": 1,
      "NoChildren": 1,
      "StartRangeTime": "06:30",
      "EndRangeTime": "06:30",
      "EstPickupTime": false,
      "PickupClass": false,
      "AdultPrice": 259,
      "AdultFees": 85,
      "ChildPrice": 239,
      "ChildFees": 85,
      "TotalPrice": 668,
      "DeptTime": "Early Bird Fare at 06:30",
      "seatsAvailable": 46
    }, {
      "ItineraryID": 1110,
      "NoAdults": 1,
      "NoChildren": 1,
      "StartRangeTime": "18:30",
      "EndRangeTime": "18:30",
      "EstPickupTime": false,
      "PickupClass": false,
      "AdultPrice": 294,
      "AdultFees": 85,
      "ChildPrice": 274,
      "ChildFees": 85,
      "TotalPrice": 738,
      "DeptTime": "Sunset Fare at 18:30",
      "seatsAvailable": 54
    }]
  }
}    

This is the only availability and pricing check function that does NOT require a number of adults and children and is intended, primarily, to get a sense of the available departure time and prices for a calendar month.

Request Fields

Response Fields

Root Response Object

In both cases see 'Single Day Availability Search' for an explaination of the contents of the itinerary object.

Making Reservations

There are two different workflows for making reservations through our API. The workflow that is relevant to you depends on if your agency has billing/voucher privileges with our activity providers.

Billing/Voucher Workflow

1. Create a Quote : This guarantees the prices on a product for a specific day for a specific number of guests.
   • It is rare but possible for the price of an itinerary to change between the time you run your check availability call and the time you create a quote. The availability and pricing information presented in the quote is authoritative.
   • Quotes have a specific liftime and can expire.
   • This step does NOT guarantee seating availability, only price.
2. Process the Reservation : This step pulls the seats out of inventory and creates a reservation number.
   • This step guarantees seating availability.
   • Reservations must be paid within the alloted time or they will expire and be automatically cancelled.

Create Quote

Request

{
  "request": "quote",
  "sessionKey": "yourSessionKey",
  "productID": "925d8ee4-6bb6-4779-b8b5-aaa23498ea08",
  "adult": "1",
  "child": "1",
  "date": "2018-05-22",
  "withHotels": true  
}

Response

{
  "success": 1,
  "Attributes": [{
    "AttributeId": "test1",
    "Name": "ext1"
  }, {
    "AttributeId": "1a119a38-ffbe-11e7-ba89-0ed5f89f718b",
    "Name": "At what hotel are the guests staying"
  }, {
    "AttributeId": "2dea9802-ffbe-11e7-ba89-0ed5f89f718b",
    "Name": "VoucherID"
  }],
  "Itineraries": [{
    "ItineraryID": 390,
    "NoAdults": 1,
    "NoChildren": 1,
    "StartRangeTime": "06:30",
    "EndRangeTime": "06:30",
    "EstPickupTime": false,
    "PickupClass": "PC303",
    "AdultPrice": 259,
    "AdultFees": 85,
    "ChildPrice": 239,
    "ChildFees": 85,
    "TotalPrice": 668,
    "DeptTime": "Early Bird Fare at 06:30",
    "seatsAvailable": 44
  }, 
  ...
  ...
  {
    "ItineraryID": 1080,
    "NoAdults": 1,
    "NoChildren": 1,
    "StartRangeTime": "18:00",
    "EndRangeTime": "18:00",
    "EstPickupTime": false,
    "PickupClass": "PC304",
    "AdultPrice": 294,
    "AdultFees": 85,
    "ChildPrice": 274,
    "ChildFees": 85,
    "TotalPrice": 738,
    "DeptTime": "Sunset Fare at 18:00",
    "seatsAvailable": 54
  }],
  "PickupServiceAvailable": true,
  "PickupClassHotelList": {
    "PC303": [{
      "id": "1067",
      "lable": "Alexis Park",
      "estimatedMinsPrior": 80
    }, {
      "id": "1070",
      "lable": "Americana 5 At Industrial Rd",
      "estimatedMinsPrior": 75
    },
    ...
    ...
    {
      "id": "1523",
      "lable": "Wynn Las Vegas",
      "estimatedMinsPrior": 115
    }]
  },
  "QuoteID": "9f79b180-1dd5-11b2-bb1a-6f0d4cb7849e",
  "QuoteCreated": 1523321695,
  "QuoteExpires": 1523322895,
  "date": "2018-05-22"
}

Does the format of the quote response look familiar? If you're thinking that it looks a great deal like the "Single Day Availability Search" you would be correct. 99% of the format is identical. However, it's the differences that are very important.

A few notes about Quotes:

• Quotes have a time life. Once expired they cannot be used to create a new reservation.
• The time at which a quote expires is noted in the response payload.
• A quote can be use only once and the passenger counts on the quote and the reservation must match exactly.
• The target date of a quote and the date of a new reservation must also match exactly.
• Should the number of adults or children change or should the tour start date change, a NEW quote is required.
• A quote can be used only once to create a single reservation.
• It is possible though rare that the price of an itinerary might change between the availability search and the quote generation. At all times the information on the quote is authoritative.
• A quote guarantees price ONLY. Seats are not guaranteed until the reservation ("reserve") call is completed.
• The Net Rates delivered at the Quote stage are the rates that the activity operator ("Scenic Airlines", "Papillon Helicotpers", etc, etc) will expect to collect. These prices are not Sale prices and should not be exposed directly to your customers. They are the net rates to YOU as the agency and do not have markup or commission built into them.

Request Fields

Response Fields

Root Response Object

Reserve Seats

Request

{
  "request":"reserve",
  "quoteID":"9f442ae0-1dd5-11b2-ac02-bd9d5c5a9c61",
  "sessionKey": "yourSessionKey",
  "itineraryID":555,
  "hotelID": 1441,
  "masterFirstName":"Roper",
  "masterLastName":"Clayton",
  "emailAddress":"coy@papillon.com",
  "phoneNumber":"7024085411",
  "markup": {
    "adult":440,
    "child":420
  },
  "paxArray": [
    {
      "FirstName": "Coy",
      "LastName": "Clayton",
      "BodyWeight": "280",
      "Type": "Adult"
    },
    {
      "FirstName": "Logan",
      "LastName": "Fischer",
      "BodyWeight": "55",
      "Type": "Child"
    }
  ],
  "attribArray": [
    {
      "id": "2dea9802-ffbe-11e7-ba89-0ed5f89f718b",
      "value": "XV298107-1290-20091"
    },
    {
      "id": "1a119a38-ffbe-11e7-ba89-0ed5f89f718b",
      "value": "Luxor"
    }
  ]
}

Response

{
  "orl": "2459828",
  "hotel": "Hilton Grand Vacation Suites At The Flamingo",
  "pickup": "Outside - Main Entrance",
  "pickupTime": "07:30",
  "adultNetRate": 369,
  "childNetRate": 349,
  "adultSaleRate": 440,
  "childSaleRate": 420,
  "totalSale": 860,
  "quoteID": "9f7a0700-1dd5-11b2-8ce1-a3abbdc3c9df",
  "resExpires": true,
  "resExpireAfter": 1523324855,
  "success": 1,
  "errors": []
}

This call its the call that guarantees seats! This is the call that generates an actual, living, breathing reservation. It's powerful, but not overly complex. There are a few things to keep in mind, however.

• Any reservation may be cancelled regardless of cancellation policy so long as:
  1. It's status is NOT paid.
  2. It is cancelled within 10 mins of its creation.
• If you are on billing/voucher, within the products cancellation penalty window, and the reservation has lived LONGER than 10 mins you may be billed for the seats.
• If the seats on your chosen itinerary are no longer available (because they were sold in the interim) this 'reserve' call will fail with an error code. You may use your existing quote to book any other itinerary but you may not change days or passenger counts without requoting.
• If the product provides a pickup then a hotelID entry is required. That hotelID can be the "Unknown" hotel if necessary, but accurate pickup information allows us to provide instant pickup information to you (and thus your guest). If you omit this field or do not provide a valid hotelID you will receive an error.
• The submision of a quoteID is required. This demonstrates to us that either yourself, your system, or your agent has seen the rate that we will bill/charge for these seats and, as stated in our rate agreement, agree to pay them.

Request Fields

Markup Object

API useres are free to define their own sale prices based on our variable net rate. This is accomplished by submitting a 'markup' object along with the 'reserve' request. The sale price is a price ABOVE the net rate that has been quoted to you. For example, if we deliver $240 adult & $220 child net rate you may include a markup object that says you want to charge $260 adult and $240 child. This configuration would result in a $20 adult / $20 child commission back to you.

In all cases the adult and child value may NOT be less that the net rate quoted to you for the specific itinerary.

paxArray

The paxArray (short for Passenger Array) defines the information that we need about every person traveling on this reservation. Each person represents a different passenger object within the paxArray array. Passenger are defined like this:

Note that the system will count the number of adults and number of children and validate that against the number of adults and children used to build the quote.

attribArray During both the quote and availability phase there were fields marked "Attributes". Each attribute was associated with a UUID. To provide values for those attributes add 1 json object (as defined below) to the attribArray. 1 object per attribute.

Response Fields

Cancel a Booking

Request

{
  "sessionKey": "your session key",
  "request":"cancel",
  "ResLocator":"2459829"
}

Response

{
  "success": 1,
  "ResLocator": "2459829"
}

Sometimes things just don't work out. The client decides they don't like to fly, are afraid of heights, or cancel for any number of reasons. That is what this 'cancel' call is used for. There are a couple caveats in its use however. Iterated below:

• A reservation can be cancelled through the API if:
  1. It is UNPAID or does not require payment.
  2. It is outside the product's cancellation window OR the reservation was created less than 10 mins ago
• All of our UNPAID reservations come with a 10 min grace period during which you may freely cancel the reservation.
  • This is useful when as a billing/voucher client, you need to insure payment from a guest
  • need just a little more time to sell the guest on an experience.

Request Fields

Response Fields