Endpoints & Capabilities

Ventrata supports all OCTO Core endpoints plus optional capability extensions.

This page documents the reseller-facing octo/* capability set from the API source (dashboard/app/controllers/apis/octo_controller.rb and dashboard/app/controllers/apis/octo/*_capability.rb).

OCTO Core Endpoints

Core endpoint routes are documented in these pages:

• Products

• Availability

• Bookings

List Capabilities

get

List non-internal capabilities available from the API.

Responses

200

Successful response

application/json

idstringRequired

Capability ID to include in the Octo-Capabilities header.

Example: octo/waivers

revisionintegerRequired

Supported capability revision.

Example: 1

requiredbooleanRequired

Whether this capability is required for the product.

Example: false

dependenciesstring[]Required

Capability IDs required when this capability is requested.

docsstring · uri · nullableOptional

Capability documentation URL.

Example: https://docs.ventrata.com/capabilities/waivers

get

/capabilities

HTTPcURLJavaScriptPython

GET /octo/capabilities HTTP/1.1
Host: api.ventrata.com
Accept: */*

200

Successful response

[
  {
    "id": "octo/waivers",
    "revision": 1,
    "required": false,
    "dependencies": [],
    "docs": "https://docs.ventrata.com/capabilities/waivers"
  }
]

Who Am I

get

Return supplier, connection, and partner context for the current API key.

Responses

200

Successful response

application/json

connectionIdstringOptional

Connection identifier.

Example: conn_reseller_west_coast

partnerstringOptional

Partner value.

Example: reseller_partner

capabilitiesstring[]Optional

List of capability values.

Example: ["octo/pricing","octo/offers","octo/waivers"]

get

/whoami

HTTPcURLJavaScriptPython

GET /octo/whoami HTTP/1.1
Host: api.ventrata.com
Accept: */*

200

Successful response

{
  "supplier": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "name": "City Sightseeing Group",
    "reference": "CITY_SIGHTSEEING_GROUP",
    "website": "https://www.city-sightseeing.com",
    "contact": {
      "website": "https://www.city-sightseeing.com",
      "email": "[email protected]",
      "telephone": "[phone]",
      "address": "123 Main St, San Francisco, CA"
    },
    "endpoint": "https://hooks.example-partner.com/octo/webhook"
  },
  "connectionId": "conn_reseller_west_coast",
  "partner": "reseller_partner",
  "capabilities": [
    "octo/pricing",
    "octo/offers",
    "octo/waivers"
  ]
}

octo/* Capability Coverage

Capability ID	Internal	Documentation	API Surface
octo/pricing	No	Pricing	Pricing fields across products/availability/bookings/orders/gifts.
octo/content	No	Content	Extends product/option/unit/availability/booking content fields.
octo/offers	No	Promotions / Offers	Supplier offers and offer-aware pricing/booking responses.
octo/extras	No	Extras	Extra upsell inventory and booking extra-items behavior.
octo/packages	No	Packages	Package includes and package booking flows.
octo/pickups	No	Pickups	Pickup/dropoff fields on product/availability/booking.
octo/questions	No	Custom Questions	Question schemas and questionAnswers write flows.
octo/waivers	No	Waivers	Waiver templates on products and waiver submission/status fields on booking and unit-item flows.
octo/resources	No	Resources	Availability resources and resource allocations.
octo/rentals	No	Rentals	rentalDurationId behavior across product/availability/booking.
octo/redemption	No	Redemption	Redemption lookup, redeem/unredeem, no-show, and credential resolution flows.
octo/mappings	No	Self-Service Mapping	Self-service mapping write/read flows.
octo/cart	No	Multi-Booking Cart	Order create/list/update/confirm/cancel flows.
octo/gifts	No	Gift Vouchers	Gift voucher create/list/update/confirm/cancel flows.
octo/checkin	No	Online Check-in	Check-in lookup and check-in fields on bookings/orders/gifts.
octo/cardPayments	No	Card Payments	Card payment flows on booking/order/gift plus card payment lookup.
octo/memberships	No	Memberships	Membership lookup and membership-booking listing.
octo/adjustments	No	Price Adjustments	Extends booking create/update pricing inputs (adjustments).
octo/webhooks	No	Webhooks	Webhook create/update/list/delete and trigger flows.
octo/waitlists	No	Waitlists	Waitlist create flow.
octo/identities	Yes	Identities	Identity create/update/delete and identityId linkage.
octo/campaigns	No	Campaigns	Campaign listing endpoint support.
octo/notifications	No	Notifications	Notification subscription CRUD flows.

Capability Object Shape

Capabilities returned on product payloads and /octo/capabilities use this shape:

Field	Description
id	Capability ID to include in Octo-Capabilities.
revision	Supported, backward-compatible capability revision.
required	Whether capability is required to sell that product.
dependencies	Capability IDs that are auto-included when needed.
docs	Documentation URL when provided by the API.

Supplying Capabilities

Send requested capability IDs in the Octo-Capabilities request header on any OCTO endpoint (or X-Capabilities as the legacy alias). Capability IDs are requested uniformly via headers across all endpoints.

The response echoes applied capabilities in the Octo-Capabilities response header.