Quick Start

This guide will walk you through making your first API call to the Project Expedition API.

Prerequisites

Before you begin, you’ll need:

1. A registered account at projectexpedition.com
2. An API access token (contact partners@projectexpedition.com)

Your First API Call

Let’s search for tours in Ireland. This is one of the most common API operations.

curl

curl -H "access-token: YOUR_TOKEN" \
  "https://apistage.projectexpedition.com/v1/return_tours?country=ireland"

JavaScript

const response = await fetch(
  'https://apistage.projectexpedition.com/v1/return_tours?country=ireland',
  {
    headers: {
      'access-token': 'YOUR_TOKEN'
    }
  }
);

const tours = await response.json();
console.log(tours);

PHP

<?php
$context = stream_context_create([
    'http' => [
        'method' => 'GET',
        'header' => 'access-token: YOUR_TOKEN'
    ]
]);

$response = file_get_contents(
    'https://apistage.projectexpedition.com/v1/return_tours?country=ireland',
    false,
    $context
);

$tours = json_decode($response, true);
print_r($tours);

Understanding the Response

A successful response returns an array of tour objects:

[
  {
    "about": {
      "name": "Cliffs of Moher Day Trip from Dublin",
      "country": "Ireland",
      "type": "Tour",
      "pe_rating": "4.8"
    },
    "itinerary": {
      "highlights": "Visit the stunning Cliffs of Moher...",
      "duration": "12 hours"
    },
    "logistics": {
      "town": "Dublin",
      "region": "Leinster",
      "hotel_pickup_offered": "Yes"
    },
    "pricing": {
      "price": 65.00,
      "currency": "EUR",
      "price_description": "per person"
    },
    "booking_meta": {
      "id": "PE12031",
      "confirmation_type": "Instant",
      "cancellation_window": 3
    }
  }
]

Complete Booking Flow

Here’s the typical flow for booking a tour:

1. Search for Tours

   Use /return_tours with filters like country, region, or coordinates.

2. Check Availability

   Call /return_availability with the product ID and date to get pricing and time slots.

3. Create Booking

   Submit a POST request to /booking with traveler details and payment info.

4. Confirm Booking

   Receive a booking reference and voucher URLs in the response.

Checking Availability

Once you find a tour, check its availability:

curl

curl -H "access-token: YOUR_TOKEN" \
  "https://apistage.projectexpedition.com/v1/return_availability?id=PE12031&date=2025-06-15&adults=2&currency=EUR"

JavaScript

const response = await fetch(
  'https://apistage.projectexpedition.com/v1/return_availability' +
  '?id=PE12031&date=2025-06-15&adults=2&currency=EUR',
  {
    headers: {
      'access-token': 'YOUR_TOKEN'
    }
  }
);

const availability = await response.json();

Creating a Booking

Submit a booking request:

curl

curl -X POST \
  -H "access-token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "PE12031",
    "date": "2025-06-15",
    "time": "7:00 am",
    "phone": "+1 555 123 4567",
    "email": "john@example.com",
    "adults": "John Smith,Jane Smith",
    "partner_ref": "MY-REF-001"
  }' \
  "https://apistage.projectexpedition.com/v1/booking"

JavaScript

const response = await fetch(
  'https://apistage.projectexpedition.com/v1/booking',
  {
    method: 'POST',
    headers: {
      'access-token': 'YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      product_id: 'PE12031',
      date: '2025-06-15',
      time: '7:00 am',
      phone: '+1 555 123 4567',
      email: 'john@example.com',
      adults: 'John Smith,Jane Smith',
      partner_ref: 'MY-REF-001'
    })
  }
);

const booking = await response.json();

Tip

Always use the staging environment (apistage.projectexpedition.com) during development. It doesn’t require IP whitelisting and has a separate daily limit.

Next Steps

• Authentication - Learn about API tokens and headers
• Environments - Staging vs Production
• Rate Limits - Usage limits and caching best practices
• Pricing Models - Understanding the 4 pricing types