Get product

GET /v1/products/:idOrSlug - Retrieve detailed product information by ID or slug

Endpoint

GET https://api.voyantcloud.com/v1/products/:idOrSlug

Retrieve complete details about a specific travel product including descriptions, media, pricing models, and availability information.

Authentication

Authorization · string · required

Bearer token (e.g. Authorization: Bearer YOUR_API_KEY)

Query parameters

lang · string

Optional language code (e.g., ro, fr) to return localized fields. Alias: locale.

Path parameters

idOrSlug · string · required

Product ID (TypeID with prod_ prefix) or workspace slug. Translation slugs are also supported when you pass the matching lang/locale value.

Request example

cURL

curl https://api.voyantcloud.com/v1/products/prod_01h8z3y4x2w1v0u9t8s7r6q5p4 \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

id · string · required

Unique product identifier

title · string · required

Product name/title. When lang is provided and a translation exists, this is localized.

description · string

Full product description (may contain HTML). Localized when a matching translation exists.

summary · string

Short summary for listings

slug · string

URL-friendly identifier

status · string · required

Product status: draft, active, archived

type · string

Product type: tour, experience, hotel, package, transfer, car_rental, flight

duration_days · integer

Duration in days for multi-day products

currency · string

3-letter ISO currency code

location · object

Product location information

media · array

Array of product images and videos

Show Media item properties

url · string

Media URL

type · string

Media type: image, video

alt · string

Alt text for images

sort · integer

Display order (lower numbers first)

inclusions · array

List of what’s included in the product

exclusions · array

List of what’s not included

inclusionsHtml · string

HTML content describing what’s included in the product. Localized when a matching translation exists.

exclusionsHtml · string

HTML content describing what’s not included. Localized when a matching translation exists.

termsHtml · string

HTML content with product-specific terms and conditions. Localized when a matching translation exists.

cancellationPolicy · object

The cancellation policy attached to this product, if any.

Show Cancellation policy properties

id · string

Unique policy identifier

kind · string

Policy kind: cancellation, terms, other

scope · string

Policy scope: generic, product

status · string

Policy status: draft, active

title · string

Policy title. Localized when a matching translation exists.

descriptionHtml · string

Full policy description in HTML. Localized when a matching translation exists.

highlights · array

Key highlights and features

created_at · timestamp

ISO 8601 timestamp when created

updated_at · timestamp

ISO 8601 timestamp when last updated

translation · object

Translation record for the requested lang (or null if none found).

Show Translation properties

locale · string

Requested locale code

title · string

Localized title

description · string

Localized description (HTML supported)

slug · string

Localized slug

inclusionsHtml · string

Localized inclusions HTML

exclusionsHtml · string

Localized exclusions HTML

termsHtml · string

Localized terms HTML

attributes · object

Localized attributes payload

200 Success

{
  "id": "prod_01h8z3y4x2w1v0u9t8s7r6q5p4",
  "title": "Paris City Tour",
  "description": "<p>Discover the magic of Paris with our comprehensive city tour...</p>",
  "summary": "Full-day guided tour of Paris's iconic landmarks",
  "slug": "paris-city-tour",
  "status": "active",
  "type": "tour",
  "duration_days": 1,
  "currency": "EUR",
  "location": {
    "city": "Paris",
    "country": "FR",
    "coordinates": {
      "lat": 48.8566,
      "lng": 2.3522
    }
  },
  "media": [
    {
      "url": "https://cdn.voyantcloud.com/products/paris-tour-1.jpg",
      "type": "image",
      "alt": "Eiffel Tower view",
      "sort": 0
    },
    {
      "url": "https://cdn.voyantcloud.com/products/paris-tour-2.jpg",
      "type": "image",
      "alt": "Louvre Museum",
      "sort": 1
    }
  ],
  "inclusions": [
    "Professional guide",
    "Hotel pickup and drop-off",
    "Skip-the-line tickets",
    "Lunch at local restaurant"
  ],
  "exclusions": [
    "Gratuities",
    "Personal expenses",
    "Travel insurance"
  ],
  "inclusionsHtml": "<ul><li>Professional guide</li><li>Hotel pickup and drop-off</li><li>Skip-the-line tickets</li><li>Lunch at local restaurant</li></ul>",
  "exclusionsHtml": "<ul><li>Gratuities</li><li>Personal expenses</li><li>Travel insurance</li></ul>",
  "termsHtml": "<p>Cancellation must be made 48 hours in advance for a full refund. Children under 5 travel free.</p>",
  "cancellationPolicy": {
    "id": "pol_01h9a2b3c4d5e6f7g8h9i0j1k2",
    "kind": "cancellation",
    "scope": "product",
    "status": "active",
    "title": "Flexible Cancellation Policy",
    "descriptionHtml": "<p>Free cancellation up to 48 hours before the experience starts. After that, a 50% fee applies. No-shows are non-refundable.</p>"
  },
  "highlights": [
    "Visit the Eiffel Tower",
    "Explore the Louvre Museum",
    "Seine River cruise",
    "Notre-Dame Cathedral"
  ],
  "created_at": "2024-01-15T10:00:00Z",
  "updated_at": "2024-01-15T10:00:00Z",
  "translation": null
}

Error handling

404 Not Found

The product doesn’t exist or you don’t have access to it.

Possible causes:

• Invalid product ID
• Product belongs to different workspace
• Product was deleted

Solution: Verify the product ID and ensure it belongs to your workspace.

401 Unauthorized

Missing or invalid API key.

Solution: Check your Authorization: Bearer header is set correctly.

Use cases

Product detail page

Display comprehensive product information:

async function loadProductDetails(productId, locale = "en") {
  const response = await fetch(
    `https://api.voyantcloud.com/v1/products/${productId}?lang=${locale}`,
    {
      headers: { Authorization: `Bearer ${process.env.VOYANT_API_KEY}` },
    }
  )

  if (!response.ok) {
    throw new Error("Product not found")
  }

  const product = await response.json()

  return {
    id: product.id,
    title: product.title,
    description: product.description,
    images: product.media?.filter((m) => m.type === "image") || [],
    included: product.inclusions || [],
    excluded: product.exclusions || [],
    // Use HTML content for rich formatting
    inclusionsHtml: product.inclusionsHtml,
    exclusionsHtml: product.exclusionsHtml,
    termsHtml: product.termsHtml,
    // Cancellation policy details
    cancellationPolicy: product.cancellationPolicy,
    highlights: product.highlights || [],
    location: product.location,
    duration: product.duration_days,
  }
}

Generate product schema

Create structured data for SEO:

function generateProductSchema(product) {
  return {
    "@context": "https://schema.org",
    "@type": "Product",
    name: product.title,
    description: product.summary || product.description,
    image: product.media?.[0]?.url,
    offers: {
      "@type": "Offer",
      priceCurrency: product.currency,
      availability: "https://schema.org/InStock",
    },
  }
}

Related endpoints

List products

Browse all products in your catalog

Pricing options

Get pricing options for this product

Extensions

Retrieve available add-ons

Calculate price

Calculate real-time pricing