LogoLogo
SupportChangelogAPI ReferenceStatus
Distributor API
Distributor API
  • Welcome
  • Getting Started
    • Functionalities
    • Integration Process
      • Implementation Guide
    • OCTO & Prioticket
      • Feature Comparison
    • Postman & Interactive Documentation
    • Connect Once, Reach the World
      • Featured Suppliers
        • Supplier Overview Europe
        • Supplier Overview Americas
        • Supplier Overview Middle East
      • Featured Resellers
    • Statement on API Excellence
    • Frequently Asked Questions
  • Key Concepts
    • Product Structure
      • Product types and classes
      • Admission types
      • Extra Options
      • Pickup Points
      • Combi, Clusters, Bundles & Addons
        • Cluster
        • Combi
        • Addons
        • Bundle
    • Availability and Capacity
      • Availability
      • Capacity
        • Shared and Allocated Capacity
      • Availability API
    • Pricing Guide
      • Who are you?
      • Configurations
      • Variable Pricing
      • Dynamic Pricing
      • How It All Comes Together
    • Booking Logic
      • Cart Management
      • Payments
      • Cancellation & Refunds
      • Booking Questions
    • Additional Capabilities
      • Locations, Destinations and Categories
      • Recommendations
      • Promotions
      • Webhooks
      • Translations
    • Technical Concepts
      • Authentication
      • Idempotency
      • Rate Limiting
      • Timeout Handling
      • Error Handling
      • API versioning
      • Pagination
      • Formats
      • Headers
      • Caching
  • Endpoints
    • About
    • Authentication
    • System
    • Products
      • Stock
    • Availability
    • Reservations / Cart
      • Promocodes
    • Orders
      • Email & Vouchers
    • Payments
    • Contacts
    • Notifications
    • Models
  • Resources
    • Release notes
    • Roadmap
    • Postman
    • Swagger
    • Changelogs
      • Parameter Changelog
    • API Specs
      • V3.8 (Latest)
      • V3.7
      • V3.6
      • V3.5
    • Support
    • Certification
  • Status Dashboard
Powered by GitBook
On this page
  • Concepts
  • Quick Overview
  • Pickup Point Structure
  • Time Dependency Logic
  • Real-World Use Cases
  • Best Practices

Was this helpful?

Export as PDF
  1. Key Concepts
  2. Product Structure

Pickup Points

Smart Logistics for Your Experiences

Many tours and attractions rely on pickup logistics, whether you’re offering hotel transfers, bus pickups, or a meeting point at a central location. Our Pickup Points system makes it easy to define, display, and manage pickup options for your products.

Pickup Points can be mandatory, optional, or not used at all. They're linked to locations and times, and can even restrict availability depending on the booked time slot.


Concepts

  • Multiple Pickup Points: Products may offer several pickup points, each with its own location, available times, and duration.

  • Time Selection: Guests choose a pickup time from pickup_point_times. The selected time must respect availability constraints.

  • Availability Dependency: When pickup_point_availability_dependency is true, the available pickup times are dynamically filtered to ensure the pickup fits within the overall booking slot.


Quick Overview

Pickup Points are returned on the product level. A product can:

  • Require the guest to choose a pickup (MANDATORY)

  • Offer pickup optionally (OPTIONAL)

  • Not offer pickup at all (NOT_SET)

"product_pickup_point": "MANDATORY"

If pickup is available (MANDATORY or OPTIONAL), the actual pickup points are listed under product_pickup_point_details.


Pickup Point Structure

Each pickup point provides all the relevant information for display and processing during checkout.

{
  "pickup_point_id": "PICKUP_POINT_ID_123",
  "pickup_point_name": "Walkingtour at the Wyndham Apollo Hotel",
  "pickup_point_description": "Meet at the Wyndham Apollo hotel.",
  "pickup_point_type": "MEETING_POINT",
  "pickup_point_location": "LOCATION_ID_123",
  "pickup_point_time": "10:00",
  "pickup_point_times": ["10:00", "10:30", "11:00"],
  "pickup_point_duration": 30,
  "pickup_point_availability_dependency": true
}

Time Dependency Logic

If pickup_point_availability_dependency = true, only pickup times that fit within the booked availability slot will be shown.

Example

If the product starts at 11:00 and pickup takes 30 minutes, only pickup times ending before 11:00 will be allowed.

This ensures a consistent and logical experience for guests and avoids overlaps.


Real-World Use Cases

  • Hotel Pickup A guest must choose one of 5 listed hotels. Pickup is at 10:00, takes 30 mins. The tour starts at 11:00.

  • Meeting Point Only Set pickup_point_type: MEETING_POINT, and provide a clear location and description, e.g., “Look for the red umbrella.”

  • Dynamic Availability Based on the tour’s availability, pickup times adjust automatically to ensure guests arrive on time.


Best Practices

  • Validate Locations: Ensure pickup_point_location maps to a valid entry in product_locations.

  • Avoid Conflicts: Respect availability dependency when rendering selectable times.

  • Pre-fill Times: If there’s only one time per point, pre-fill to simplify UX.

  • Localize: Pickup names and descriptions should be translatable for better guest experience.

PreviousExtra OptionsNextCombi, Clusters, Bundles & Addons

Last updated 13 days ago

Was this helpful?