Overview
Get API access
API
Overview
Get API access
API

Overview

Access travel product information with enhanced capabilities using the sherpa° Products V2 API

Introduction

The Products V2 API provides comprehensive product information access with enhanced data structures and localization support. Access powerful travel product catalogs with advanced filtering, multi-currency pricing, and seamless integration with the sherpa° ecosystem.

  • Enhanced Data Structures: Improved product models with better organization and extensibility
  • Localization Support: Multi-language product descriptions and pricing
  • Advanced Filtering: Filter products by destination, nationality, travel purpose, and more
  • Multi-Currency Pricing: Real-time currency conversion and localized pricing
  • Legacy Compatibility: Optional sync with V1 system during transition period
🚀 Get Started

New to the sherpa° Products V2 API? You can be up and running in minutes using our Quickstart Guide.

Getting API Access

  1. Request API Access: Fill out our online form to get started
  2. Provide Details: Share your use case, expected volume, and integration timeline
  3. Complete Setup: We'll create your account and provide API credentials with appropriate permissions

API Key Usage

Include your api key on the header

Example
curl --location 'https://api.joinsherpa.io/v2/products' \
--header 'x-api-key: API_KEY'
🔐 Security Best Practices
  • Store API keys securely in environment variables or secret management systems - Rotate your API keys regularly for enhanced security - Never expose API keys in client-side code or public repositories - Use HTTPS for all API communications

Base URL

All Products V2 API endpoints are prefixed with /products and use version 2 in the URL path:

Production: https://api.joinsherpa.io/v2/products

Key Features

1. Enhanced Product Information Access

Access comprehensive travel product information with rich metadata including:

  • Detailed product descriptions and value propositions
  • Flexible pricing structures with multiple fee types
  • Travel purpose and destination targeting
  • Prerequisites and application requirements

2. Localization Support

  • Multi-language Descriptions: Localize product names, descriptions, and notices
  • Currency Localization: Display prices in user's preferred currency
  • Regional Customization: Tailor products for specific markets

3. Advanced Filtering & Search

Filter products by multiple criteria:

  • Destination: Target specific countries or regions
  • Nationality: Show products for specific passport holders
  • Travel Purpose: Filter by tourism, business, transit, etc.
  • Product Type: eVisa, eTA, paper visa, tourist card
  • Status: Active, inactive, or all products

4. Product Information Consolidation

  • Variant Information: Access product variants and consolidations
  • Provider Integration: Support for multiple product providers
  • Legacy Compatibility: Access to V1 system data when needed

Common Headers

All endpoints return consistent headers:

Content-Type: application/json
Cache-Control: public, max-age=3600
Vary: origin, x-affiliate-id, x-api-key

Error Responses

All endpoints can return standard error responses:

{
  "errorCode": "PRODUCT_NOT_FOUND",
  "message": "Product not found",
  "data": {
    "productId": "example-product-id"
  }
}

Common HTTP status codes:

  • 400 Bad Request - Invalid request parameters
  • 401 Unauthorized - Missing or invalid authentication
  • 403 Forbidden - Insufficient permissions
  • 404 Not Found - Product or resource not found
  • 500 Internal Server Error - Server-side errors

Caching

API responses are cached to improve performance:

  • Cache Duration: 1 hour (max-age=3600)
  • Cache Strategy: Public caching with origin and API key variation
  • Invalidation: Automatic cache invalidation when product information changes
  • Best Practices:
    • Follow the 1-hour cache duration for optimal performance
    • Implement cache invalidation for real-time updates
    • Use conditional requests for efficient data synchronization