Booking Example By Api

Example booking response for products using ‘By API’ pricing model (external API integration with duration and room type)

Pricing Model: By API

Response Structure

{
  "_comment": "Example booking response for products using 'By API' pricing model (external API integration with duration and room type)",
  "_pricing_model": "By API",
  "_key_format": "'{amount_time}::{room_type}' (e.g., 'DEFAULT::Participant', '15::Standard', 'unit_xxx::Adult')",
  "_value_format": "[{name: '...'}] - flat array of name objects",
  "info": {
    "date": "2025-05-10",
    "time": "2:00 pm",
    "pickup_time": null,
    "latestcancellation_date": "2025-05-07",
    "latestcancellation_time": "14:00:00",
    "percent_norefund": 50,
    "language": "Spanish"
  },
  "meta": {
    "status": "Confirmed",
    "product_id": "PE99001",
    "booking_ref": "PE5551234",
    "product_type": "Tour",
    "voucher_html": "https://projectexpedition.com/account/voucher/PE5551234",
    "voucher_pdf": "https://projectexpedition.com/account/voucher/PE5551234?format=pdf"
  },
  "operator": {
    "name": "Barcelona Walking Tours",
    "phone": "+34 93 555 1234",
    "email": "info@barcelonawalkingtours.com",
    "business_ref": "BWT-5551234",
    "notes": "Meet at Plaza Catalunya fountain. Guide will have a yellow umbrella."
  },
  "pax": {
    "number_travellers": "3",
    "notes": "One guest speaks only Spanish",
    "travelers_names": [
      "Carlos Garcia",
      "Maria Garcia",
      "Luis Garcia"
    ],
    "travelers_names_raw": {
      "DEFAULT::Participant": [
        {
          "name": "Carlos Garcia"
        },
        {
          "name": "Maria Garcia"
        }
      ],
      "30::Premium": [
        {
          "name": "Luis Garcia"
        }
      ]
    },
    "travellers_names_html": "<b>DEFAULT Participant</b><br><p>1. Carlos Garcia</p><p>2. Maria Garcia</p><br><b>30 Premium</b><br><p>1. Luis Garcia</p>",
    "add_ons_html": "<p>Audio Guide - EUR 5.00 x 3</p>",
    "add_ons_raw": [
      {
        "name": "Audio Guide",
        "price": 5,
        "quantity": 3,
        "currency": "EUR"
      }
    ],
    "contact_email": "carlos.garcia@example.com",
    "contact_phone": "+34 600 123 456"
  },
  "pricing": {
    "payment_status": "Paid",
    "total": 195,
    "amount_paid": 195,
    "commission": 19.5,
    "currency": "EUR",
    "payments": [
      {
        "date": "2025-04-15",
        "amount": 195,
        "currency": "EUR"
      }
    ]
  },
  "partner": {
    "name": "Ana Martinez",
    "email": "ana@spaintravel.com",
    "company": "Spain Travel Experts",
    "partner_ref": "STE-2025-00789"
  }
}