Bookings

Reserving availability and making a booking

The steps to making a booking are as follows:

1. Check Availability: Check availability and retrieve an availability ID.

2. Booking Reservation: Create a booking that reserves availability while you collect payment and customer details.

3. Booking Confirmation: Confirm the booking once payment is complete.

All routes in this page are public OCTO routes under https://api.ventrata.com/octo.

All booking routes are documented in the Endpoints section below.

Endpoints

Create Booking

post

Reserves availability by creating an ON_HOLD booking.

productId, optionId, availabilityId, and unitItems are required.

Body

application/json

Shared booking request shape for booking write operations.

productIdstringRequired

Product identifier.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681

optionIdstringRequired

Option identifier.

Example: 94cdd032-3d32-416d-b0a4-abf8b7495b8b

availabilityIdstringRequired

Availability identifier (date or date-time).

Example: 2026-05-14T09:00:00-04:00

currencystringOptional

ISO 4217 currency code.

Example: USD

deliveryMethodstringOptional

Delivery method value.

Example: VOUCHER

emailReceiptbooleanOptional

Whether email receipt is enabled.

Example: true

expirationMinutesintegerOptional

Expiration minutes numeric value.

Example: 30

notesstringOptional

Notes value.

Example: Vegetarian meal requested

quotebooleanOptional

Whether quote is enabled.

Example: false

resellerReferencestringOptional

Reseller reference value. We highly recommend including a resellerReference.

Example: RES-BOOK-10045

settlementMethodstringOptional

Settlement method value.

Example: DIRECT

tagsstring[]Optional

List of tag values.

Example: ["vip","partner"]

uuidstring · uuidOptional

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

termsAcceptedbooleanOptional

From capability octo/content.

Example: true

offerCodestringOptional

From capability octo/offers.

Example: SUMMER25

dropoffNotesstringOptional

From capability octo/pickups.

Example: Drop-off at Fisherman's Wharf.

dropoffPointIdstringOptional

From capability octo/pickups.

Example: dropoff_fishermans_wharf

dropoffRequestedbooleanOptional

From capability octo/pickups.

Example: true

pickupHotelstringOptional

From capability octo/pickups.

Example: Hilton Union Square

pickupHotelRoomstringOptional

From capability octo/pickups.

Example: 1208

pickupNotesstringOptional

From capability octo/pickups.

Example: Meet the guide by the hotel lobby.

pickupPointIdstringOptional

From capability octo/pickups.

Example: pickup_union_square

pickupRequestedbooleanOptional

From capability octo/pickups.

Example: true

rentalDurationIdstringOptional

From capability octo/rentals.

Example: rental_duration_2h

orderIdstringOptional

From capability octo/cart.

Example: ord_20260514_9f3c21

returnUrlstring · uriOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return

appendMembershipValiditybooleanOptional

From capability octo/memberships.

Example: true

identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001

Responses

200

Returns a Booking object.

application/json

activebooleanOptional

Whether active is enabled.

Example: true

aliasstring · nullableOptional

Alias value.

Example: booking-alias-001

availabilityIdstring · nullableOptional

Availability identifier (local date or local date-time).

Example: 2026-05-14T09:00:00-04:00

availabilityLocalDateEndstring · nullableOptional

Availability local date end value.

Example: 2026-05-21

availabilityLocalDateStartstring · nullableOptional

Availability local date start value.

Example: 2026-05-14

cancellablebooleanOptional

Whether cancellable is enabled.

Example: true

confirmablebooleanOptional

Whether confirmable is enabled.

Example: true

currencystringOptional

ISO 4217 currency code.

Example: USD

deliveryMethodsstring[]Optional

Delivery methods available on this booking. VOUCHER means use booking.voucher; TICKET means use booking.unitItems[].ticket.

Example: ["VOUCHER","TICKET"]

emailReceiptbooleanOptional

Whether email receipt is enabled.

Example: true

freesalebooleanOptional

Whether freesale is enabled.

Example: true

idstring · uuidRead-onlyOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

invoicePdfUrlstring · nullableOptional

Invoice pdf url URL.

Example: https://www.city-sightseeing.com

localDateTimeEndstring · date-timeOptional

Local date time end timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

localDateTimeStartstring · date-timeOptional

Local date time start timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested

optionIdstringRequired

Option identifier.

Example: 94cdd032-3d32-416d-b0a4-abf8b7495b8b

originalRebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

productIdstringOptional

Product identifier.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681

quotebooleanOptional

Whether quote is enabled.

Example: false

rebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

requiredContactFieldsstring[]Optional

List of required contact field values.

Example: ["fullName","emailAddress"]

resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045

settlementMethodstringOptional

Settlement method value.

Example: DIRECT

statusstring · enumRequired

Current status value.

Example: ON_HOLDPossible values:

supplierReferencestringOptional

Human-readable supplier reference to share with the guest and store for support and billing reconciliation.

Example: SUP-BOOK-7782

tagsstring[]Optional

List of tag values.

Example: ["vip","partner"]

testModebooleanOptional

Whether test mode is enabled.

Example: false

updatablebooleanOptional

Whether updatable is enabled.

Example: true

utcConfirmedAtstring · date-time · nullableOptional

Utc confirmed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcCreatedAtstring · date-timeOptional

Utc created at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcExpiresAtstring · date-time · nullableOptional

Utc expires at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcNoshowedAtstring · date-time · nullableOptional

Utc noshowed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRebookedAtstring · date-time · nullableOptional

Utc rebooked at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRedeemedAtstring · date-time · nullableOptional

Utc redeemed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcUpdatedAtstring · date-timeOptional

Utc updated at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

uuidstringRequired

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

visibleContactFieldsstring[]Optional

List of visible contact field values.

Example: ["fullName","emailAddress"]

termsAcceptedboolean · nullableOptional

From capability octo/content.

Example: true

offerCodestring · nullableOptional

From capability octo/offers.

Example: SUMMER25

offerIsCombinationbooleanOptional

From capability octo/offers.

Example: true

offerTitlestring · nullableOptional

From capability octo/offers.

Example: Summer Promotion

packageIncludeIdstring · nullableOptional

From capability octo/packages.

Example: package_include_id-example

packageUnitItemUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

packageUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

dropoffNotesstring · nullableOptional

From capability octo/pickups.

Example: Drop-off at Fisherman's Wharf.

dropoffPointIdstring · nullableOptional

From capability octo/pickups.

Example: dropoff_fishermans_wharf

pickupHotelstring · nullableOptional

From capability octo/pickups.

Example: Hilton Union Square

pickupHotelRoomstring · nullableOptional

From capability octo/pickups.

Example: 1208

pickupNotesstring · nullableOptional

From capability octo/pickups.

Example: Meet the guide by the hotel lobby.

pickupPointIdstring · nullableOptional

From capability octo/pickups.

Example: pickup_union_square

rentalDurationIdstring · nullableOptional

From capability octo/rentals.

Example: rental_duration_2h

orderIdstring · nullableOptional

From capability octo/cart.

Example: ord_20260514_9f3c21

orderInvoicePdfUrlstring · nullableOptional

From capability octo/cart.

Example: https://www.city-sightseeing.com

orderReferencestring · nullableOptional

From capability octo/cart.

Example: ORDER-2026-0514-1001

primarybooleanOptional

From capability octo/cart.

Example: true

checkedInbooleanOptional

From capability octo/checkin.

Example: true

checkinAvailablebooleanOptional

From capability octo/checkin.

Example: true

checkinUrlstring · nullableOptional

From capability octo/checkin.

Example: https://checkin.city-sightseeing.com/booking/89fe0192

returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return

appendMembershipValiditybooleanOptional

From capability octo/memberships.

Example: true

identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001

post

/bookings

HTTPcURLJavaScriptPython

POST /octo/bookings HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
  "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
  "availabilityId": "2026-05-14T09:00:00-04:00",
  "unitItems": [
    {
      "unitId": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7"
    },
    {
      "unitId": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7"
    },
    {
      "unitId": "6a8fbcd9-1c1c-4d22-9585-9de3dd89f6a1"
    }
  ]
}

200

Returns a Booking object.

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "alias": "booking-alias-001",
  "availabilityId": "2026-05-14T09:00:00-04:00",
  "availabilityLocalDateEnd": "2026-05-21",
  "availabilityLocalDateStart": "2026-05-14",
  "cancellable": true,
  "cancellation": {
    "refund": "FULL",
    "reason": "Customer request",
    "utcCancelledAt": "2026-05-14T13:00:00Z"
  },
  "confirmable": true,
  "contact": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]",
    "age": 34,
    "birthdate": "1992-04-23",
    "streetAddress": "223 Market Street",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94103",
    "country": "US",
    "locales": [
      "en"
    ],
    "notes": "Vegetarian meal requested",
    "allowMarketing": false,
    "taxId": "US1234567",
    "company": "Golden Gate Tours LLC",
    "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
  },
  "currency": "USD",
  "deliveryMethods": [
    "VOUCHER",
    "TICKET"
  ],
  "driver": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "emailReceipt": true,
  "freesale": true,
  "guide": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "invoicePdfUrl": "https://www.city-sightseeing.com",
  "label": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "name": "Morning City Tour"
  },
  "localDateTimeEnd": "2026-05-14T13:00:00Z",
  "localDateTimeStart": "2026-05-14T13:00:00Z",
  "metadata": {
    "bookingSource": "affiliate_portal",
    "partnerOrderId": "PO-12345"
  },
  "notes": "Vegetarian meal requested",
  "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
  "originalRebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
  "quote": false,
  "rebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "rejection": {
    "reason": "Customer request",
    "utcRejectedAt": "2026-05-14T13:00:00Z"
  },
  "requiredContactFields": [
    "fullName",
    "emailAddress"
  ],
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "settlementMethod": "DIRECT",
  "status": "ON_HOLD",
  "supplierReference": "SUP-BOOK-7782",
  "tags": [
    "vip",
    "partner"
  ],
  "testMode": false,
  "tickets": [
    {
      "redemptionMethod": "DIGITAL",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "utcNoshowedAt": "2026-05-14T13:00:00Z",
      "deliveryOptions": [
        {
          "deliveryFormat": "PDF_URL",
          "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
        }
      ]
    }
  ],
  "unitItems": [
    {
      "alias": "booking-alias-001",
      "contact": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "fullName": "Jane Doe",
        "title": "Ms",
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "[email protected]",
        "phoneNumber": "[phone]",
        "age": 34,
        "birthdate": "1992-04-23",
        "streetAddress": "223 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94103",
        "country": "US",
        "locales": [
          "en"
        ],
        "notes": "Vegetarian meal requested",
        "allowMarketing": false,
        "taxId": "US1234567",
        "company": "Golden Gate Tours LLC",
        "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
      },
      "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
      "localDateTimeEnd": "2026-05-14T13:00:00Z",
      "localDateTimeStart": "2026-05-14T13:00:00Z",
      "originalRebookingUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "originalRebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "rebookingUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "rebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "requiredContactFields": [
        "fullName",
        "emailAddress"
      ],
      "resellerReference": "RES-BOOK-10045",
      "status": "CONFIRMED",
      "supplierReference": "SUP-BOOK-7782",
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
          }
        ]
      },
      "unitId": "unit_adult",
      "unitType": "ADULT",
      "utcNoshowedAt": "2026-05-14T13:00:00Z",
      "utcRebookedAt": "2026-05-14T13:00:00Z",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "visibleContactFields": [
        "fullName",
        "emailAddress"
      ],
      "weightUnit": "kg",
      "weightValue": 20,
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offerCode": "SUMMER25",
      "offerComparisons": [
        {
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offer": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "title": "Summer Promotion",
            "label": "Save 20%",
            "code": "SUMMER25",
            "description": "20% off selected departures this month.",
            "netDiscount": "FULL",
            "restrictions": {
              "minUnits": 1,
              "maxUnits": 10,
              "minTotal": 0,
              "maxTotal": 50000,
              "unitIds": [
                "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
              ]
            },
            "usable": true,
            "unusableReason": "Offer is not valid for the selected date.",
            "membershipBenefit": {
              "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
              "title": "Summer Promotion",
              "description": "Morning departure with central pickup included."
            }
          }
        }
      ],
      "offerIsCombination": true,
      "offerTitle": "Summer Promotion",
      "extraItems": [
        {
          "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "resellerReference": "RES-BOOK-10045",
          "supplierReference": "SUP-BOOK-7782",
          "extraId": "extra_fast_track",
          "status": "CONFIRMED",
          "utcRedeemedAt": "2026-05-14T13:00:00Z",
          "contact": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "fullName": "Jane Doe",
            "title": "Ms",
            "firstName": "Jane",
            "lastName": "Doe",
            "emailAddress": "[email protected]",
            "phoneNumber": "[phone]",
            "age": 34,
            "birthdate": "1992-04-23",
            "streetAddress": "223 Market Street",
            "city": "San Francisco",
            "state": "CA",
            "postalCode": "94103",
            "country": "US",
            "locales": [
              "en"
            ],
            "notes": "Vegetarian meal requested",
            "allowMarketing": false,
            "taxId": "US1234567",
            "company": "Golden Gate Tours LLC",
            "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
          },
          "visibleContactFields": [
            "fullName",
            "emailAddress"
          ],
          "requiredContactFields": [
            "fullName",
            "emailAddress"
          ],
          "ticket": {
            "redemptionMethod": "DIGITAL",
            "utcRedeemedAt": "2026-05-14T13:00:00Z",
            "utcNoshowedAt": "2026-05-14T13:00:00Z",
            "deliveryOptions": [
              {
                "deliveryFormat": "PDF_URL",
                "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
              }
            ]
          },
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "offerIsCombination": true,
          "offerComparisons": [
            {
              "offerCode": "SUMMER25",
              "offerTitle": "Summer Promotion",
              "pricing": {
                "currency": "USD",
                "currencyPrecision": 2,
                "net": 18000,
                "original": 22000,
                "retail": 20000,
                "includedTaxes": [
                  {
                    "name": "Sales Tax",
                    "shortDescription": "Local sales tax",
                    "original": 2000,
                    "retail": 1800,
                    "net": 1600
                  }
                ],
                "offerDiscount": {
                  "retail": 2000,
                  "net": 2000,
                  "includedTaxes": [
                    {
                      "name": "Sales Tax",
                      "shortDescription": "Local sales tax",
                      "retail": 200,
                      "net": 200
                    }
                  ]
                }
              },
              "offer": {
                "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
                "tags": [
                  "vip",
                  "partner"
                ],
                "title": "Summer Promotion",
                "label": "Save 20%",
                "code": "SUMMER25",
                "description": "20% off selected departures this month.",
                "netDiscount": "FULL",
                "restrictions": {
                  "minUnits": 1,
                  "maxUnits": 10,
                  "minTotal": 0,
                  "maxTotal": 50000,
                  "unitIds": [
                    "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                    "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
                  ]
                },
                "usable": true,
                "unusableReason": "Offer is not valid for the selected date.",
                "membershipBenefit": {
                  "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
                  "title": "Summer Promotion",
                  "description": "Morning departure with central pickup included."
                }
              }
            }
          ]
        }
      ],
      "packageIncludeId": "package_include_id-example",
      "packageUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "questionAnswers": [
        {
          "questionId": "question_dietary_requirements",
          "value": "value-example"
        }
      ],
      "scans": [
        {
          "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
          "status": "CONFIRMED",
          "utcScannedAt": "2026-05-14T13:00:00Z",
          "seller": {
            "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
            "name": "Morning City Tour",
            "reference": "REF-2026-001",
            "tags": [
              "vip",
              "partner"
            ],
            "emailAddress": "[email protected]",
            "phoneNumber": "[phone]"
          }
        }
      ]
    }
  ],
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcNoshowedAt": "2026-05-14T13:00:00Z",
  "utcRebookedAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "visibleContactFields": [
    "fullName",
    "emailAddress"
  ],
  "voucher": {
    "redemptionMethod": "DIGITAL",
    "utcRedeemedAt": "2026-05-14T13:00:00Z",
    "utcNoshowedAt": "2026-05-14T13:00:00Z",
    "deliveryOptions": [
      {
        "deliveryFormat": "PDF_URL",
        "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
      }
    ]
  },
  "pricing": {
    "currency": "USD",
    "currencyPrecision": 2,
    "net": 18000,
    "original": 22000,
    "retail": 20000,
    "includedTaxes": [
      {
        "name": "Sales Tax",
        "shortDescription": "Local sales tax",
        "original": 2000,
        "retail": 1800,
        "net": 1600
      }
    ],
    "offerDiscount": {
      "retail": 2000,
      "net": 2000,
      "includedTaxes": [
        {
          "name": "Sales Tax",
          "shortDescription": "Local sales tax",
          "retail": 200,
          "net": 200
        }
      ]
    }
  },
  "termsAccepted": true,
  "offerCode": "SUMMER25",
  "offerComparisons": [
    {
      "offerCode": "SUMMER25",
      "offerTitle": "Summer Promotion",
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offer": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "title": "Summer Promotion",
        "label": "Save 20%",
        "code": "SUMMER25",
        "description": "20% off selected departures this month.",
        "netDiscount": "FULL",
        "restrictions": {
          "minUnits": 1,
          "maxUnits": 10,
          "minTotal": 0,
          "maxTotal": 50000,
          "unitIds": [
            "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
            "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
          ]
        },
        "usable": true,
        "unusableReason": "Offer is not valid for the selected date.",
        "membershipBenefit": {
          "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
          "title": "Summer Promotion",
          "description": "Morning departure with central pickup included."
        }
      }
    }
  ],
  "offerIsCombination": true,
  "offerTitle": "Summer Promotion",
  "extraItems": [
    {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "resellerReference": "RES-BOOK-10045",
      "supplierReference": "SUP-BOOK-7782",
      "extraId": "extra_fast_track",
      "status": "CONFIRMED",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "contact": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "fullName": "Jane Doe",
        "title": "Ms",
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "[email protected]",
        "phoneNumber": "[phone]",
        "age": 34,
        "birthdate": "1992-04-23",
        "streetAddress": "223 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94103",
        "country": "US",
        "locales": [
          "en"
        ],
        "notes": "Vegetarian meal requested",
        "allowMarketing": false,
        "taxId": "US1234567",
        "company": "Golden Gate Tours LLC",
        "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
      },
      "visibleContactFields": [
        "fullName",
        "emailAddress"
      ],
      "requiredContactFields": [
        "fullName",
        "emailAddress"
      ],
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
          }
        ]
      },
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offerCode": "SUMMER25",
      "offerTitle": "Summer Promotion",
      "offerIsCombination": true,
      "offerComparisons": [
        {
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offer": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "title": "Summer Promotion",
            "label": "Save 20%",
            "code": "SUMMER25",
            "description": "20% off selected departures this month.",
            "netDiscount": "FULL",
            "restrictions": {
              "minUnits": 1,
              "maxUnits": 10,
              "minTotal": 0,
              "maxTotal": 50000,
              "unitIds": [
                "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
              ]
            },
            "usable": true,
            "unusableReason": "Offer is not valid for the selected date.",
            "membershipBenefit": {
              "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
              "title": "Summer Promotion",
              "description": "Morning departure with central pickup included."
            }
          }
        }
      ]
    }
  ],
  "packageIncludeId": "package_include_id-example",
  "packageUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "packageUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "dropoffDispatch": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "name": "Morning City Tour",
    "phoneNumber": "[phone]",
    "vehicle": "coach_12"
  },
  "dropoffNotes": "Drop-off at Fisherman's Wharf.",
  "dropoffPoint": {
    "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included.",
    "localDateTime": "2026-05-14",
    "localDateTimeTo": "2026-05-14",
    "latitude": 10,
    "longitude": 10,
    "address": "123 Main St, San Francisco, CA",
    "googlePlaceId": "google_place_id-example"
  },
  "dropoffPointId": "dropoff_fishermans_wharf",
  "pickupDispatch": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "name": "Morning City Tour",
    "phoneNumber": "[phone]",
    "vehicle": "coach_12"
  },
  "pickupHotel": "Hilton Union Square",
  "pickupHotelRoom": "1208",
  "pickupNotes": "Meet the guide by the hotel lobby.",
  "pickupPoint": {
    "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included.",
    "localDateTime": "2026-05-14",
    "localDateTimeTo": "2026-05-14",
    "latitude": 10,
    "longitude": 10,
    "address": "123 Main St, San Francisco, CA",
    "googlePlaceId": "google_place_id-example"
  },
  "pickupPointId": "pickup_union_square",
  "questionAnswers": [
    {
      "questionId": "question_dietary_requirements",
      "value": "value-example"
    }
  ],
  "resourceAllocations": [
    {
      "resourceGroupId": "resource_group_front_row",
      "resourceGroup": {
        "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
        "title": "Summer Promotion",
        "split": true,
        "required": true
      },
      "resourceId": "resource_coach_12",
      "resource": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "title": "Summer Promotion",
        "capacity": 2,
        "seating": true,
        "seats": [
          {
            "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
            "row": "A",
            "column": "4",
            "status": "CONFIRMED"
          }
        ]
      },
      "seatIds": [
        "seat_one",
        "seat_two"
      ],
      "seats": [
        {
          "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
          "row": "A",
          "column": "4",
          "status": "CONFIRMED"
        }
      ],
      "paxCount": 2
    }
  ],
  "rentalDuration": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "duration": "2",
    "durationAmount": 220,
    "durationUnit": "HOUR",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included."
  },
  "rentalDurationId": "rental_duration_2h",
  "mappings": [
    {
      "resellerReference": "RES-BOOK-10045",
      "resellerStatus": "CONFIRMED",
      "resellerProduct": "grand-canyon-day-tour",
      "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
      "unitId": "unit_adult",
      "optionRequired": true,
      "unitRequired": true,
      "validityDays": 2,
      "webhookUrl": "https://www.city-sightseeing.com"
    }
  ],
  "orderId": "ord_20260514_9f3c21",
  "orderInvoicePdfUrl": "https://www.city-sightseeing.com",
  "orderReference": "ORDER-2026-0514-1001",
  "primary": true,
  "giftPayment": {
    "giftCode": "GIFT-2026-0001",
    "code": "SUMMER25",
    "amount": 220,
    "currency": "USD"
  },
  "checkedIn": true,
  "checkinAvailable": true,
  "checkinUrl": "https://checkin.city-sightseeing.com/booking/89fe0192",
  "cardPayment": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "cardPaymentId": "cp_20260514_42ad10",
    "gateway": "adyen",
    "source": "POS",
    "paid": 2,
    "totalPaid": 2,
    "totalRefunded": 2,
    "paidSurcharge": 2,
    "balance": 2,
    "surcharge": 2,
    "outstandingBalance": 2,
    "amount": 220,
    "currency": "USD",
    "currencyPrecision": 2,
    "status": "CONFIRMED",
    "reusableCards": [
      {
        "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
        "brand": "visa",
        "bin": "411111",
        "last4": "1111",
        "expMonth": 2,
        "expYear": 2
      }
    ],
    "adyen": {
      "environment": "test",
      "clientKey": "test_client_key_123",
      "session": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "sessionData": "session_data_payload"
      },
      "countryCode": "US",
      "paymentMethodsConfiguration": {}
    },
    "external": {},
    "provider": "adyen",
    "providerReference": "PROV-REF-2026-001",
    "createdAt": "2026-05-14T13:00:00Z"
  },
  "returnUrl": "https://checkout.city-sightseeing.com/return",
  "appendMembershipValidity": true,
  "membership": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "title": "Annual Membership",
    "contact": {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "tags": [
        "vip",
        "partner"
      ],
      "fullName": "Jane Doe",
      "title": "Ms",
      "firstName": "Jane",
      "lastName": "Doe",
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]",
      "age": 34,
      "birthdate": "1992-04-23",
      "streetAddress": "223 Market Street",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94103",
      "country": "US",
      "locales": [
        "en"
      ],
      "notes": "Vegetarian meal requested",
      "allowMarketing": false,
      "taxId": "US1234567",
      "company": "Golden Gate Tours LLC",
      "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
    },
    "reference": "REF-2026-001",
    "resellerReference": "RES-MEM-10045",
    "supplierReference": "SUP-MEM-7782",
    "availabilityLocalDateStart": "2026-01-01",
    "availabilityLocalDateEnd": "2026-12-31"
  },
  "adjustments": [
    {
      "per": "BOOKING",
      "amount": 220,
      "quantity": 2,
      "notes": "Vegetarian meal requested",
      "netDiscount": "NONE"
    }
  ],
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

Update Booking

patch

Updates an existing booking.

Path parameters

uuidstringRequired

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

Body

application/json

Shared booking request shape for booking write operations.

productIdstringRequired

Product identifier.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681

optionIdstringRequired

Option identifier.

Example: 94cdd032-3d32-416d-b0a4-abf8b7495b8b

availabilityIdstringRequired

Availability identifier (date or date-time).

Example: 2026-05-14T09:00:00-04:00

currencystringOptional

ISO 4217 currency code.

Example: USD

deliveryMethodstringOptional

Delivery method value.

Example: VOUCHER

emailReceiptbooleanOptional

Whether email receipt is enabled.

Example: true

expirationMinutesintegerOptional

Expiration minutes numeric value.

Example: 30

notesstringOptional

Notes value.

Example: Vegetarian meal requested

quotebooleanOptional

Whether quote is enabled.

Example: false

resellerReferencestringOptional

Reseller reference value. We highly recommend including a resellerReference.

Example: RES-BOOK-10045

settlementMethodstringOptional

Settlement method value.

Example: DIRECT

tagsstring[]Optional

List of tag values.

Example: ["vip","partner"]

uuidstring · uuidOptional

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

termsAcceptedbooleanOptional

From capability octo/content.

Example: true

offerCodestringOptional

From capability octo/offers.

Example: SUMMER25

dropoffNotesstringOptional

From capability octo/pickups.

Example: Drop-off at Fisherman's Wharf.

dropoffPointIdstringOptional

From capability octo/pickups.

Example: dropoff_fishermans_wharf

dropoffRequestedbooleanOptional

From capability octo/pickups.

Example: true

pickupHotelstringOptional

From capability octo/pickups.

Example: Hilton Union Square

pickupHotelRoomstringOptional

From capability octo/pickups.

Example: 1208

pickupNotesstringOptional

From capability octo/pickups.

Example: Meet the guide by the hotel lobby.

pickupPointIdstringOptional

From capability octo/pickups.

Example: pickup_union_square

pickupRequestedbooleanOptional

From capability octo/pickups.

Example: true

rentalDurationIdstringOptional

From capability octo/rentals.

Example: rental_duration_2h

orderIdstringOptional

From capability octo/cart.

Example: ord_20260514_9f3c21

returnUrlstring · uriOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return

appendMembershipValiditybooleanOptional

From capability octo/memberships.

Example: true

identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001

Responses

200

Returns a Booking object.

application/json

activebooleanOptional

Whether active is enabled.

Example: true

aliasstring · nullableOptional

Alias value.

Example: booking-alias-001

availabilityIdstring · nullableOptional

Availability identifier (local date or local date-time).

Example: 2026-05-14T09:00:00-04:00

availabilityLocalDateEndstring · nullableOptional

Availability local date end value.

Example: 2026-05-21

availabilityLocalDateStartstring · nullableOptional

Availability local date start value.

Example: 2026-05-14

cancellablebooleanOptional

Whether cancellable is enabled.

Example: true

confirmablebooleanOptional

Whether confirmable is enabled.

Example: true

currencystringOptional

ISO 4217 currency code.

Example: USD

deliveryMethodsstring[]Optional

Delivery methods available on this booking. VOUCHER means use booking.voucher; TICKET means use booking.unitItems[].ticket.

Example: ["VOUCHER","TICKET"]

emailReceiptbooleanOptional

Whether email receipt is enabled.

Example: true

freesalebooleanOptional

Whether freesale is enabled.

Example: true

idstring · uuidRead-onlyOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

invoicePdfUrlstring · nullableOptional

Invoice pdf url URL.

Example: https://www.city-sightseeing.com

localDateTimeEndstring · date-timeOptional

Local date time end timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

localDateTimeStartstring · date-timeOptional

Local date time start timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested

optionIdstringRequired

Option identifier.

Example: 94cdd032-3d32-416d-b0a4-abf8b7495b8b

originalRebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

productIdstringOptional

Product identifier.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681

quotebooleanOptional

Whether quote is enabled.

Example: false

rebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

requiredContactFieldsstring[]Optional

List of required contact field values.

Example: ["fullName","emailAddress"]

resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045

settlementMethodstringOptional

Settlement method value.

Example: DIRECT

statusstring · enumRequired

Current status value.

Example: ON_HOLDPossible values:

supplierReferencestringOptional

Human-readable supplier reference to share with the guest and store for support and billing reconciliation.

Example: SUP-BOOK-7782

tagsstring[]Optional

List of tag values.

Example: ["vip","partner"]

testModebooleanOptional

Whether test mode is enabled.

Example: false

updatablebooleanOptional

Whether updatable is enabled.

Example: true

utcConfirmedAtstring · date-time · nullableOptional

Utc confirmed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcCreatedAtstring · date-timeOptional

Utc created at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcExpiresAtstring · date-time · nullableOptional

Utc expires at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcNoshowedAtstring · date-time · nullableOptional

Utc noshowed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRebookedAtstring · date-time · nullableOptional

Utc rebooked at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRedeemedAtstring · date-time · nullableOptional

Utc redeemed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcUpdatedAtstring · date-timeOptional

Utc updated at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

uuidstringRequired

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

visibleContactFieldsstring[]Optional

List of visible contact field values.

Example: ["fullName","emailAddress"]

termsAcceptedboolean · nullableOptional

From capability octo/content.

Example: true

offerCodestring · nullableOptional

From capability octo/offers.

Example: SUMMER25

offerIsCombinationbooleanOptional

From capability octo/offers.

Example: true

offerTitlestring · nullableOptional

From capability octo/offers.

Example: Summer Promotion

packageIncludeIdstring · nullableOptional

From capability octo/packages.

Example: package_include_id-example

packageUnitItemUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

packageUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

dropoffNotesstring · nullableOptional

From capability octo/pickups.

Example: Drop-off at Fisherman's Wharf.

dropoffPointIdstring · nullableOptional

From capability octo/pickups.

Example: dropoff_fishermans_wharf

pickupHotelstring · nullableOptional

From capability octo/pickups.

Example: Hilton Union Square

pickupHotelRoomstring · nullableOptional

From capability octo/pickups.

Example: 1208

pickupNotesstring · nullableOptional

From capability octo/pickups.

Example: Meet the guide by the hotel lobby.

pickupPointIdstring · nullableOptional

From capability octo/pickups.

Example: pickup_union_square

rentalDurationIdstring · nullableOptional

From capability octo/rentals.

Example: rental_duration_2h

orderIdstring · nullableOptional

From capability octo/cart.

Example: ord_20260514_9f3c21

orderInvoicePdfUrlstring · nullableOptional

From capability octo/cart.

Example: https://www.city-sightseeing.com

orderReferencestring · nullableOptional

From capability octo/cart.

Example: ORDER-2026-0514-1001

primarybooleanOptional

From capability octo/cart.

Example: true

checkedInbooleanOptional

From capability octo/checkin.

Example: true

checkinAvailablebooleanOptional

From capability octo/checkin.

Example: true

checkinUrlstring · nullableOptional

From capability octo/checkin.

Example: https://checkin.city-sightseeing.com/booking/89fe0192

returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return

appendMembershipValiditybooleanOptional

From capability octo/memberships.

Example: true

identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001

patch

/bookings/{uuid}

HTTPcURLJavaScriptPython

PATCH /octo/bookings/{uuid} HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 3738

{
  "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
  "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
  "availabilityId": "2026-05-14T09:00:00-04:00",
  "unitItems": [
    {
      "unitId": "unit_adult",
      "contact": {
        "tags": [
          "vip",
          "partner"
        ],
        "fullName": "Jane Doe",
        "title": "Ms",
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "[email protected]",
        "phoneNumber": "[phone]",
        "age": 34,
        "birthdate": "1992-04-23",
        "streetAddress": "223 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94103",
        "country": "US",
        "locales": [
          "en"
        ],
        "notes": "Vegetarian meal requested",
        "allowMarketing": false,
        "taxId": "US1234567",
        "company": "Golden Gate Tours LLC",
        "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
      },
      "resellerReference": "RES-BOOK-10045",
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "weightUnit": "kg",
      "weightValue": 20,
      "extraItems": [
        {
          "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "extraId": "extra_fast_track",
          "quantity": 2,
          "resellerReference": "RES-BOOK-10045"
        }
      ],
      "questionAnswers": [
        {
          "questionId": "question_dietary_requirements",
          "value": "value-example"
        }
      ]
    }
  ],
  "contact": {
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]",
    "age": 34,
    "birthdate": "1992-04-23",
    "streetAddress": "223 Market Street",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94103",
    "country": "US",
    "locales": [
      "en"
    ],
    "notes": "Vegetarian meal requested",
    "allowMarketing": false,
    "taxId": "US1234567",
    "company": "Golden Gate Tours LLC",
    "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
  },
  "currency": "USD",
  "deliveryMethod": "VOUCHER",
  "emailReceipt": true,
  "expirationMinutes": 30,
  "metadata": {
    "bookingSource": "affiliate_portal",
    "partnerOrderId": "PO-12345"
  },
  "notes": "Vegetarian meal requested",
  "quote": false,
  "resellerReference": "RES-BOOK-10045",
  "settlementMethod": "DIRECT",
  "tags": [
    "vip",
    "partner"
  ],
  "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "termsAccepted": true,
  "offerCode": "SUMMER25",
  "extraItems": [
    {
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "extraId": "extra_fast_track",
      "quantity": 2,
      "resellerReference": "RES-BOOK-10045"
    }
  ],
  "dropoffNotes": "Drop-off at Fisherman's Wharf.",
  "dropoffPointId": "dropoff_fishermans_wharf",
  "dropoffRequested": true,
  "pickupHotel": "Hilton Union Square",
  "pickupHotelRoom": "1208",
  "pickupNotes": "Meet the guide by the hotel lobby.",
  "pickupPointId": "pickup_union_square",
  "pickupRequested": true,
  "questionAnswers": [
    {
      "questionId": "question_dietary_requirements",
      "value": "value-example"
    }
  ],
  "resourceAllocations": [
    {
      "resourceGroupId": "resource_group_front_row",
      "resourceGroup": {
        "title": "Summer Promotion",
        "split": true,
        "required": true
      },
      "resourceId": "resource_coach_12",
      "resource": {
        "title": "Summer Promotion",
        "capacity": 2,
        "seating": true,
        "seats": [
          {
            "row": "A",
            "column": "4",
            "status": "CONFIRMED"
          }
        ]
      },
      "seatIds": [
        "seat_one",
        "seat_two"
      ],
      "seats": [
        {
          "row": "A",
          "column": "4",
          "status": "CONFIRMED"
        }
      ],
      "paxCount": 2
    }
  ],
  "rentalDurationId": "rental_duration_2h",
  "orderId": "ord_20260514_9f3c21",
  "giftPayment": {
    "giftCode": "GIFT-2026-0001",
    "code": "SUMMER25",
    "amount": 220,
    "currency": "USD"
  },
  "cardPayment": {
    "gateway": "adyen",
    "source": "POS",
    "amount": 2200,
    "currency": "USD",
    "notes": "Vegetarian meal requested",
    "cancel": true,
    "cardId": "card_id-example",
    "adyen": {
      "pspReference": "PSP-REF-123456",
      "channel": "Web",
      "sessionId": "session_id-example",
      "sessionResult": "Authorised",
      "paymentMethod": {}
    },
    "external": {
      "approved": true,
      "refusalReason": "refusal_reason-example"
    }
  },
  "returnUrl": "https://checkout.city-sightseeing.com/return",
  "appendMembershipValidity": true,
  "membership": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "email": "[email protected]",
    "mobile": "[phone]",
    "country": "US",
    "reference": "REF-2026-001",
    "verification": "123456"
  },
  "identityId": "identity_customer_001"
}

200

Returns a Booking object.

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "alias": "booking-alias-001",
  "availabilityId": "2026-05-14T09:00:00-04:00",
  "availabilityLocalDateEnd": "2026-05-21",
  "availabilityLocalDateStart": "2026-05-14",
  "cancellable": true,
  "cancellation": {
    "refund": "FULL",
    "reason": "Customer request",
    "utcCancelledAt": "2026-05-14T13:00:00Z"
  },
  "confirmable": true,
  "contact": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]",
    "age": 34,
    "birthdate": "1992-04-23",
    "streetAddress": "223 Market Street",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94103",
    "country": "US",
    "locales": [
      "en"
    ],
    "notes": "Vegetarian meal requested",
    "allowMarketing": false,
    "taxId": "US1234567",
    "company": "Golden Gate Tours LLC",
    "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
  },
  "currency": "USD",
  "deliveryMethods": [
    "VOUCHER",
    "TICKET"
  ],
  "driver": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "emailReceipt": true,
  "freesale": true,
  "guide": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "invoicePdfUrl": "https://www.city-sightseeing.com",
  "label": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "name": "Morning City Tour"
  },
  "localDateTimeEnd": "2026-05-14T13:00:00Z",
  "localDateTimeStart": "2026-05-14T13:00:00Z",
  "metadata": {
    "bookingSource": "affiliate_portal",
    "partnerOrderId": "PO-12345"
  },
  "notes": "Vegetarian meal requested",
  "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
  "originalRebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
  "quote": false,
  "rebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "rejection": {
    "reason": "Customer request",
    "utcRejectedAt": "2026-05-14T13:00:00Z"
  },
  "requiredContactFields": [
    "fullName",
    "emailAddress"
  ],
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "settlementMethod": "DIRECT",
  "status": "ON_HOLD",
  "supplierReference": "SUP-BOOK-7782",
  "tags": [
    "vip",
    "partner"
  ],
  "testMode": false,
  "tickets": [
    {
      "redemptionMethod": "DIGITAL",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "utcNoshowedAt": "2026-05-14T13:00:00Z",
      "deliveryOptions": [
        {
          "deliveryFormat": "PDF_URL",
          "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
        }
      ]
    }
  ],
  "unitItems": [
    {
      "alias": "booking-alias-001",
      "contact": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "fullName": "Jane Doe",
        "title": "Ms",
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "[email protected]",
        "phoneNumber": "[phone]",
        "age": 34,
        "birthdate": "1992-04-23",
        "streetAddress": "223 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94103",
        "country": "US",
        "locales": [
          "en"
        ],
        "notes": "Vegetarian meal requested",
        "allowMarketing": false,
        "taxId": "US1234567",
        "company": "Golden Gate Tours LLC",
        "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
      },
      "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
      "localDateTimeEnd": "2026-05-14T13:00:00Z",
      "localDateTimeStart": "2026-05-14T13:00:00Z",
      "originalRebookingUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "originalRebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "rebookingUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "rebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "requiredContactFields": [
        "fullName",
        "emailAddress"
      ],
      "resellerReference": "RES-BOOK-10045",
      "status": "CONFIRMED",
      "supplierReference": "SUP-BOOK-7782",
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
          }
        ]
      },
      "unitId": "unit_adult",
      "unitType": "ADULT",
      "utcNoshowedAt": "2026-05-14T13:00:00Z",
      "utcRebookedAt": "2026-05-14T13:00:00Z",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "visibleContactFields": [
        "fullName",
        "emailAddress"
      ],
      "weightUnit": "kg",
      "weightValue": 20,
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offerCode": "SUMMER25",
      "offerComparisons": [
        {
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offer": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "title": "Summer Promotion",
            "label": "Save 20%",
            "code": "SUMMER25",
            "description": "20% off selected departures this month.",
            "netDiscount": "FULL",
            "restrictions": {
              "minUnits": 1,
              "maxUnits": 10,
              "minTotal": 0,
              "maxTotal": 50000,
              "unitIds": [
                "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
              ]
            },
            "usable": true,
            "unusableReason": "Offer is not valid for the selected date.",
            "membershipBenefit": {
              "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
              "title": "Summer Promotion",
              "description": "Morning departure with central pickup included."
            }
          }
        }
      ],
      "offerIsCombination": true,
      "offerTitle": "Summer Promotion",
      "extraItems": [
        {
          "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "resellerReference": "RES-BOOK-10045",
          "supplierReference": "SUP-BOOK-7782",
          "extraId": "extra_fast_track",
          "status": "CONFIRMED",
          "utcRedeemedAt": "2026-05-14T13:00:00Z",
          "contact": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "fullName": "Jane Doe",
            "title": "Ms",
            "firstName": "Jane",
            "lastName": "Doe",
            "emailAddress": "[email protected]",
            "phoneNumber": "[phone]",
            "age": 34,
            "birthdate": "1992-04-23",
            "streetAddress": "223 Market Street",
            "city": "San Francisco",
            "state": "CA",
            "postalCode": "94103",
            "country": "US",
            "locales": [
              "en"
            ],
            "notes": "Vegetarian meal requested",
            "allowMarketing": false,
            "taxId": "US1234567",
            "company": "Golden Gate Tours LLC",
            "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
          },
          "visibleContactFields": [
            "fullName",
            "emailAddress"
          ],
          "requiredContactFields": [
            "fullName",
            "emailAddress"
          ],
          "ticket": {
            "redemptionMethod": "DIGITAL",
            "utcRedeemedAt": "2026-05-14T13:00:00Z",
            "utcNoshowedAt": "2026-05-14T13:00:00Z",
            "deliveryOptions": [
              {
                "deliveryFormat": "PDF_URL",
                "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
              }
            ]
          },
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "offerIsCombination": true,
          "offerComparisons": [
            {
              "offerCode": "SUMMER25",
              "offerTitle": "Summer Promotion",
              "pricing": {
                "currency": "USD",
                "currencyPrecision": 2,
                "net": 18000,
                "original": 22000,
                "retail": 20000,
                "includedTaxes": [
                  {
                    "name": "Sales Tax",
                    "shortDescription": "Local sales tax",
                    "original": 2000,
                    "retail": 1800,
                    "net": 1600
                  }
                ],
                "offerDiscount": {
                  "retail": 2000,
                  "net": 2000,
                  "includedTaxes": [
                    {
                      "name": "Sales Tax",
                      "shortDescription": "Local sales tax",
                      "retail": 200,
                      "net": 200
                    }
                  ]
                }
              },
              "offer": {
                "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
                "tags": [
                  "vip",
                  "partner"
                ],
                "title": "Summer Promotion",
                "label": "Save 20%",
                "code": "SUMMER25",
                "description": "20% off selected departures this month.",
                "netDiscount": "FULL",
                "restrictions": {
                  "minUnits": 1,
                  "maxUnits": 10,
                  "minTotal": 0,
                  "maxTotal": 50000,
                  "unitIds": [
                    "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                    "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
                  ]
                },
                "usable": true,
                "unusableReason": "Offer is not valid for the selected date.",
                "membershipBenefit": {
                  "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
                  "title": "Summer Promotion",
                  "description": "Morning departure with central pickup included."
                }
              }
            }
          ]
        }
      ],
      "packageIncludeId": "package_include_id-example",
      "packageUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "questionAnswers": [
        {
          "questionId": "question_dietary_requirements",
          "value": "value-example"
        }
      ],
      "scans": [
        {
          "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
          "status": "CONFIRMED",
          "utcScannedAt": "2026-05-14T13:00:00Z",
          "seller": {
            "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
            "name": "Morning City Tour",
            "reference": "REF-2026-001",
            "tags": [
              "vip",
              "partner"
            ],
            "emailAddress": "[email protected]",
            "phoneNumber": "[phone]"
          }
        }
      ]
    }
  ],
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcNoshowedAt": "2026-05-14T13:00:00Z",
  "utcRebookedAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "visibleContactFields": [
    "fullName",
    "emailAddress"
  ],
  "voucher": {
    "redemptionMethod": "DIGITAL",
    "utcRedeemedAt": "2026-05-14T13:00:00Z",
    "utcNoshowedAt": "2026-05-14T13:00:00Z",
    "deliveryOptions": [
      {
        "deliveryFormat": "PDF_URL",
        "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
      }
    ]
  },
  "pricing": {
    "currency": "USD",
    "currencyPrecision": 2,
    "net": 18000,
    "original": 22000,
    "retail": 20000,
    "includedTaxes": [
      {
        "name": "Sales Tax",
        "shortDescription": "Local sales tax",
        "original": 2000,
        "retail": 1800,
        "net": 1600
      }
    ],
    "offerDiscount": {
      "retail": 2000,
      "net": 2000,
      "includedTaxes": [
        {
          "name": "Sales Tax",
          "shortDescription": "Local sales tax",
          "retail": 200,
          "net": 200
        }
      ]
    }
  },
  "termsAccepted": true,
  "offerCode": "SUMMER25",
  "offerComparisons": [
    {
      "offerCode": "SUMMER25",
      "offerTitle": "Summer Promotion",
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offer": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "title": "Summer Promotion",
        "label": "Save 20%",
        "code": "SUMMER25",
        "description": "20% off selected departures this month.",
        "netDiscount": "FULL",
        "restrictions": {
          "minUnits": 1,
          "maxUnits": 10,
          "minTotal": 0,
          "maxTotal": 50000,
          "unitIds": [
            "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
            "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
          ]
        },
        "usable": true,
        "unusableReason": "Offer is not valid for the selected date.",
        "membershipBenefit": {
          "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
          "title": "Summer Promotion",
          "description": "Morning departure with central pickup included."
        }
      }
    }
  ],
  "offerIsCombination": true,
  "offerTitle": "Summer Promotion",
  "extraItems": [
    {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "resellerReference": "RES-BOOK-10045",
      "supplierReference": "SUP-BOOK-7782",
      "extraId": "extra_fast_track",
      "status": "CONFIRMED",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "contact": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "fullName": "Jane Doe",
        "title": "Ms",
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "[email protected]",
        "phoneNumber": "[phone]",
        "age": 34,
        "birthdate": "1992-04-23",
        "streetAddress": "223 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94103",
        "country": "US",
        "locales": [
          "en"
        ],
        "notes": "Vegetarian meal requested",
        "allowMarketing": false,
        "taxId": "US1234567",
        "company": "Golden Gate Tours LLC",
        "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
      },
      "visibleContactFields": [
        "fullName",
        "emailAddress"
      ],
      "requiredContactFields": [
        "fullName",
        "emailAddress"
      ],
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
          }
        ]
      },
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offerCode": "SUMMER25",
      "offerTitle": "Summer Promotion",
      "offerIsCombination": true,
      "offerComparisons": [
        {
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offer": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "title": "Summer Promotion",
            "label": "Save 20%",
            "code": "SUMMER25",
            "description": "20% off selected departures this month.",
            "netDiscount": "FULL",
            "restrictions": {
              "minUnits": 1,
              "maxUnits": 10,
              "minTotal": 0,
              "maxTotal": 50000,
              "unitIds": [
                "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
              ]
            },
            "usable": true,
            "unusableReason": "Offer is not valid for the selected date.",
            "membershipBenefit": {
              "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
              "title": "Summer Promotion",
              "description": "Morning departure with central pickup included."
            }
          }
        }
      ]
    }
  ],
  "packageIncludeId": "package_include_id-example",
  "packageUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "packageUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "dropoffDispatch": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "name": "Morning City Tour",
    "phoneNumber": "[phone]",
    "vehicle": "coach_12"
  },
  "dropoffNotes": "Drop-off at Fisherman's Wharf.",
  "dropoffPoint": {
    "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included.",
    "localDateTime": "2026-05-14",
    "localDateTimeTo": "2026-05-14",
    "latitude": 10,
    "longitude": 10,
    "address": "123 Main St, San Francisco, CA",
    "googlePlaceId": "google_place_id-example"
  },
  "dropoffPointId": "dropoff_fishermans_wharf",
  "pickupDispatch": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "name": "Morning City Tour",
    "phoneNumber": "[phone]",
    "vehicle": "coach_12"
  },
  "pickupHotel": "Hilton Union Square",
  "pickupHotelRoom": "1208",
  "pickupNotes": "Meet the guide by the hotel lobby.",
  "pickupPoint": {
    "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included.",
    "localDateTime": "2026-05-14",
    "localDateTimeTo": "2026-05-14",
    "latitude": 10,
    "longitude": 10,
    "address": "123 Main St, San Francisco, CA",
    "googlePlaceId": "google_place_id-example"
  },
  "pickupPointId": "pickup_union_square",
  "questionAnswers": [
    {
      "questionId": "question_dietary_requirements",
      "value": "value-example"
    }
  ],
  "resourceAllocations": [
    {
      "resourceGroupId": "resource_group_front_row",
      "resourceGroup": {
        "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
        "title": "Summer Promotion",
        "split": true,
        "required": true
      },
      "resourceId": "resource_coach_12",
      "resource": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "title": "Summer Promotion",
        "capacity": 2,
        "seating": true,
        "seats": [
          {
            "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
            "row": "A",
            "column": "4",
            "status": "CONFIRMED"
          }
        ]
      },
      "seatIds": [
        "seat_one",
        "seat_two"
      ],
      "seats": [
        {
          "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
          "row": "A",
          "column": "4",
          "status": "CONFIRMED"
        }
      ],
      "paxCount": 2
    }
  ],
  "rentalDuration": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "duration": "2",
    "durationAmount": 220,
    "durationUnit": "HOUR",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included."
  },
  "rentalDurationId": "rental_duration_2h",
  "mappings": [
    {
      "resellerReference": "RES-BOOK-10045",
      "resellerStatus": "CONFIRMED",
      "resellerProduct": "grand-canyon-day-tour",
      "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
      "unitId": "unit_adult",
      "optionRequired": true,
      "unitRequired": true,
      "validityDays": 2,
      "webhookUrl": "https://www.city-sightseeing.com"
    }
  ],
  "orderId": "ord_20260514_9f3c21",
  "orderInvoicePdfUrl": "https://www.city-sightseeing.com",
  "orderReference": "ORDER-2026-0514-1001",
  "primary": true,
  "giftPayment": {
    "giftCode": "GIFT-2026-0001",
    "code": "SUMMER25",
    "amount": 220,
    "currency": "USD"
  },
  "checkedIn": true,
  "checkinAvailable": true,
  "checkinUrl": "https://checkin.city-sightseeing.com/booking/89fe0192",
  "cardPayment": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "cardPaymentId": "cp_20260514_42ad10",
    "gateway": "adyen",
    "source": "POS",
    "paid": 2,
    "totalPaid": 2,
    "totalRefunded": 2,
    "paidSurcharge": 2,
    "balance": 2,
    "surcharge": 2,
    "outstandingBalance": 2,
    "amount": 220,
    "currency": "USD",
    "currencyPrecision": 2,
    "status": "CONFIRMED",
    "reusableCards": [
      {
        "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
        "brand": "visa",
        "bin": "411111",
        "last4": "1111",
        "expMonth": 2,
        "expYear": 2
      }
    ],
    "adyen": {
      "environment": "test",
      "clientKey": "test_client_key_123",
      "session": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "sessionData": "session_data_payload"
      },
      "countryCode": "US",
      "paymentMethodsConfiguration": {}
    },
    "external": {},
    "provider": "adyen",
    "providerReference": "PROV-REF-2026-001",
    "createdAt": "2026-05-14T13:00:00Z"
  },
  "returnUrl": "https://checkout.city-sightseeing.com/return",
  "appendMembershipValidity": true,
  "membership": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "title": "Annual Membership",
    "contact": {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "tags": [
        "vip",
        "partner"
      ],
      "fullName": "Jane Doe",
      "title": "Ms",
      "firstName": "Jane",
      "lastName": "Doe",
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]",
      "age": 34,
      "birthdate": "1992-04-23",
      "streetAddress": "223 Market Street",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94103",
      "country": "US",
      "locales": [
        "en"
      ],
      "notes": "Vegetarian meal requested",
      "allowMarketing": false,
      "taxId": "US1234567",
      "company": "Golden Gate Tours LLC",
      "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
    },
    "reference": "REF-2026-001",
    "resellerReference": "RES-MEM-10045",
    "supplierReference": "SUP-MEM-7782",
    "availabilityLocalDateStart": "2026-01-01",
    "availabilityLocalDateEnd": "2026-12-31"
  },
  "adjustments": [
    {
      "per": "BOOKING",
      "amount": 220,
      "quantity": 2,
      "notes": "Vegetarian meal requested",
      "netDiscount": "NONE"
    }
  ],
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

Booking Confirmation

post

Confirms an existing booking referenced by path UUID.

After confirmation, the most important fields in the Booking response are:

• supplierReference: Human-readable supplier reference to share with the guest and store for support and billing reconciliation.
• voucher: Present for per-booking delivery when booking.deliveryMethods includes VOUCHER.
• unitItems[].ticket: Present for per-person delivery when booking.deliveryMethods includes TICKET.
• pricing.retail: Retail amount in minor units that you must charge the guest for this booking.
• pricing.net: Net amount in minor units that the supplier invoices for this booking.

If both VOUCHER and TICKET are available, choose the format the guest prefers: one voucher for the booking or one ticket per unit item.

The voucher and ticket objects have the same shape and include guest-facing media in deliveryOptions (for example PDF_URL, QRCODE, and wallet links).

Path parameters

uuidstringRequired

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

Body

application/json

Request schema for booking confirmation. This endpoint documents contact updates and an optional reseller reference.

resellerReferencestringOptional

Reseller reference value. We highly recommend including a resellerReference.

Example: RES-BOOK-10045

Responses

200

Returns a Booking object.

application/json

activebooleanOptional

Whether active is enabled.

Example: true

aliasstring · nullableOptional

Alias value.

Example: booking-alias-001

availabilityIdstring · nullableOptional

Availability identifier (local date or local date-time).

Example: 2026-05-14T09:00:00-04:00

availabilityLocalDateEndstring · nullableOptional

Availability local date end value.

Example: 2026-05-21

availabilityLocalDateStartstring · nullableOptional

Availability local date start value.

Example: 2026-05-14

cancellablebooleanOptional

Whether cancellable is enabled.

Example: true

confirmablebooleanOptional

Whether confirmable is enabled.

Example: true

currencystringOptional

ISO 4217 currency code.

Example: USD

deliveryMethodsstring[]Optional

Delivery methods available on this booking. VOUCHER means use booking.voucher; TICKET means use booking.unitItems[].ticket.

Example: ["VOUCHER","TICKET"]

emailReceiptbooleanOptional

Whether email receipt is enabled.

Example: true

freesalebooleanOptional

Whether freesale is enabled.

Example: true

idstring · uuidRead-onlyOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

invoicePdfUrlstring · nullableOptional

Invoice pdf url URL.

Example: https://www.city-sightseeing.com

localDateTimeEndstring · date-timeOptional

Local date time end timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

localDateTimeStartstring · date-timeOptional

Local date time start timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested

optionIdstringRequired

Option identifier.

Example: 94cdd032-3d32-416d-b0a4-abf8b7495b8b

originalRebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

productIdstringOptional

Product identifier.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681

quotebooleanOptional

Whether quote is enabled.

Example: false

rebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

requiredContactFieldsstring[]Optional

List of required contact field values.

Example: ["fullName","emailAddress"]

resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045

settlementMethodstringOptional

Settlement method value.

Example: DIRECT

statusstring · enumRequired

Current status value.

Example: ON_HOLDPossible values:

supplierReferencestringOptional

Human-readable supplier reference to share with the guest and store for support and billing reconciliation.

Example: SUP-BOOK-7782

tagsstring[]Optional

List of tag values.

Example: ["vip","partner"]

testModebooleanOptional

Whether test mode is enabled.

Example: false

updatablebooleanOptional

Whether updatable is enabled.

Example: true

utcConfirmedAtstring · date-time · nullableOptional

Utc confirmed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcCreatedAtstring · date-timeOptional

Utc created at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcExpiresAtstring · date-time · nullableOptional

Utc expires at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcNoshowedAtstring · date-time · nullableOptional

Utc noshowed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRebookedAtstring · date-time · nullableOptional

Utc rebooked at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRedeemedAtstring · date-time · nullableOptional

Utc redeemed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcUpdatedAtstring · date-timeOptional

Utc updated at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

uuidstringRequired

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

visibleContactFieldsstring[]Optional

List of visible contact field values.

Example: ["fullName","emailAddress"]

termsAcceptedboolean · nullableOptional

From capability octo/content.

Example: true

offerCodestring · nullableOptional

From capability octo/offers.

Example: SUMMER25

offerIsCombinationbooleanOptional

From capability octo/offers.

Example: true

offerTitlestring · nullableOptional

From capability octo/offers.

Example: Summer Promotion

packageIncludeIdstring · nullableOptional

From capability octo/packages.

Example: package_include_id-example

packageUnitItemUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

packageUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

dropoffNotesstring · nullableOptional

From capability octo/pickups.

Example: Drop-off at Fisherman's Wharf.

dropoffPointIdstring · nullableOptional

From capability octo/pickups.

Example: dropoff_fishermans_wharf

pickupHotelstring · nullableOptional

From capability octo/pickups.

Example: Hilton Union Square

pickupHotelRoomstring · nullableOptional

From capability octo/pickups.

Example: 1208

pickupNotesstring · nullableOptional

From capability octo/pickups.

Example: Meet the guide by the hotel lobby.

pickupPointIdstring · nullableOptional

From capability octo/pickups.

Example: pickup_union_square

rentalDurationIdstring · nullableOptional

From capability octo/rentals.

Example: rental_duration_2h

orderIdstring · nullableOptional

From capability octo/cart.

Example: ord_20260514_9f3c21

orderInvoicePdfUrlstring · nullableOptional

From capability octo/cart.

Example: https://www.city-sightseeing.com

orderReferencestring · nullableOptional

From capability octo/cart.

Example: ORDER-2026-0514-1001

primarybooleanOptional

From capability octo/cart.

Example: true

checkedInbooleanOptional

From capability octo/checkin.

Example: true

checkinAvailablebooleanOptional

From capability octo/checkin.

Example: true

checkinUrlstring · nullableOptional

From capability octo/checkin.

Example: https://checkin.city-sightseeing.com/booking/89fe0192

returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return

appendMembershipValiditybooleanOptional

From capability octo/memberships.

Example: true

identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001

post

/bookings/{uuid}/confirm

HTTPcURLJavaScriptPython

POST /octo/bookings/{uuid}/confirm HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "resellerReference": "RES-BOOK-10045",
  "contact": {
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]",
    "country": "US"
  }
}

200

Returns a Booking object.

{
  "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "status": "CONFIRMED",
  "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
  "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
  "availabilityId": "2026-03-04T18:30:00+01:00",
  "supplierReference": "SUP-20260304-009871",
  "deliveryMethods": [
    "VOUCHER",
    "TICKET"
  ],
  "voucher": {
    "redemptionMethod": "DIGITAL",
    "utcRedeemedAt": null,
    "utcNoshowedAt": null,
    "deliveryOptions": [
      {
        "deliveryFormat": "PDF_URL",
        "deliveryValue": "https://api.ventrata.com/octo/download/booking/89fe0192-ddcd-430a-b285-e1396a4725d2.pdf"
      },
      {
        "deliveryFormat": "QRCODE",
        "deliveryValue": "BK-89FE0192"
      }
    ]
  },
  "unitItems": [
    {
      "uuid": "11111111-2222-4333-8444-555555555555",
      "status": "CONFIRMED",
      "unitId": "64dcc0ff-39f4-479d-83f4-0325f271dc46",
      "unitType": "ADULT",
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": null,
        "utcNoshowedAt": null,
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/ticket/11111111-2222-4333-8444-555555555555.pdf"
          },
          {
            "deliveryFormat": "QRCODE",
            "deliveryValue": "TKT-11111111"
          }
        ]
      }
    },
    {
      "uuid": "66666666-7777-4888-9999-aaaaaaaaaaaa",
      "status": "CONFIRMED",
      "unitId": "abcccfe5-ebd6-4853-a5a7-618b5506c5fc",
      "unitType": "CHILD",
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": null,
        "utcNoshowedAt": null,
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/ticket/66666666-7777-4888-9999-aaaaaaaaaaaa.pdf"
          },
          {
            "deliveryFormat": "QRCODE",
            "deliveryValue": "TKT-66666666"
          }
        ]
      }
    }
  ],
  "pricing": {
    "original": 4600,
    "retail": 4600,
    "net": 3220,
    "currency": "USD",
    "currencyPrecision": 2,
    "includedTaxes": [
      {
        "name": "Sales Tax",
        "shortDescription": "Local sales tax",
        "original": 418,
        "retail": 418,
        "net": 292
      }
    ]
  }
}

Booking Cancellation

post

Cancels a booking.

Path parameters

uuidstringRequired

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

Body

application/json

reasonstringOptional

Reason for the requested action.

Example: Customer request

Responses

200

Returns a Booking object.

application/json

activebooleanOptional

Whether active is enabled.

Example: true

aliasstring · nullableOptional

Alias value.

Example: booking-alias-001

availabilityIdstring · nullableOptional

Availability identifier (local date or local date-time).

Example: 2026-05-14T09:00:00-04:00

availabilityLocalDateEndstring · nullableOptional

Availability local date end value.

Example: 2026-05-21

availabilityLocalDateStartstring · nullableOptional

Availability local date start value.

Example: 2026-05-14

cancellablebooleanOptional

Whether cancellable is enabled.

Example: true

confirmablebooleanOptional

Whether confirmable is enabled.

Example: true

currencystringOptional

ISO 4217 currency code.

Example: USD

deliveryMethodsstring[]Optional

Delivery methods available on this booking. VOUCHER means use booking.voucher; TICKET means use booking.unitItems[].ticket.

Example: ["VOUCHER","TICKET"]

emailReceiptbooleanOptional

Whether email receipt is enabled.

Example: true

freesalebooleanOptional

Whether freesale is enabled.

Example: true

idstring · uuidRead-onlyOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

invoicePdfUrlstring · nullableOptional

Invoice pdf url URL.

Example: https://www.city-sightseeing.com

localDateTimeEndstring · date-timeOptional

Local date time end timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

localDateTimeStartstring · date-timeOptional

Local date time start timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested

optionIdstringRequired

Option identifier.

Example: 94cdd032-3d32-416d-b0a4-abf8b7495b8b

originalRebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

productIdstringOptional

Product identifier.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681

quotebooleanOptional

Whether quote is enabled.

Example: false

rebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

requiredContactFieldsstring[]Optional

List of required contact field values.

Example: ["fullName","emailAddress"]

resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045

settlementMethodstringOptional

Settlement method value.

Example: DIRECT

statusstring · enumRequired

Current status value.

Example: ON_HOLDPossible values:

supplierReferencestringOptional

Human-readable supplier reference to share with the guest and store for support and billing reconciliation.

Example: SUP-BOOK-7782

tagsstring[]Optional

List of tag values.

Example: ["vip","partner"]

testModebooleanOptional

Whether test mode is enabled.

Example: false

updatablebooleanOptional

Whether updatable is enabled.

Example: true

utcConfirmedAtstring · date-time · nullableOptional

Utc confirmed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcCreatedAtstring · date-timeOptional

Utc created at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcExpiresAtstring · date-time · nullableOptional

Utc expires at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcNoshowedAtstring · date-time · nullableOptional

Utc noshowed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRebookedAtstring · date-time · nullableOptional

Utc rebooked at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRedeemedAtstring · date-time · nullableOptional

Utc redeemed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcUpdatedAtstring · date-timeOptional

Utc updated at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

uuidstringRequired

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

visibleContactFieldsstring[]Optional

List of visible contact field values.

Example: ["fullName","emailAddress"]

termsAcceptedboolean · nullableOptional

From capability octo/content.

Example: true

offerCodestring · nullableOptional

From capability octo/offers.

Example: SUMMER25

offerIsCombinationbooleanOptional

From capability octo/offers.

Example: true

offerTitlestring · nullableOptional

From capability octo/offers.

Example: Summer Promotion

packageIncludeIdstring · nullableOptional

From capability octo/packages.

Example: package_include_id-example

packageUnitItemUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

packageUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

dropoffNotesstring · nullableOptional

From capability octo/pickups.

Example: Drop-off at Fisherman's Wharf.

dropoffPointIdstring · nullableOptional

From capability octo/pickups.

Example: dropoff_fishermans_wharf

pickupHotelstring · nullableOptional

From capability octo/pickups.

Example: Hilton Union Square

pickupHotelRoomstring · nullableOptional

From capability octo/pickups.

Example: 1208

pickupNotesstring · nullableOptional

From capability octo/pickups.

Example: Meet the guide by the hotel lobby.

pickupPointIdstring · nullableOptional

From capability octo/pickups.

Example: pickup_union_square

rentalDurationIdstring · nullableOptional

From capability octo/rentals.

Example: rental_duration_2h

orderIdstring · nullableOptional

From capability octo/cart.

Example: ord_20260514_9f3c21

orderInvoicePdfUrlstring · nullableOptional

From capability octo/cart.

Example: https://www.city-sightseeing.com

orderReferencestring · nullableOptional

From capability octo/cart.

Example: ORDER-2026-0514-1001

primarybooleanOptional

From capability octo/cart.

Example: true

checkedInbooleanOptional

From capability octo/checkin.

Example: true

checkinAvailablebooleanOptional

From capability octo/checkin.

Example: true

checkinUrlstring · nullableOptional

From capability octo/checkin.

Example: https://checkin.city-sightseeing.com/booking/89fe0192

returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return

appendMembershipValiditybooleanOptional

From capability octo/memberships.

Example: true

identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001

post

/bookings/{uuid}/cancel

HTTPcURLJavaScriptPython

POST /octo/bookings/{uuid}/cancel HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "reason": "Customer request"
}

200

Returns a Booking object.

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "alias": "booking-alias-001",
  "availabilityId": "2026-05-14T09:00:00-04:00",
  "availabilityLocalDateEnd": "2026-05-21",
  "availabilityLocalDateStart": "2026-05-14",
  "cancellable": true,
  "cancellation": {
    "refund": "FULL",
    "reason": "Customer request",
    "utcCancelledAt": "2026-05-14T13:00:00Z"
  },
  "confirmable": true,
  "contact": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]",
    "age": 34,
    "birthdate": "1992-04-23",
    "streetAddress": "223 Market Street",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94103",
    "country": "US",
    "locales": [
      "en"
    ],
    "notes": "Vegetarian meal requested",
    "allowMarketing": false,
    "taxId": "US1234567",
    "company": "Golden Gate Tours LLC",
    "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
  },
  "currency": "USD",
  "deliveryMethods": [
    "VOUCHER",
    "TICKET"
  ],
  "driver": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "emailReceipt": true,
  "freesale": true,
  "guide": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "invoicePdfUrl": "https://www.city-sightseeing.com",
  "label": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "name": "Morning City Tour"
  },
  "localDateTimeEnd": "2026-05-14T13:00:00Z",
  "localDateTimeStart": "2026-05-14T13:00:00Z",
  "metadata": {
    "bookingSource": "affiliate_portal",
    "partnerOrderId": "PO-12345"
  },
  "notes": "Vegetarian meal requested",
  "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
  "originalRebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
  "quote": false,
  "rebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "rejection": {
    "reason": "Customer request",
    "utcRejectedAt": "2026-05-14T13:00:00Z"
  },
  "requiredContactFields": [
    "fullName",
    "emailAddress"
  ],
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "settlementMethod": "DIRECT",
  "status": "ON_HOLD",
  "supplierReference": "SUP-BOOK-7782",
  "tags": [
    "vip",
    "partner"
  ],
  "testMode": false,
  "tickets": [
    {
      "redemptionMethod": "DIGITAL",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "utcNoshowedAt": "2026-05-14T13:00:00Z",
      "deliveryOptions": [
        {
          "deliveryFormat": "PDF_URL",
          "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
        }
      ]
    }
  ],
  "unitItems": [
    {
      "alias": "booking-alias-001",
      "contact": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "fullName": "Jane Doe",
        "title": "Ms",
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "[email protected]",
        "phoneNumber": "[phone]",
        "age": 34,
        "birthdate": "1992-04-23",
        "streetAddress": "223 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94103",
        "country": "US",
        "locales": [
          "en"
        ],
        "notes": "Vegetarian meal requested",
        "allowMarketing": false,
        "taxId": "US1234567",
        "company": "Golden Gate Tours LLC",
        "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
      },
      "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
      "localDateTimeEnd": "2026-05-14T13:00:00Z",
      "localDateTimeStart": "2026-05-14T13:00:00Z",
      "originalRebookingUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "originalRebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "rebookingUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "rebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "requiredContactFields": [
        "fullName",
        "emailAddress"
      ],
      "resellerReference": "RES-BOOK-10045",
      "status": "CONFIRMED",
      "supplierReference": "SUP-BOOK-7782",
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
          }
        ]
      },
      "unitId": "unit_adult",
      "unitType": "ADULT",
      "utcNoshowedAt": "2026-05-14T13:00:00Z",
      "utcRebookedAt": "2026-05-14T13:00:00Z",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "visibleContactFields": [
        "fullName",
        "emailAddress"
      ],
      "weightUnit": "kg",
      "weightValue": 20,
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offerCode": "SUMMER25",
      "offerComparisons": [
        {
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offer": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "title": "Summer Promotion",
            "label": "Save 20%",
            "code": "SUMMER25",
            "description": "20% off selected departures this month.",
            "netDiscount": "FULL",
            "restrictions": {
              "minUnits": 1,
              "maxUnits": 10,
              "minTotal": 0,
              "maxTotal": 50000,
              "unitIds": [
                "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
              ]
            },
            "usable": true,
            "unusableReason": "Offer is not valid for the selected date.",
            "membershipBenefit": {
              "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
              "title": "Summer Promotion",
              "description": "Morning departure with central pickup included."
            }
          }
        }
      ],
      "offerIsCombination": true,
      "offerTitle": "Summer Promotion",
      "extraItems": [
        {
          "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "resellerReference": "RES-BOOK-10045",
          "supplierReference": "SUP-BOOK-7782",
          "extraId": "extra_fast_track",
          "status": "CONFIRMED",
          "utcRedeemedAt": "2026-05-14T13:00:00Z",
          "contact": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "fullName": "Jane Doe",
            "title": "Ms",
            "firstName": "Jane",
            "lastName": "Doe",
            "emailAddress": "[email protected]",
            "phoneNumber": "[phone]",
            "age": 34,
            "birthdate": "1992-04-23",
            "streetAddress": "223 Market Street",
            "city": "San Francisco",
            "state": "CA",
            "postalCode": "94103",
            "country": "US",
            "locales": [
              "en"
            ],
            "notes": "Vegetarian meal requested",
            "allowMarketing": false,
            "taxId": "US1234567",
            "company": "Golden Gate Tours LLC",
            "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
          },
          "visibleContactFields": [
            "fullName",
            "emailAddress"
          ],
          "requiredContactFields": [
            "fullName",
            "emailAddress"
          ],
          "ticket": {
            "redemptionMethod": "DIGITAL",
            "utcRedeemedAt": "2026-05-14T13:00:00Z",
            "utcNoshowedAt": "2026-05-14T13:00:00Z",
            "deliveryOptions": [
              {
                "deliveryFormat": "PDF_URL",
                "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
              }
            ]
          },
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "offerIsCombination": true,
          "offerComparisons": [
            {
              "offerCode": "SUMMER25",
              "offerTitle": "Summer Promotion",
              "pricing": {
                "currency": "USD",
                "currencyPrecision": 2,
                "net": 18000,
                "original": 22000,
                "retail": 20000,
                "includedTaxes": [
                  {
                    "name": "Sales Tax",
                    "shortDescription": "Local sales tax",
                    "original": 2000,
                    "retail": 1800,
                    "net": 1600
                  }
                ],
                "offerDiscount": {
                  "retail": 2000,
                  "net": 2000,
                  "includedTaxes": [
                    {
                      "name": "Sales Tax",
                      "shortDescription": "Local sales tax",
                      "retail": 200,
                      "net": 200
                    }
                  ]
                }
              },
              "offer": {
                "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
                "tags": [
                  "vip",
                  "partner"
                ],
                "title": "Summer Promotion",
                "label": "Save 20%",
                "code": "SUMMER25",
                "description": "20% off selected departures this month.",
                "netDiscount": "FULL",
                "restrictions": {
                  "minUnits": 1,
                  "maxUnits": 10,
                  "minTotal": 0,
                  "maxTotal": 50000,
                  "unitIds": [
                    "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                    "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
                  ]
                },
                "usable": true,
                "unusableReason": "Offer is not valid for the selected date.",
                "membershipBenefit": {
                  "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
                  "title": "Summer Promotion",
                  "description": "Morning departure with central pickup included."
                }
              }
            }
          ]
        }
      ],
      "packageIncludeId": "package_include_id-example",
      "packageUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "questionAnswers": [
        {
          "questionId": "question_dietary_requirements",
          "value": "value-example"
        }
      ],
      "scans": [
        {
          "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
          "status": "CONFIRMED",
          "utcScannedAt": "2026-05-14T13:00:00Z",
          "seller": {
            "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
            "name": "Morning City Tour",
            "reference": "REF-2026-001",
            "tags": [
              "vip",
              "partner"
            ],
            "emailAddress": "[email protected]",
            "phoneNumber": "[phone]"
          }
        }
      ]
    }
  ],
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcNoshowedAt": "2026-05-14T13:00:00Z",
  "utcRebookedAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "visibleContactFields": [
    "fullName",
    "emailAddress"
  ],
  "voucher": {
    "redemptionMethod": "DIGITAL",
    "utcRedeemedAt": "2026-05-14T13:00:00Z",
    "utcNoshowedAt": "2026-05-14T13:00:00Z",
    "deliveryOptions": [
      {
        "deliveryFormat": "PDF_URL",
        "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
      }
    ]
  },
  "pricing": {
    "currency": "USD",
    "currencyPrecision": 2,
    "net": 18000,
    "original": 22000,
    "retail": 20000,
    "includedTaxes": [
      {
        "name": "Sales Tax",
        "shortDescription": "Local sales tax",
        "original": 2000,
        "retail": 1800,
        "net": 1600
      }
    ],
    "offerDiscount": {
      "retail": 2000,
      "net": 2000,
      "includedTaxes": [
        {
          "name": "Sales Tax",
          "shortDescription": "Local sales tax",
          "retail": 200,
          "net": 200
        }
      ]
    }
  },
  "termsAccepted": true,
  "offerCode": "SUMMER25",
  "offerComparisons": [
    {
      "offerCode": "SUMMER25",
      "offerTitle": "Summer Promotion",
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offer": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "title": "Summer Promotion",
        "label": "Save 20%",
        "code": "SUMMER25",
        "description": "20% off selected departures this month.",
        "netDiscount": "FULL",
        "restrictions": {
          "minUnits": 1,
          "maxUnits": 10,
          "minTotal": 0,
          "maxTotal": 50000,
          "unitIds": [
            "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
            "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
          ]
        },
        "usable": true,
        "unusableReason": "Offer is not valid for the selected date.",
        "membershipBenefit": {
          "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
          "title": "Summer Promotion",
          "description": "Morning departure with central pickup included."
        }
      }
    }
  ],
  "offerIsCombination": true,
  "offerTitle": "Summer Promotion",
  "extraItems": [
    {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "resellerReference": "RES-BOOK-10045",
      "supplierReference": "SUP-BOOK-7782",
      "extraId": "extra_fast_track",
      "status": "CONFIRMED",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "contact": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "fullName": "Jane Doe",
        "title": "Ms",
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "[email protected]",
        "phoneNumber": "[phone]",
        "age": 34,
        "birthdate": "1992-04-23",
        "streetAddress": "223 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94103",
        "country": "US",
        "locales": [
          "en"
        ],
        "notes": "Vegetarian meal requested",
        "allowMarketing": false,
        "taxId": "US1234567",
        "company": "Golden Gate Tours LLC",
        "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
      },
      "visibleContactFields": [
        "fullName",
        "emailAddress"
      ],
      "requiredContactFields": [
        "fullName",
        "emailAddress"
      ],
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
          }
        ]
      },
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offerCode": "SUMMER25",
      "offerTitle": "Summer Promotion",
      "offerIsCombination": true,
      "offerComparisons": [
        {
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offer": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "title": "Summer Promotion",
            "label": "Save 20%",
            "code": "SUMMER25",
            "description": "20% off selected departures this month.",
            "netDiscount": "FULL",
            "restrictions": {
              "minUnits": 1,
              "maxUnits": 10,
              "minTotal": 0,
              "maxTotal": 50000,
              "unitIds": [
                "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
              ]
            },
            "usable": true,
            "unusableReason": "Offer is not valid for the selected date.",
            "membershipBenefit": {
              "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
              "title": "Summer Promotion",
              "description": "Morning departure with central pickup included."
            }
          }
        }
      ]
    }
  ],
  "packageIncludeId": "package_include_id-example",
  "packageUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "packageUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "dropoffDispatch": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "name": "Morning City Tour",
    "phoneNumber": "[phone]",
    "vehicle": "coach_12"
  },
  "dropoffNotes": "Drop-off at Fisherman's Wharf.",
  "dropoffPoint": {
    "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included.",
    "localDateTime": "2026-05-14",
    "localDateTimeTo": "2026-05-14",
    "latitude": 10,
    "longitude": 10,
    "address": "123 Main St, San Francisco, CA",
    "googlePlaceId": "google_place_id-example"
  },
  "dropoffPointId": "dropoff_fishermans_wharf",
  "pickupDispatch": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "name": "Morning City Tour",
    "phoneNumber": "[phone]",
    "vehicle": "coach_12"
  },
  "pickupHotel": "Hilton Union Square",
  "pickupHotelRoom": "1208",
  "pickupNotes": "Meet the guide by the hotel lobby.",
  "pickupPoint": {
    "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included.",
    "localDateTime": "2026-05-14",
    "localDateTimeTo": "2026-05-14",
    "latitude": 10,
    "longitude": 10,
    "address": "123 Main St, San Francisco, CA",
    "googlePlaceId": "google_place_id-example"
  },
  "pickupPointId": "pickup_union_square",
  "questionAnswers": [
    {
      "questionId": "question_dietary_requirements",
      "value": "value-example"
    }
  ],
  "resourceAllocations": [
    {
      "resourceGroupId": "resource_group_front_row",
      "resourceGroup": {
        "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
        "title": "Summer Promotion",
        "split": true,
        "required": true
      },
      "resourceId": "resource_coach_12",
      "resource": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "title": "Summer Promotion",
        "capacity": 2,
        "seating": true,
        "seats": [
          {
            "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
            "row": "A",
            "column": "4",
            "status": "CONFIRMED"
          }
        ]
      },
      "seatIds": [
        "seat_one",
        "seat_two"
      ],
      "seats": [
        {
          "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
          "row": "A",
          "column": "4",
          "status": "CONFIRMED"
        }
      ],
      "paxCount": 2
    }
  ],
  "rentalDuration": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "duration": "2",
    "durationAmount": 220,
    "durationUnit": "HOUR",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included."
  },
  "rentalDurationId": "rental_duration_2h",
  "mappings": [
    {
      "resellerReference": "RES-BOOK-10045",
      "resellerStatus": "CONFIRMED",
      "resellerProduct": "grand-canyon-day-tour",
      "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
      "unitId": "unit_adult",
      "optionRequired": true,
      "unitRequired": true,
      "validityDays": 2,
      "webhookUrl": "https://www.city-sightseeing.com"
    }
  ],
  "orderId": "ord_20260514_9f3c21",
  "orderInvoicePdfUrl": "https://www.city-sightseeing.com",
  "orderReference": "ORDER-2026-0514-1001",
  "primary": true,
  "giftPayment": {
    "giftCode": "GIFT-2026-0001",
    "code": "SUMMER25",
    "amount": 220,
    "currency": "USD"
  },
  "checkedIn": true,
  "checkinAvailable": true,
  "checkinUrl": "https://checkin.city-sightseeing.com/booking/89fe0192",
  "cardPayment": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "cardPaymentId": "cp_20260514_42ad10",
    "gateway": "adyen",
    "source": "POS",
    "paid": 2,
    "totalPaid": 2,
    "totalRefunded": 2,
    "paidSurcharge": 2,
    "balance": 2,
    "surcharge": 2,
    "outstandingBalance": 2,
    "amount": 220,
    "currency": "USD",
    "currencyPrecision": 2,
    "status": "CONFIRMED",
    "reusableCards": [
      {
        "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
        "brand": "visa",
        "bin": "411111",
        "last4": "1111",
        "expMonth": 2,
        "expYear": 2
      }
    ],
    "adyen": {
      "environment": "test",
      "clientKey": "test_client_key_123",
      "session": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "sessionData": "session_data_payload"
      },
      "countryCode": "US",
      "paymentMethodsConfiguration": {}
    },
    "external": {},
    "provider": "adyen",
    "providerReference": "PROV-REF-2026-001",
    "createdAt": "2026-05-14T13:00:00Z"
  },
  "returnUrl": "https://checkout.city-sightseeing.com/return",
  "appendMembershipValidity": true,
  "membership": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "title": "Annual Membership",
    "contact": {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "tags": [
        "vip",
        "partner"
      ],
      "fullName": "Jane Doe",
      "title": "Ms",
      "firstName": "Jane",
      "lastName": "Doe",
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]",
      "age": 34,
      "birthdate": "1992-04-23",
      "streetAddress": "223 Market Street",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94103",
      "country": "US",
      "locales": [
        "en"
      ],
      "notes": "Vegetarian meal requested",
      "allowMarketing": false,
      "taxId": "US1234567",
      "company": "Golden Gate Tours LLC",
      "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
    },
    "reference": "REF-2026-001",
    "resellerReference": "RES-MEM-10045",
    "supplierReference": "SUP-MEM-7782",
    "availabilityLocalDateStart": "2026-01-01",
    "availabilityLocalDateEnd": "2026-12-31"
  },
  "adjustments": [
    {
      "per": "BOOKING",
      "amount": 220,
      "quantity": 2,
      "notes": "Vegetarian meal requested",
      "netDiscount": "NONE"
    }
  ],
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

Extend Reservation

post

Extends booking hold expiry.

Path parameters

uuidstringRequired

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

Body

application/json

expirationMinutesintegerOptional

Expiration minutes numeric value.

Example: 30

Responses

200

Returns a Booking object.

application/json

activebooleanOptional

Whether active is enabled.

Example: true

aliasstring · nullableOptional

Alias value.

Example: booking-alias-001

availabilityIdstring · nullableOptional

Availability identifier (local date or local date-time).

Example: 2026-05-14T09:00:00-04:00

availabilityLocalDateEndstring · nullableOptional

Availability local date end value.

Example: 2026-05-21

availabilityLocalDateStartstring · nullableOptional

Availability local date start value.

Example: 2026-05-14

cancellablebooleanOptional

Whether cancellable is enabled.

Example: true

confirmablebooleanOptional

Whether confirmable is enabled.

Example: true

currencystringOptional

ISO 4217 currency code.

Example: USD

deliveryMethodsstring[]Optional

Delivery methods available on this booking. VOUCHER means use booking.voucher; TICKET means use booking.unitItems[].ticket.

Example: ["VOUCHER","TICKET"]

emailReceiptbooleanOptional

Whether email receipt is enabled.

Example: true

freesalebooleanOptional

Whether freesale is enabled.

Example: true

idstring · uuidRead-onlyOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

invoicePdfUrlstring · nullableOptional

Invoice pdf url URL.

Example: https://www.city-sightseeing.com

localDateTimeEndstring · date-timeOptional

Local date time end timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

localDateTimeStartstring · date-timeOptional

Local date time start timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested

optionIdstringRequired

Option identifier.

Example: 94cdd032-3d32-416d-b0a4-abf8b7495b8b

originalRebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

productIdstringOptional

Product identifier.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681

quotebooleanOptional

Whether quote is enabled.

Example: false

rebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

requiredContactFieldsstring[]Optional

List of required contact field values.

Example: ["fullName","emailAddress"]

resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045

settlementMethodstringOptional

Settlement method value.

Example: DIRECT

statusstring · enumRequired

Current status value.

Example: ON_HOLDPossible values:

supplierReferencestringOptional

Human-readable supplier reference to share with the guest and store for support and billing reconciliation.

Example: SUP-BOOK-7782

tagsstring[]Optional

List of tag values.

Example: ["vip","partner"]

testModebooleanOptional

Whether test mode is enabled.

Example: false

updatablebooleanOptional

Whether updatable is enabled.

Example: true

utcConfirmedAtstring · date-time · nullableOptional

Utc confirmed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcCreatedAtstring · date-timeOptional

Utc created at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcExpiresAtstring · date-time · nullableOptional

Utc expires at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcNoshowedAtstring · date-time · nullableOptional

Utc noshowed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRebookedAtstring · date-time · nullableOptional

Utc rebooked at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRedeemedAtstring · date-time · nullableOptional

Utc redeemed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcUpdatedAtstring · date-timeOptional

Utc updated at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

uuidstringRequired

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

visibleContactFieldsstring[]Optional

List of visible contact field values.

Example: ["fullName","emailAddress"]

termsAcceptedboolean · nullableOptional

From capability octo/content.

Example: true

offerCodestring · nullableOptional

From capability octo/offers.

Example: SUMMER25

offerIsCombinationbooleanOptional

From capability octo/offers.

Example: true

offerTitlestring · nullableOptional

From capability octo/offers.

Example: Summer Promotion

packageIncludeIdstring · nullableOptional

From capability octo/packages.

Example: package_include_id-example

packageUnitItemUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

packageUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

dropoffNotesstring · nullableOptional

From capability octo/pickups.

Example: Drop-off at Fisherman's Wharf.

dropoffPointIdstring · nullableOptional

From capability octo/pickups.

Example: dropoff_fishermans_wharf

pickupHotelstring · nullableOptional

From capability octo/pickups.

Example: Hilton Union Square

pickupHotelRoomstring · nullableOptional

From capability octo/pickups.

Example: 1208

pickupNotesstring · nullableOptional

From capability octo/pickups.

Example: Meet the guide by the hotel lobby.

pickupPointIdstring · nullableOptional

From capability octo/pickups.

Example: pickup_union_square

rentalDurationIdstring · nullableOptional

From capability octo/rentals.

Example: rental_duration_2h

orderIdstring · nullableOptional

From capability octo/cart.

Example: ord_20260514_9f3c21

orderInvoicePdfUrlstring · nullableOptional

From capability octo/cart.

Example: https://www.city-sightseeing.com

orderReferencestring · nullableOptional

From capability octo/cart.

Example: ORDER-2026-0514-1001

primarybooleanOptional

From capability octo/cart.

Example: true

checkedInbooleanOptional

From capability octo/checkin.

Example: true

checkinAvailablebooleanOptional

From capability octo/checkin.

Example: true

checkinUrlstring · nullableOptional

From capability octo/checkin.

Example: https://checkin.city-sightseeing.com/booking/89fe0192

returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return

appendMembershipValiditybooleanOptional

From capability octo/memberships.

Example: true

identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001

post

/bookings/{uuid}/extend

HTTPcURLJavaScriptPython

POST /octo/bookings/{uuid}/extend HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "expirationMinutes": 30
}

200

Returns a Booking object.

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "alias": "booking-alias-001",
  "availabilityId": "2026-05-14T09:00:00-04:00",
  "availabilityLocalDateEnd": "2026-05-21",
  "availabilityLocalDateStart": "2026-05-14",
  "cancellable": true,
  "cancellation": {
    "refund": "FULL",
    "reason": "Customer request",
    "utcCancelledAt": "2026-05-14T13:00:00Z"
  },
  "confirmable": true,
  "contact": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]",
    "age": 34,
    "birthdate": "1992-04-23",
    "streetAddress": "223 Market Street",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94103",
    "country": "US",
    "locales": [
      "en"
    ],
    "notes": "Vegetarian meal requested",
    "allowMarketing": false,
    "taxId": "US1234567",
    "company": "Golden Gate Tours LLC",
    "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
  },
  "currency": "USD",
  "deliveryMethods": [
    "VOUCHER",
    "TICKET"
  ],
  "driver": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "emailReceipt": true,
  "freesale": true,
  "guide": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "invoicePdfUrl": "https://www.city-sightseeing.com",
  "label": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "name": "Morning City Tour"
  },
  "localDateTimeEnd": "2026-05-14T13:00:00Z",
  "localDateTimeStart": "2026-05-14T13:00:00Z",
  "metadata": {
    "bookingSource": "affiliate_portal",
    "partnerOrderId": "PO-12345"
  },
  "notes": "Vegetarian meal requested",
  "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
  "originalRebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
  "quote": false,
  "rebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "rejection": {
    "reason": "Customer request",
    "utcRejectedAt": "2026-05-14T13:00:00Z"
  },
  "requiredContactFields": [
    "fullName",
    "emailAddress"
  ],
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "settlementMethod": "DIRECT",
  "status": "ON_HOLD",
  "supplierReference": "SUP-BOOK-7782",
  "tags": [
    "vip",
    "partner"
  ],
  "testMode": false,
  "tickets": [
    {
      "redemptionMethod": "DIGITAL",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "utcNoshowedAt": "2026-05-14T13:00:00Z",
      "deliveryOptions": [
        {
          "deliveryFormat": "PDF_URL",
          "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
        }
      ]
    }
  ],
  "unitItems": [
    {
      "alias": "booking-alias-001",
      "contact": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "fullName": "Jane Doe",
        "title": "Ms",
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "[email protected]",
        "phoneNumber": "[phone]",
        "age": 34,
        "birthdate": "1992-04-23",
        "streetAddress": "223 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94103",
        "country": "US",
        "locales": [
          "en"
        ],
        "notes": "Vegetarian meal requested",
        "allowMarketing": false,
        "taxId": "US1234567",
        "company": "Golden Gate Tours LLC",
        "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
      },
      "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
      "localDateTimeEnd": "2026-05-14T13:00:00Z",
      "localDateTimeStart": "2026-05-14T13:00:00Z",
      "originalRebookingUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "originalRebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "rebookingUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "rebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "requiredContactFields": [
        "fullName",
        "emailAddress"
      ],
      "resellerReference": "RES-BOOK-10045",
      "status": "CONFIRMED",
      "supplierReference": "SUP-BOOK-7782",
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
          }
        ]
      },
      "unitId": "unit_adult",
      "unitType": "ADULT",
      "utcNoshowedAt": "2026-05-14T13:00:00Z",
      "utcRebookedAt": "2026-05-14T13:00:00Z",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "visibleContactFields": [
        "fullName",
        "emailAddress"
      ],
      "weightUnit": "kg",
      "weightValue": 20,
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offerCode": "SUMMER25",
      "offerComparisons": [
        {
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offer": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "title": "Summer Promotion",
            "label": "Save 20%",
            "code": "SUMMER25",
            "description": "20% off selected departures this month.",
            "netDiscount": "FULL",
            "restrictions": {
              "minUnits": 1,
              "maxUnits": 10,
              "minTotal": 0,
              "maxTotal": 50000,
              "unitIds": [
                "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
              ]
            },
            "usable": true,
            "unusableReason": "Offer is not valid for the selected date.",
            "membershipBenefit": {
              "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
              "title": "Summer Promotion",
              "description": "Morning departure with central pickup included."
            }
          }
        }
      ],
      "offerIsCombination": true,
      "offerTitle": "Summer Promotion",
      "extraItems": [
        {
          "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "resellerReference": "RES-BOOK-10045",
          "supplierReference": "SUP-BOOK-7782",
          "extraId": "extra_fast_track",
          "status": "CONFIRMED",
          "utcRedeemedAt": "2026-05-14T13:00:00Z",
          "contact": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "fullName": "Jane Doe",
            "title": "Ms",
            "firstName": "Jane",
            "lastName": "Doe",
            "emailAddress": "[email protected]",
            "phoneNumber": "[phone]",
            "age": 34,
            "birthdate": "1992-04-23",
            "streetAddress": "223 Market Street",
            "city": "San Francisco",
            "state": "CA",
            "postalCode": "94103",
            "country": "US",
            "locales": [
              "en"
            ],
            "notes": "Vegetarian meal requested",
            "allowMarketing": false,
            "taxId": "US1234567",
            "company": "Golden Gate Tours LLC",
            "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
          },
          "visibleContactFields": [
            "fullName",
            "emailAddress"
          ],
          "requiredContactFields": [
            "fullName",
            "emailAddress"
          ],
          "ticket": {
            "redemptionMethod": "DIGITAL",
            "utcRedeemedAt": "2026-05-14T13:00:00Z",
            "utcNoshowedAt": "2026-05-14T13:00:00Z",
            "deliveryOptions": [
              {
                "deliveryFormat": "PDF_URL",
                "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
              }
            ]
          },
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "offerIsCombination": true,
          "offerComparisons": [
            {
              "offerCode": "SUMMER25",
              "offerTitle": "Summer Promotion",
              "pricing": {
                "currency": "USD",
                "currencyPrecision": 2,
                "net": 18000,
                "original": 22000,
                "retail": 20000,
                "includedTaxes": [
                  {
                    "name": "Sales Tax",
                    "shortDescription": "Local sales tax",
                    "original": 2000,
                    "retail": 1800,
                    "net": 1600
                  }
                ],
                "offerDiscount": {
                  "retail": 2000,
                  "net": 2000,
                  "includedTaxes": [
                    {
                      "name": "Sales Tax",
                      "shortDescription": "Local sales tax",
                      "retail": 200,
                      "net": 200
                    }
                  ]
                }
              },
              "offer": {
                "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
                "tags": [
                  "vip",
                  "partner"
                ],
                "title": "Summer Promotion",
                "label": "Save 20%",
                "code": "SUMMER25",
                "description": "20% off selected departures this month.",
                "netDiscount": "FULL",
                "restrictions": {
                  "minUnits": 1,
                  "maxUnits": 10,
                  "minTotal": 0,
                  "maxTotal": 50000,
                  "unitIds": [
                    "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                    "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
                  ]
                },
                "usable": true,
                "unusableReason": "Offer is not valid for the selected date.",
                "membershipBenefit": {
                  "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
                  "title": "Summer Promotion",
                  "description": "Morning departure with central pickup included."
                }
              }
            }
          ]
        }
      ],
      "packageIncludeId": "package_include_id-example",
      "packageUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "questionAnswers": [
        {
          "questionId": "question_dietary_requirements",
          "value": "value-example"
        }
      ],
      "scans": [
        {
          "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
          "status": "CONFIRMED",
          "utcScannedAt": "2026-05-14T13:00:00Z",
          "seller": {
            "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
            "name": "Morning City Tour",
            "reference": "REF-2026-001",
            "tags": [
              "vip",
              "partner"
            ],
            "emailAddress": "[email protected]",
            "phoneNumber": "[phone]"
          }
        }
      ]
    }
  ],
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcNoshowedAt": "2026-05-14T13:00:00Z",
  "utcRebookedAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "visibleContactFields": [
    "fullName",
    "emailAddress"
  ],
  "voucher": {
    "redemptionMethod": "DIGITAL",
    "utcRedeemedAt": "2026-05-14T13:00:00Z",
    "utcNoshowedAt": "2026-05-14T13:00:00Z",
    "deliveryOptions": [
      {
        "deliveryFormat": "PDF_URL",
        "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
      }
    ]
  },
  "pricing": {
    "currency": "USD",
    "currencyPrecision": 2,
    "net": 18000,
    "original": 22000,
    "retail": 20000,
    "includedTaxes": [
      {
        "name": "Sales Tax",
        "shortDescription": "Local sales tax",
        "original": 2000,
        "retail": 1800,
        "net": 1600
      }
    ],
    "offerDiscount": {
      "retail": 2000,
      "net": 2000,
      "includedTaxes": [
        {
          "name": "Sales Tax",
          "shortDescription": "Local sales tax",
          "retail": 200,
          "net": 200
        }
      ]
    }
  },
  "termsAccepted": true,
  "offerCode": "SUMMER25",
  "offerComparisons": [
    {
      "offerCode": "SUMMER25",
      "offerTitle": "Summer Promotion",
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offer": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "title": "Summer Promotion",
        "label": "Save 20%",
        "code": "SUMMER25",
        "description": "20% off selected departures this month.",
        "netDiscount": "FULL",
        "restrictions": {
          "minUnits": 1,
          "maxUnits": 10,
          "minTotal": 0,
          "maxTotal": 50000,
          "unitIds": [
            "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
            "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
          ]
        },
        "usable": true,
        "unusableReason": "Offer is not valid for the selected date.",
        "membershipBenefit": {
          "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
          "title": "Summer Promotion",
          "description": "Morning departure with central pickup included."
        }
      }
    }
  ],
  "offerIsCombination": true,
  "offerTitle": "Summer Promotion",
  "extraItems": [
    {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "resellerReference": "RES-BOOK-10045",
      "supplierReference": "SUP-BOOK-7782",
      "extraId": "extra_fast_track",
      "status": "CONFIRMED",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "contact": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "fullName": "Jane Doe",
        "title": "Ms",
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "[email protected]",
        "phoneNumber": "[phone]",
        "age": 34,
        "birthdate": "1992-04-23",
        "streetAddress": "223 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94103",
        "country": "US",
        "locales": [
          "en"
        ],
        "notes": "Vegetarian meal requested",
        "allowMarketing": false,
        "taxId": "US1234567",
        "company": "Golden Gate Tours LLC",
        "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
      },
      "visibleContactFields": [
        "fullName",
        "emailAddress"
      ],
      "requiredContactFields": [
        "fullName",
        "emailAddress"
      ],
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
          }
        ]
      },
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offerCode": "SUMMER25",
      "offerTitle": "Summer Promotion",
      "offerIsCombination": true,
      "offerComparisons": [
        {
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offer": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "title": "Summer Promotion",
            "label": "Save 20%",
            "code": "SUMMER25",
            "description": "20% off selected departures this month.",
            "netDiscount": "FULL",
            "restrictions": {
              "minUnits": 1,
              "maxUnits": 10,
              "minTotal": 0,
              "maxTotal": 50000,
              "unitIds": [
                "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
              ]
            },
            "usable": true,
            "unusableReason": "Offer is not valid for the selected date.",
            "membershipBenefit": {
              "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
              "title": "Summer Promotion",
              "description": "Morning departure with central pickup included."
            }
          }
        }
      ]
    }
  ],
  "packageIncludeId": "package_include_id-example",
  "packageUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "packageUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "dropoffDispatch": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "name": "Morning City Tour",
    "phoneNumber": "[phone]",
    "vehicle": "coach_12"
  },
  "dropoffNotes": "Drop-off at Fisherman's Wharf.",
  "dropoffPoint": {
    "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included.",
    "localDateTime": "2026-05-14",
    "localDateTimeTo": "2026-05-14",
    "latitude": 10,
    "longitude": 10,
    "address": "123 Main St, San Francisco, CA",
    "googlePlaceId": "google_place_id-example"
  },
  "dropoffPointId": "dropoff_fishermans_wharf",
  "pickupDispatch": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "name": "Morning City Tour",
    "phoneNumber": "[phone]",
    "vehicle": "coach_12"
  },
  "pickupHotel": "Hilton Union Square",
  "pickupHotelRoom": "1208",
  "pickupNotes": "Meet the guide by the hotel lobby.",
  "pickupPoint": {
    "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included.",
    "localDateTime": "2026-05-14",
    "localDateTimeTo": "2026-05-14",
    "latitude": 10,
    "longitude": 10,
    "address": "123 Main St, San Francisco, CA",
    "googlePlaceId": "google_place_id-example"
  },
  "pickupPointId": "pickup_union_square",
  "questionAnswers": [
    {
      "questionId": "question_dietary_requirements",
      "value": "value-example"
    }
  ],
  "resourceAllocations": [
    {
      "resourceGroupId": "resource_group_front_row",
      "resourceGroup": {
        "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
        "title": "Summer Promotion",
        "split": true,
        "required": true
      },
      "resourceId": "resource_coach_12",
      "resource": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "title": "Summer Promotion",
        "capacity": 2,
        "seating": true,
        "seats": [
          {
            "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
            "row": "A",
            "column": "4",
            "status": "CONFIRMED"
          }
        ]
      },
      "seatIds": [
        "seat_one",
        "seat_two"
      ],
      "seats": [
        {
          "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
          "row": "A",
          "column": "4",
          "status": "CONFIRMED"
        }
      ],
      "paxCount": 2
    }
  ],
  "rentalDuration": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "duration": "2",
    "durationAmount": 220,
    "durationUnit": "HOUR",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included."
  },
  "rentalDurationId": "rental_duration_2h",
  "mappings": [
    {
      "resellerReference": "RES-BOOK-10045",
      "resellerStatus": "CONFIRMED",
      "resellerProduct": "grand-canyon-day-tour",
      "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
      "unitId": "unit_adult",
      "optionRequired": true,
      "unitRequired": true,
      "validityDays": 2,
      "webhookUrl": "https://www.city-sightseeing.com"
    }
  ],
  "orderId": "ord_20260514_9f3c21",
  "orderInvoicePdfUrl": "https://www.city-sightseeing.com",
  "orderReference": "ORDER-2026-0514-1001",
  "primary": true,
  "giftPayment": {
    "giftCode": "GIFT-2026-0001",
    "code": "SUMMER25",
    "amount": 220,
    "currency": "USD"
  },
  "checkedIn": true,
  "checkinAvailable": true,
  "checkinUrl": "https://checkin.city-sightseeing.com/booking/89fe0192",
  "cardPayment": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "cardPaymentId": "cp_20260514_42ad10",
    "gateway": "adyen",
    "source": "POS",
    "paid": 2,
    "totalPaid": 2,
    "totalRefunded": 2,
    "paidSurcharge": 2,
    "balance": 2,
    "surcharge": 2,
    "outstandingBalance": 2,
    "amount": 220,
    "currency": "USD",
    "currencyPrecision": 2,
    "status": "CONFIRMED",
    "reusableCards": [
      {
        "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
        "brand": "visa",
        "bin": "411111",
        "last4": "1111",
        "expMonth": 2,
        "expYear": 2
      }
    ],
    "adyen": {
      "environment": "test",
      "clientKey": "test_client_key_123",
      "session": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "sessionData": "session_data_payload"
      },
      "countryCode": "US",
      "paymentMethodsConfiguration": {}
    },
    "external": {},
    "provider": "adyen",
    "providerReference": "PROV-REF-2026-001",
    "createdAt": "2026-05-14T13:00:00Z"
  },
  "returnUrl": "https://checkout.city-sightseeing.com/return",
  "appendMembershipValidity": true,
  "membership": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "title": "Annual Membership",
    "contact": {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "tags": [
        "vip",
        "partner"
      ],
      "fullName": "Jane Doe",
      "title": "Ms",
      "firstName": "Jane",
      "lastName": "Doe",
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]",
      "age": 34,
      "birthdate": "1992-04-23",
      "streetAddress": "223 Market Street",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94103",
      "country": "US",
      "locales": [
        "en"
      ],
      "notes": "Vegetarian meal requested",
      "allowMarketing": false,
      "taxId": "US1234567",
      "company": "Golden Gate Tours LLC",
      "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
    },
    "reference": "REF-2026-001",
    "resellerReference": "RES-MEM-10045",
    "supplierReference": "SUP-MEM-7782",
    "availabilityLocalDateStart": "2026-01-01",
    "availabilityLocalDateEnd": "2026-12-31"
  },
  "adjustments": [
    {
      "per": "BOOKING",
      "amount": 220,
      "quantity": 2,
      "notes": "Vegetarian meal requested",
      "netDiscount": "NONE"
    }
  ],
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

Get Booking

get

Fetches a booking by UUID.

Path parameters

uuidstringRequired

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

Responses

200

Returns a Booking object.

application/json

activebooleanOptional

Whether active is enabled.

Example: true

aliasstring · nullableOptional

Alias value.

Example: booking-alias-001

availabilityIdstring · nullableOptional

Availability identifier (local date or local date-time).

Example: 2026-05-14T09:00:00-04:00

availabilityLocalDateEndstring · nullableOptional

Availability local date end value.

Example: 2026-05-21

availabilityLocalDateStartstring · nullableOptional

Availability local date start value.

Example: 2026-05-14

cancellablebooleanOptional

Whether cancellable is enabled.

Example: true

confirmablebooleanOptional

Whether confirmable is enabled.

Example: true

currencystringOptional

ISO 4217 currency code.

Example: USD

deliveryMethodsstring[]Optional

Delivery methods available on this booking. VOUCHER means use booking.voucher; TICKET means use booking.unitItems[].ticket.

Example: ["VOUCHER","TICKET"]

emailReceiptbooleanOptional

Whether email receipt is enabled.

Example: true

freesalebooleanOptional

Whether freesale is enabled.

Example: true

idstring · uuidRead-onlyOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

invoicePdfUrlstring · nullableOptional

Invoice pdf url URL.

Example: https://www.city-sightseeing.com

localDateTimeEndstring · date-timeOptional

Local date time end timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

localDateTimeStartstring · date-timeOptional

Local date time start timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested

optionIdstringRequired

Option identifier.

Example: 94cdd032-3d32-416d-b0a4-abf8b7495b8b

originalRebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

productIdstringOptional

Product identifier.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681

quotebooleanOptional

Whether quote is enabled.

Example: false

rebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

requiredContactFieldsstring[]Optional

List of required contact field values.

Example: ["fullName","emailAddress"]

resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045

settlementMethodstringOptional

Settlement method value.

Example: DIRECT

statusstring · enumRequired

Current status value.

Example: ON_HOLDPossible values:

supplierReferencestringOptional

Human-readable supplier reference to share with the guest and store for support and billing reconciliation.

Example: SUP-BOOK-7782

tagsstring[]Optional

List of tag values.

Example: ["vip","partner"]

testModebooleanOptional

Whether test mode is enabled.

Example: false

updatablebooleanOptional

Whether updatable is enabled.

Example: true

utcConfirmedAtstring · date-time · nullableOptional

Utc confirmed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcCreatedAtstring · date-timeOptional

Utc created at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcExpiresAtstring · date-time · nullableOptional

Utc expires at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcNoshowedAtstring · date-time · nullableOptional

Utc noshowed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRebookedAtstring · date-time · nullableOptional

Utc rebooked at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRedeemedAtstring · date-time · nullableOptional

Utc redeemed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcUpdatedAtstring · date-timeOptional

Utc updated at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

uuidstringRequired

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

visibleContactFieldsstring[]Optional

List of visible contact field values.

Example: ["fullName","emailAddress"]

termsAcceptedboolean · nullableOptional

From capability octo/content.

Example: true

offerCodestring · nullableOptional

From capability octo/offers.

Example: SUMMER25

offerIsCombinationbooleanOptional

From capability octo/offers.

Example: true

offerTitlestring · nullableOptional

From capability octo/offers.

Example: Summer Promotion

packageIncludeIdstring · nullableOptional

From capability octo/packages.

Example: package_include_id-example

packageUnitItemUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

packageUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

dropoffNotesstring · nullableOptional

From capability octo/pickups.

Example: Drop-off at Fisherman's Wharf.

dropoffPointIdstring · nullableOptional

From capability octo/pickups.

Example: dropoff_fishermans_wharf

pickupHotelstring · nullableOptional

From capability octo/pickups.

Example: Hilton Union Square

pickupHotelRoomstring · nullableOptional

From capability octo/pickups.

Example: 1208

pickupNotesstring · nullableOptional

From capability octo/pickups.

Example: Meet the guide by the hotel lobby.

pickupPointIdstring · nullableOptional

From capability octo/pickups.

Example: pickup_union_square

rentalDurationIdstring · nullableOptional

From capability octo/rentals.

Example: rental_duration_2h

orderIdstring · nullableOptional

From capability octo/cart.

Example: ord_20260514_9f3c21

orderInvoicePdfUrlstring · nullableOptional

From capability octo/cart.

Example: https://www.city-sightseeing.com

orderReferencestring · nullableOptional

From capability octo/cart.

Example: ORDER-2026-0514-1001

primarybooleanOptional

From capability octo/cart.

Example: true

checkedInbooleanOptional

From capability octo/checkin.

Example: true

checkinAvailablebooleanOptional

From capability octo/checkin.

Example: true

checkinUrlstring · nullableOptional

From capability octo/checkin.

Example: https://checkin.city-sightseeing.com/booking/89fe0192

returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return

appendMembershipValiditybooleanOptional

From capability octo/memberships.

Example: true

identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001

get

/bookings/{uuid}

HTTPcURLJavaScriptPython

GET /octo/bookings/{uuid} HTTP/1.1
Host: api.ventrata.com
Accept: */*

200

Returns a Booking object.

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "alias": "booking-alias-001",
  "availabilityId": "2026-05-14T09:00:00-04:00",
  "availabilityLocalDateEnd": "2026-05-21",
  "availabilityLocalDateStart": "2026-05-14",
  "cancellable": true,
  "cancellation": {
    "refund": "FULL",
    "reason": "Customer request",
    "utcCancelledAt": "2026-05-14T13:00:00Z"
  },
  "confirmable": true,
  "contact": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]",
    "age": 34,
    "birthdate": "1992-04-23",
    "streetAddress": "223 Market Street",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94103",
    "country": "US",
    "locales": [
      "en"
    ],
    "notes": "Vegetarian meal requested",
    "allowMarketing": false,
    "taxId": "US1234567",
    "company": "Golden Gate Tours LLC",
    "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
  },
  "currency": "USD",
  "deliveryMethods": [
    "VOUCHER",
    "TICKET"
  ],
  "driver": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "emailReceipt": true,
  "freesale": true,
  "guide": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "invoicePdfUrl": "https://www.city-sightseeing.com",
  "label": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "name": "Morning City Tour"
  },
  "localDateTimeEnd": "2026-05-14T13:00:00Z",
  "localDateTimeStart": "2026-05-14T13:00:00Z",
  "metadata": {
    "bookingSource": "affiliate_portal",
    "partnerOrderId": "PO-12345"
  },
  "notes": "Vegetarian meal requested",
  "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
  "originalRebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
  "quote": false,
  "rebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "rejection": {
    "reason": "Customer request",
    "utcRejectedAt": "2026-05-14T13:00:00Z"
  },
  "requiredContactFields": [
    "fullName",
    "emailAddress"
  ],
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "settlementMethod": "DIRECT",
  "status": "ON_HOLD",
  "supplierReference": "SUP-BOOK-7782",
  "tags": [
    "vip",
    "partner"
  ],
  "testMode": false,
  "tickets": [
    {
      "redemptionMethod": "DIGITAL",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "utcNoshowedAt": "2026-05-14T13:00:00Z",
      "deliveryOptions": [
        {
          "deliveryFormat": "PDF_URL",
          "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
        }
      ]
    }
  ],
  "unitItems": [
    {
      "alias": "booking-alias-001",
      "contact": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "fullName": "Jane Doe",
        "title": "Ms",
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "[email protected]",
        "phoneNumber": "[phone]",
        "age": 34,
        "birthdate": "1992-04-23",
        "streetAddress": "223 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94103",
        "country": "US",
        "locales": [
          "en"
        ],
        "notes": "Vegetarian meal requested",
        "allowMarketing": false,
        "taxId": "US1234567",
        "company": "Golden Gate Tours LLC",
        "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
      },
      "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
      "localDateTimeEnd": "2026-05-14T13:00:00Z",
      "localDateTimeStart": "2026-05-14T13:00:00Z",
      "originalRebookingUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "originalRebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "rebookingUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "rebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "requiredContactFields": [
        "fullName",
        "emailAddress"
      ],
      "resellerReference": "RES-BOOK-10045",
      "status": "CONFIRMED",
      "supplierReference": "SUP-BOOK-7782",
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
          }
        ]
      },
      "unitId": "unit_adult",
      "unitType": "ADULT",
      "utcNoshowedAt": "2026-05-14T13:00:00Z",
      "utcRebookedAt": "2026-05-14T13:00:00Z",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "visibleContactFields": [
        "fullName",
        "emailAddress"
      ],
      "weightUnit": "kg",
      "weightValue": 20,
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offerCode": "SUMMER25",
      "offerComparisons": [
        {
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offer": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "title": "Summer Promotion",
            "label": "Save 20%",
            "code": "SUMMER25",
            "description": "20% off selected departures this month.",
            "netDiscount": "FULL",
            "restrictions": {
              "minUnits": 1,
              "maxUnits": 10,
              "minTotal": 0,
              "maxTotal": 50000,
              "unitIds": [
                "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
              ]
            },
            "usable": true,
            "unusableReason": "Offer is not valid for the selected date.",
            "membershipBenefit": {
              "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
              "title": "Summer Promotion",
              "description": "Morning departure with central pickup included."
            }
          }
        }
      ],
      "offerIsCombination": true,
      "offerTitle": "Summer Promotion",
      "extraItems": [
        {
          "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "resellerReference": "RES-BOOK-10045",
          "supplierReference": "SUP-BOOK-7782",
          "extraId": "extra_fast_track",
          "status": "CONFIRMED",
          "utcRedeemedAt": "2026-05-14T13:00:00Z",
          "contact": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "fullName": "Jane Doe",
            "title": "Ms",
            "firstName": "Jane",
            "lastName": "Doe",
            "emailAddress": "[email protected]",
            "phoneNumber": "[phone]",
            "age": 34,
            "birthdate": "1992-04-23",
            "streetAddress": "223 Market Street",
            "city": "San Francisco",
            "state": "CA",
            "postalCode": "94103",
            "country": "US",
            "locales": [
              "en"
            ],
            "notes": "Vegetarian meal requested",
            "allowMarketing": false,
            "taxId": "US1234567",
            "company": "Golden Gate Tours LLC",
            "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
          },
          "visibleContactFields": [
            "fullName",
            "emailAddress"
          ],
          "requiredContactFields": [
            "fullName",
            "emailAddress"
          ],
          "ticket": {
            "redemptionMethod": "DIGITAL",
            "utcRedeemedAt": "2026-05-14T13:00:00Z",
            "utcNoshowedAt": "2026-05-14T13:00:00Z",
            "deliveryOptions": [
              {
                "deliveryFormat": "PDF_URL",
                "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
              }
            ]
          },
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "offerIsCombination": true,
          "offerComparisons": [
            {
              "offerCode": "SUMMER25",
              "offerTitle": "Summer Promotion",
              "pricing": {
                "currency": "USD",
                "currencyPrecision": 2,
                "net": 18000,
                "original": 22000,
                "retail": 20000,
                "includedTaxes": [
                  {
                    "name": "Sales Tax",
                    "shortDescription": "Local sales tax",
                    "original": 2000,
                    "retail": 1800,
                    "net": 1600
                  }
                ],
                "offerDiscount": {
                  "retail": 2000,
                  "net": 2000,
                  "includedTaxes": [
                    {
                      "name": "Sales Tax",
                      "shortDescription": "Local sales tax",
                      "retail": 200,
                      "net": 200
                    }
                  ]
                }
              },
              "offer": {
                "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
                "tags": [
                  "vip",
                  "partner"
                ],
                "title": "Summer Promotion",
                "label": "Save 20%",
                "code": "SUMMER25",
                "description": "20% off selected departures this month.",
                "netDiscount": "FULL",
                "restrictions": {
                  "minUnits": 1,
                  "maxUnits": 10,
                  "minTotal": 0,
                  "maxTotal": 50000,
                  "unitIds": [
                    "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                    "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
                  ]
                },
                "usable": true,
                "unusableReason": "Offer is not valid for the selected date.",
                "membershipBenefit": {
                  "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
                  "title": "Summer Promotion",
                  "description": "Morning departure with central pickup included."
                }
              }
            }
          ]
        }
      ],
      "packageIncludeId": "package_include_id-example",
      "packageUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "questionAnswers": [
        {
          "questionId": "question_dietary_requirements",
          "value": "value-example"
        }
      ],
      "scans": [
        {
          "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
          "status": "CONFIRMED",
          "utcScannedAt": "2026-05-14T13:00:00Z",
          "seller": {
            "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
            "name": "Morning City Tour",
            "reference": "REF-2026-001",
            "tags": [
              "vip",
              "partner"
            ],
            "emailAddress": "[email protected]",
            "phoneNumber": "[phone]"
          }
        }
      ]
    }
  ],
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "[email protected]",
    "phoneNumber": "[phone]"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcNoshowedAt": "2026-05-14T13:00:00Z",
  "utcRebookedAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "visibleContactFields": [
    "fullName",
    "emailAddress"
  ],
  "voucher": {
    "redemptionMethod": "DIGITAL",
    "utcRedeemedAt": "2026-05-14T13:00:00Z",
    "utcNoshowedAt": "2026-05-14T13:00:00Z",
    "deliveryOptions": [
      {
        "deliveryFormat": "PDF_URL",
        "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
      }
    ]
  },
  "pricing": {
    "currency": "USD",
    "currencyPrecision": 2,
    "net": 18000,
    "original": 22000,
    "retail": 20000,
    "includedTaxes": [
      {
        "name": "Sales Tax",
        "shortDescription": "Local sales tax",
        "original": 2000,
        "retail": 1800,
        "net": 1600
      }
    ],
    "offerDiscount": {
      "retail": 2000,
      "net": 2000,
      "includedTaxes": [
        {
          "name": "Sales Tax",
          "shortDescription": "Local sales tax",
          "retail": 200,
          "net": 200
        }
      ]
    }
  },
  "termsAccepted": true,
  "offerCode": "SUMMER25",
  "offerComparisons": [
    {
      "offerCode": "SUMMER25",
      "offerTitle": "Summer Promotion",
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offer": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "title": "Summer Promotion",
        "label": "Save 20%",
        "code": "SUMMER25",
        "description": "20% off selected departures this month.",
        "netDiscount": "FULL",
        "restrictions": {
          "minUnits": 1,
          "maxUnits": 10,
          "minTotal": 0,
          "maxTotal": 50000,
          "unitIds": [
            "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
            "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
          ]
        },
        "usable": true,
        "unusableReason": "Offer is not valid for the selected date.",
        "membershipBenefit": {
          "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
          "title": "Summer Promotion",
          "description": "Morning departure with central pickup included."
        }
      }
    }
  ],
  "offerIsCombination": true,
  "offerTitle": "Summer Promotion",
  "extraItems": [
    {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "resellerReference": "RES-BOOK-10045",
      "supplierReference": "SUP-BOOK-7782",
      "extraId": "extra_fast_track",
      "status": "CONFIRMED",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "contact": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "fullName": "Jane Doe",
        "title": "Ms",
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "[email protected]",
        "phoneNumber": "[phone]",
        "age": 34,
        "birthdate": "1992-04-23",
        "streetAddress": "223 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94103",
        "country": "US",
        "locales": [
          "en"
        ],
        "notes": "Vegetarian meal requested",
        "allowMarketing": false,
        "taxId": "US1234567",
        "company": "Golden Gate Tours LLC",
        "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
      },
      "visibleContactFields": [
        "fullName",
        "emailAddress"
      ],
      "requiredContactFields": [
        "fullName",
        "emailAddress"
      ],
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
          }
        ]
      },
      "pricing": {
        "currency": "USD",
        "currencyPrecision": 2,
        "net": 18000,
        "original": 22000,
        "retail": 20000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offerCode": "SUMMER25",
      "offerTitle": "Summer Promotion",
      "offerIsCombination": true,
      "offerComparisons": [
        {
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "pricing": {
            "currency": "USD",
            "currencyPrecision": 2,
            "net": 18000,
            "original": 22000,
            "retail": 20000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "original": 2000,
                "retail": 1800,
                "net": 1600
              }
            ],
            "offerDiscount": {
              "retail": 2000,
              "net": 2000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "retail": 200,
                  "net": 200
                }
              ]
            }
          },
          "offer": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "tags": [
              "vip",
              "partner"
            ],
            "title": "Summer Promotion",
            "label": "Save 20%",
            "code": "SUMMER25",
            "description": "20% off selected departures this month.",
            "netDiscount": "FULL",
            "restrictions": {
              "minUnits": 1,
              "maxUnits": 10,
              "minTotal": 0,
              "maxTotal": 50000,
              "unitIds": [
                "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
              ]
            },
            "usable": true,
            "unusableReason": "Offer is not valid for the selected date.",
            "membershipBenefit": {
              "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
              "title": "Summer Promotion",
              "description": "Morning departure with central pickup included."
            }
          }
        }
      ]
    }
  ],
  "packageIncludeId": "package_include_id-example",
  "packageUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "packageUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "dropoffDispatch": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "name": "Morning City Tour",
    "phoneNumber": "[phone]",
    "vehicle": "coach_12"
  },
  "dropoffNotes": "Drop-off at Fisherman's Wharf.",
  "dropoffPoint": {
    "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included.",
    "localDateTime": "2026-05-14",
    "localDateTimeTo": "2026-05-14",
    "latitude": 10,
    "longitude": 10,
    "address": "123 Main St, San Francisco, CA",
    "googlePlaceId": "google_place_id-example"
  },
  "dropoffPointId": "dropoff_fishermans_wharf",
  "pickupDispatch": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "name": "Morning City Tour",
    "phoneNumber": "[phone]",
    "vehicle": "coach_12"
  },
  "pickupHotel": "Hilton Union Square",
  "pickupHotelRoom": "1208",
  "pickupNotes": "Meet the guide by the hotel lobby.",
  "pickupPoint": {
    "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included.",
    "localDateTime": "2026-05-14",
    "localDateTimeTo": "2026-05-14",
    "latitude": 10,
    "longitude": 10,
    "address": "123 Main St, San Francisco, CA",
    "googlePlaceId": "google_place_id-example"
  },
  "pickupPointId": "pickup_union_square",
  "questionAnswers": [
    {
      "questionId": "question_dietary_requirements",
      "value": "value-example"
    }
  ],
  "resourceAllocations": [
    {
      "resourceGroupId": "resource_group_front_row",
      "resourceGroup": {
        "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
        "title": "Summer Promotion",
        "split": true,
        "required": true
      },
      "resourceId": "resource_coach_12",
      "resource": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "title": "Summer Promotion",
        "capacity": 2,
        "seating": true,
        "seats": [
          {
            "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
            "row": "A",
            "column": "4",
            "status": "CONFIRMED"
          }
        ]
      },
      "seatIds": [
        "seat_one",
        "seat_two"
      ],
      "seats": [
        {
          "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
          "row": "A",
          "column": "4",
          "status": "CONFIRMED"
        }
      ],
      "paxCount": 2
    }
  ],
  "rentalDuration": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "duration": "2",
    "durationAmount": 220,
    "durationUnit": "HOUR",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included."
  },
  "rentalDurationId": "rental_duration_2h",
  "mappings": [
    {
      "resellerReference": "RES-BOOK-10045",
      "resellerStatus": "CONFIRMED",
      "resellerProduct": "grand-canyon-day-tour",
      "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
      "unitId": "unit_adult",
      "optionRequired": true,
      "unitRequired": true,
      "validityDays": 2,
      "webhookUrl": "https://www.city-sightseeing.com"
    }
  ],
  "orderId": "ord_20260514_9f3c21",
  "orderInvoicePdfUrl": "https://www.city-sightseeing.com",
  "orderReference": "ORDER-2026-0514-1001",
  "primary": true,
  "giftPayment": {
    "giftCode": "GIFT-2026-0001",
    "code": "SUMMER25",
    "amount": 220,
    "currency": "USD"
  },
  "checkedIn": true,
  "checkinAvailable": true,
  "checkinUrl": "https://checkin.city-sightseeing.com/booking/89fe0192",
  "cardPayment": {
    "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
    "cardPaymentId": "cp_20260514_42ad10",
    "gateway": "adyen",
    "source": "POS",
    "paid": 2,
    "totalPaid": 2,
    "totalRefunded": 2,
    "paidSurcharge": 2,
    "balance": 2,
    "surcharge": 2,
    "outstandingBalance": 2,
    "amount": 220,
    "currency": "USD",
    "currencyPrecision": 2,
    "status": "CONFIRMED",
    "reusableCards": [
      {
        "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
        "brand": "visa",
        "bin": "411111",
        "last4": "1111",
        "expMonth": 2,
        "expYear": 2
      }
    ],
    "adyen": {
      "environment": "test",
      "clientKey": "test_client_key_123",
      "session": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "sessionData": "session_data_payload"
      },
      "countryCode": "US",
      "paymentMethodsConfiguration": {}
    },
    "external": {},
    "provider": "adyen",
    "providerReference": "PROV-REF-2026-001",
    "createdAt": "2026-05-14T13:00:00Z"
  },
  "returnUrl": "https://checkout.city-sightseeing.com/return",
  "appendMembershipValidity": true,
  "membership": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "title": "Annual Membership",
    "contact": {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "tags": [
        "vip",
        "partner"
      ],
      "fullName": "Jane Doe",
      "title": "Ms",
      "firstName": "Jane",
      "lastName": "Doe",
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]",
      "age": 34,
      "birthdate": "1992-04-23",
      "streetAddress": "223 Market Street",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94103",
      "country": "US",
      "locales": [
        "en"
      ],
      "notes": "Vegetarian meal requested",
      "allowMarketing": false,
      "taxId": "US1234567",
      "company": "Golden Gate Tours LLC",
      "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
    },
    "reference": "REF-2026-001",
    "resellerReference": "RES-MEM-10045",
    "supplierReference": "SUP-MEM-7782",
    "availabilityLocalDateStart": "2026-01-01",
    "availabilityLocalDateEnd": "2026-12-31"
  },
  "adjustments": [
    {
      "per": "BOOKING",
      "amount": 220,
      "quantity": 2,
      "notes": "Vegetarian meal requested",
      "netDiscount": "NONE"
    }
  ],
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

List Bookings

get

Lists bookings using one required primary search filter.

Query parameters

resellerReferencestringOptional

Primary filter.

Example: RES-BOOK-10045

supplierReferencestringOptional

Primary filter.

Example: SUP-BOOK-7782

localDatestringOptional

Primary filter.

Example: 2026-05-14

localDateStartstringOptional

Primary filter start (requires localDateEnd).

Example: 2026-05-14

localDateEndstringOptional

Primary filter end (requires localDateStart).

Example: 2026-05-21

availabilityIdstringOptional

Primary filter.

Example: 2026-05-14T09:00:00-04:00

utcCreatedAtStartstringOptional

Primary filter start (requires utcCreatedAtEnd).

Example: 2026-05-14T13:00:00Z

utcCreatedAtEndstringOptional

Primary filter end (requires utcCreatedAtStart).

Example: 2026-05-14T15:00:00Z

utcUpdatedAtStartstringOptional

Primary filter start (requires utcUpdatedAtEnd).

Example: 2026-05-14T13:00:00Z

utcUpdatedAtEndstringOptional

Primary filter end (requires utcUpdatedAtStart).

Example: 2026-05-14T15:00:00Z

utcRedeemedAtStartstringOptional

Primary filter start (requires utcRedeemedAtEnd).

Example: 2026-05-14T13:00:00Z

utcRedeemedAtEndstringOptional

Primary filter end (requires utcRedeemedAtStart).

Example: 2026-05-14T15:00:00Z

utcNoshowedAtStartstringOptional

Primary filter start (requires utcNoshowedAtEnd).

Example: 2026-05-14T13:00:00Z

utcNoshowedAtEndstringOptional

Primary filter end (requires utcNoshowedAtStart).

Example: 2026-05-14T15:00:00Z

utcRebookedAtStartstringOptional

Primary filter start (requires utcRebookedAtEnd).

Example: 2026-05-14T13:00:00Z

utcRebookedAtEndstringOptional

Primary filter end (requires utcRebookedAtStart).

Example: 2026-05-14T15:00:00Z

utcCancelledAtStartstringOptional

Primary filter start (requires utcCancelledAtEnd).

Example: 2026-05-14T13:00:00Z

utcCancelledAtEndstringOptional

Primary filter end (requires utcCancelledAtStart).

Example: 2026-05-14T15:00:00Z

contactEmailAddressstringOptional

Primary filter.

Example: [email protected]

contactPhoneNumberstringOptional

Primary filter.

Example: [phone]

contactLastNamestringOptional

Primary filter. Must be at least 3 characters.

Example: Morning City Tour

statusstringOptional

Optional status filter.

Example: CONFIRMED

statusesarrayOptional

Optional multi-status filter.

Example: ["CONFIRMED","ON_HOLD"]

tagstringOptional

Optional tag filter.

Example: tag-example

productIdstringOptional

Optional product filter.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681

optionIdstringOptional

Option filter (DEFAULT matches default option).

Example: 94cdd032-3d32-416d-b0a4-abf8b7495b8b

pageintegerOptional

Optional page number.

Example: 2

perPageintegerOptional

Optional page size.

Example: 50

Responses

200

Returns an array of Booking objects.

application/json

activebooleanOptional

Whether active is enabled.

Example: true

aliasstring · nullableOptional

Alias value.

Example: booking-alias-001

availabilityIdstring · nullableOptional

Availability identifier (local date or local date-time).

Example: 2026-05-14T09:00:00-04:00

availabilityLocalDateEndstring · nullableOptional

Availability local date end value.

Example: 2026-05-21

availabilityLocalDateStartstring · nullableOptional

Availability local date start value.

Example: 2026-05-14

cancellablebooleanOptional

Whether cancellable is enabled.

Example: true

confirmablebooleanOptional

Whether confirmable is enabled.

Example: true

currencystringOptional

ISO 4217 currency code.

Example: USD

deliveryMethodsstring[]Optional

Delivery methods available on this booking. VOUCHER means use booking.voucher; TICKET means use booking.unitItems[].ticket.

Example: ["VOUCHER","TICKET"]

emailReceiptbooleanOptional

Whether email receipt is enabled.

Example: true

freesalebooleanOptional

Whether freesale is enabled.

Example: true

idstring · uuidRead-onlyOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

invoicePdfUrlstring · nullableOptional

Invoice pdf url URL.

Example: https://www.city-sightseeing.com

localDateTimeEndstring · date-timeOptional

Local date time end timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

localDateTimeStartstring · date-timeOptional

Local date time start timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested

optionIdstringRequired

Option identifier.

Example: 94cdd032-3d32-416d-b0a4-abf8b7495b8b

originalRebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

productIdstringOptional

Product identifier.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681

quotebooleanOptional

Whether quote is enabled.

Example: false

rebookingUuidstring · nullableOptional

UUID value for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

requiredContactFieldsstring[]Optional

List of required contact field values.

Example: ["fullName","emailAddress"]

resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045

settlementMethodstringOptional

Settlement method value.

Example: DIRECT

statusstring · enumRequired

Current status value.

Example: ON_HOLDPossible values:

supplierReferencestringOptional

Human-readable supplier reference to share with the guest and store for support and billing reconciliation.

Example: SUP-BOOK-7782

tagsstring[]Optional

List of tag values.

Example: ["vip","partner"]

testModebooleanOptional

Whether test mode is enabled.

Example: false

updatablebooleanOptional

Whether updatable is enabled.

Example: true

utcConfirmedAtstring · date-time · nullableOptional

Utc confirmed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcCreatedAtstring · date-timeOptional

Utc created at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcExpiresAtstring · date-time · nullableOptional

Utc expires at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcNoshowedAtstring · date-time · nullableOptional

Utc noshowed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRebookedAtstring · date-time · nullableOptional

Utc rebooked at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcRedeemedAtstring · date-time · nullableOptional

Utc redeemed at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

utcUpdatedAtstring · date-timeOptional

Utc updated at timestamp in ISO 8601 format.

Example: 2026-05-14T13:00:00Z

uuidstringRequired

User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

visibleContactFieldsstring[]Optional

List of visible contact field values.

Example: ["fullName","emailAddress"]

termsAcceptedboolean · nullableOptional

From capability octo/content.

Example: true

offerCodestring · nullableOptional

From capability octo/offers.

Example: SUMMER25

offerIsCombinationbooleanOptional

From capability octo/offers.

Example: true

offerTitlestring · nullableOptional

From capability octo/offers.

Example: Summer Promotion

packageIncludeIdstring · nullableOptional

From capability octo/packages.

Example: package_include_id-example

packageUnitItemUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

packageUuidstring · nullableOptional

From capability octo/packages.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2

dropoffNotesstring · nullableOptional

From capability octo/pickups.

Example: Drop-off at Fisherman's Wharf.

dropoffPointIdstring · nullableOptional

From capability octo/pickups.

Example: dropoff_fishermans_wharf

pickupHotelstring · nullableOptional

From capability octo/pickups.

Example: Hilton Union Square

pickupHotelRoomstring · nullableOptional

From capability octo/pickups.

Example: 1208

pickupNotesstring · nullableOptional

From capability octo/pickups.

Example: Meet the guide by the hotel lobby.

pickupPointIdstring · nullableOptional

From capability octo/pickups.

Example: pickup_union_square

rentalDurationIdstring · nullableOptional

From capability octo/rentals.

Example: rental_duration_2h

orderIdstring · nullableOptional

From capability octo/cart.

Example: ord_20260514_9f3c21

orderInvoicePdfUrlstring · nullableOptional

From capability octo/cart.

Example: https://www.city-sightseeing.com

orderReferencestring · nullableOptional

From capability octo/cart.

Example: ORDER-2026-0514-1001

primarybooleanOptional

From capability octo/cart.

Example: true

checkedInbooleanOptional

From capability octo/checkin.

Example: true

checkinAvailablebooleanOptional

From capability octo/checkin.

Example: true

checkinUrlstring · nullableOptional

From capability octo/checkin.

Example: https://checkin.city-sightseeing.com/booking/89fe0192

returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return

appendMembershipValiditybooleanOptional

From capability octo/memberships.

Example: true

identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001

get

/bookings

HTTPcURLJavaScriptPython

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

200

Returns an array of Booking objects.

[
  {
    "active": true,
    "agent": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "name": "Morning City Tour",
      "reference": "REF-2026-001",
      "tags": [
        "vip",
        "partner"
      ],
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]"
    },
    "alias": "booking-alias-001",
    "availabilityId": "2026-05-14T09:00:00-04:00",
    "availabilityLocalDateEnd": "2026-05-21",
    "availabilityLocalDateStart": "2026-05-14",
    "cancellable": true,
    "cancellation": {
      "refund": "FULL",
      "reason": "Customer request",
      "utcCancelledAt": "2026-05-14T13:00:00Z"
    },
    "confirmable": true,
    "contact": {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "tags": [
        "vip",
        "partner"
      ],
      "fullName": "Jane Doe",
      "title": "Ms",
      "firstName": "Jane",
      "lastName": "Doe",
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]",
      "age": 34,
      "birthdate": "1992-04-23",
      "streetAddress": "223 Market Street",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94103",
      "country": "US",
      "locales": [
        "en"
      ],
      "notes": "Vegetarian meal requested",
      "allowMarketing": false,
      "taxId": "US1234567",
      "company": "Golden Gate Tours LLC",
      "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
    },
    "currency": "USD",
    "deliveryMethods": [
      "VOUCHER",
      "TICKET"
    ],
    "driver": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "name": "Morning City Tour",
      "reference": "REF-2026-001",
      "tags": [
        "vip",
        "partner"
      ],
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]"
    },
    "emailReceipt": true,
    "freesale": true,
    "guide": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "name": "Morning City Tour",
      "reference": "REF-2026-001",
      "tags": [
        "vip",
        "partner"
      ],
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]"
    },
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "invoicePdfUrl": "https://www.city-sightseeing.com",
    "label": {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "name": "Morning City Tour"
    },
    "localDateTimeEnd": "2026-05-14T13:00:00Z",
    "localDateTimeStart": "2026-05-14T13:00:00Z",
    "metadata": {
      "bookingSource": "affiliate_portal",
      "partnerOrderId": "PO-12345"
    },
    "notes": "Vegetarian meal requested",
    "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
    "originalRebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "quote": false,
    "rebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "rejection": {
      "reason": "Customer request",
      "utcRejectedAt": "2026-05-14T13:00:00Z"
    },
    "requiredContactFields": [
      "fullName",
      "emailAddress"
    ],
    "reseller": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "name": "Morning City Tour",
      "reference": "REF-2026-001",
      "tags": [
        "vip",
        "partner"
      ],
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]"
    },
    "resellerReference": "RES-BOOK-10045",
    "seller": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "name": "Morning City Tour",
      "reference": "REF-2026-001",
      "tags": [
        "vip",
        "partner"
      ],
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]"
    },
    "settlementMethod": "DIRECT",
    "status": "ON_HOLD",
    "supplierReference": "SUP-BOOK-7782",
    "tags": [
      "vip",
      "partner"
    ],
    "testMode": false,
    "tickets": [
      {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
          }
        ]
      }
    ],
    "unitItems": [
      {
        "alias": "booking-alias-001",
        "contact": {
          "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "tags": [
            "vip",
            "partner"
          ],
          "fullName": "Jane Doe",
          "title": "Ms",
          "firstName": "Jane",
          "lastName": "Doe",
          "emailAddress": "[email protected]",
          "phoneNumber": "[phone]",
          "age": 34,
          "birthdate": "1992-04-23",
          "streetAddress": "223 Market Street",
          "city": "San Francisco",
          "state": "CA",
          "postalCode": "94103",
          "country": "US",
          "locales": [
            "en"
          ],
          "notes": "Vegetarian meal requested",
          "allowMarketing": false,
          "taxId": "US1234567",
          "company": "Golden Gate Tours LLC",
          "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
        },
        "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
        "localDateTimeEnd": "2026-05-14T13:00:00Z",
        "localDateTimeStart": "2026-05-14T13:00:00Z",
        "originalRebookingUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "originalRebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "rebookingUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "rebookingUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "requiredContactFields": [
          "fullName",
          "emailAddress"
        ],
        "resellerReference": "RES-BOOK-10045",
        "status": "CONFIRMED",
        "supplierReference": "SUP-BOOK-7782",
        "ticket": {
          "redemptionMethod": "DIGITAL",
          "utcRedeemedAt": "2026-05-14T13:00:00Z",
          "utcNoshowedAt": "2026-05-14T13:00:00Z",
          "deliveryOptions": [
            {
              "deliveryFormat": "PDF_URL",
              "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
            }
          ]
        },
        "unitId": "unit_adult",
        "unitType": "ADULT",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "utcRebookedAt": "2026-05-14T13:00:00Z",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "visibleContactFields": [
          "fullName",
          "emailAddress"
        ],
        "weightUnit": "kg",
        "weightValue": 20,
        "pricing": {
          "currency": "USD",
          "currencyPrecision": 2,
          "net": 18000,
          "original": 22000,
          "retail": 20000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "original": 2000,
              "retail": 1800,
              "net": 1600
            }
          ],
          "offerDiscount": {
            "retail": 2000,
            "net": 2000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "retail": 200,
                "net": 200
              }
            ]
          }
        },
        "offerCode": "SUMMER25",
        "offerComparisons": [
          {
            "offerCode": "SUMMER25",
            "offerTitle": "Summer Promotion",
            "pricing": {
              "currency": "USD",
              "currencyPrecision": 2,
              "net": 18000,
              "original": 22000,
              "retail": 20000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "original": 2000,
                  "retail": 1800,
                  "net": 1600
                }
              ],
              "offerDiscount": {
                "retail": 2000,
                "net": 2000,
                "includedTaxes": [
                  {
                    "name": "Sales Tax",
                    "shortDescription": "Local sales tax",
                    "retail": 200,
                    "net": 200
                  }
                ]
              }
            },
            "offer": {
              "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
              "tags": [
                "vip",
                "partner"
              ],
              "title": "Summer Promotion",
              "label": "Save 20%",
              "code": "SUMMER25",
              "description": "20% off selected departures this month.",
              "netDiscount": "FULL",
              "restrictions": {
                "minUnits": 1,
                "maxUnits": 10,
                "minTotal": 0,
                "maxTotal": 50000,
                "unitIds": [
                  "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                  "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
                ]
              },
              "usable": true,
              "unusableReason": "Offer is not valid for the selected date.",
              "membershipBenefit": {
                "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
                "title": "Summer Promotion",
                "description": "Morning departure with central pickup included."
              }
            }
          }
        ],
        "offerIsCombination": true,
        "offerTitle": "Summer Promotion",
        "extraItems": [
          {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "resellerReference": "RES-BOOK-10045",
            "supplierReference": "SUP-BOOK-7782",
            "extraId": "extra_fast_track",
            "status": "CONFIRMED",
            "utcRedeemedAt": "2026-05-14T13:00:00Z",
            "contact": {
              "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
              "tags": [
                "vip",
                "partner"
              ],
              "fullName": "Jane Doe",
              "title": "Ms",
              "firstName": "Jane",
              "lastName": "Doe",
              "emailAddress": "[email protected]",
              "phoneNumber": "[phone]",
              "age": 34,
              "birthdate": "1992-04-23",
              "streetAddress": "223 Market Street",
              "city": "San Francisco",
              "state": "CA",
              "postalCode": "94103",
              "country": "US",
              "locales": [
                "en"
              ],
              "notes": "Vegetarian meal requested",
              "allowMarketing": false,
              "taxId": "US1234567",
              "company": "Golden Gate Tours LLC",
              "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
            },
            "visibleContactFields": [
              "fullName",
              "emailAddress"
            ],
            "requiredContactFields": [
              "fullName",
              "emailAddress"
            ],
            "ticket": {
              "redemptionMethod": "DIGITAL",
              "utcRedeemedAt": "2026-05-14T13:00:00Z",
              "utcNoshowedAt": "2026-05-14T13:00:00Z",
              "deliveryOptions": [
                {
                  "deliveryFormat": "PDF_URL",
                  "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
                }
              ]
            },
            "pricing": {
              "currency": "USD",
              "currencyPrecision": 2,
              "net": 18000,
              "original": 22000,
              "retail": 20000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "original": 2000,
                  "retail": 1800,
                  "net": 1600
                }
              ],
              "offerDiscount": {
                "retail": 2000,
                "net": 2000,
                "includedTaxes": [
                  {
                    "name": "Sales Tax",
                    "shortDescription": "Local sales tax",
                    "retail": 200,
                    "net": 200
                  }
                ]
              }
            },
            "offerCode": "SUMMER25",
            "offerTitle": "Summer Promotion",
            "offerIsCombination": true,
            "offerComparisons": [
              {
                "offerCode": "SUMMER25",
                "offerTitle": "Summer Promotion",
                "pricing": {
                  "currency": "USD",
                  "currencyPrecision": 2,
                  "net": 18000,
                  "original": 22000,
                  "retail": 20000,
                  "includedTaxes": [
                    {
                      "name": "Sales Tax",
                      "shortDescription": "Local sales tax",
                      "original": 2000,
                      "retail": 1800,
                      "net": 1600
                    }
                  ],
                  "offerDiscount": {
                    "retail": 2000,
                    "net": 2000,
                    "includedTaxes": [
                      {
                        "name": "Sales Tax",
                        "shortDescription": "Local sales tax",
                        "retail": 200,
                        "net": 200
                      }
                    ]
                  }
                },
                "offer": {
                  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
                  "tags": [
                    "vip",
                    "partner"
                  ],
                  "title": "Summer Promotion",
                  "label": "Save 20%",
                  "code": "SUMMER25",
                  "description": "20% off selected departures this month.",
                  "netDiscount": "FULL",
                  "restrictions": {
                    "minUnits": 1,
                    "maxUnits": 10,
                    "minTotal": 0,
                    "maxTotal": 50000,
                    "unitIds": [
                      "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                      "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
                    ]
                  },
                  "usable": true,
                  "unusableReason": "Offer is not valid for the selected date.",
                  "membershipBenefit": {
                    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
                    "title": "Summer Promotion",
                    "description": "Morning departure with central pickup included."
                  }
                }
              }
            ]
          }
        ],
        "packageIncludeId": "package_include_id-example",
        "packageUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "questionAnswers": [
          {
            "questionId": "question_dietary_requirements",
            "value": "value-example"
          }
        ],
        "scans": [
          {
            "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
            "status": "CONFIRMED",
            "utcScannedAt": "2026-05-14T13:00:00Z",
            "seller": {
              "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
              "name": "Morning City Tour",
              "reference": "REF-2026-001",
              "tags": [
                "vip",
                "partner"
              ],
              "emailAddress": "[email protected]",
              "phoneNumber": "[phone]"
            }
          }
        ]
      }
    ],
    "updatable": true,
    "user": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "name": "Morning City Tour",
      "reference": "REF-2026-001",
      "tags": [
        "vip",
        "partner"
      ],
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]"
    },
    "utcConfirmedAt": "2026-05-14T13:00:00Z",
    "utcCreatedAt": "2026-05-14T13:00:00Z",
    "utcExpiresAt": "2026-05-14T13:00:00Z",
    "utcNoshowedAt": "2026-05-14T13:00:00Z",
    "utcRebookedAt": "2026-05-14T13:00:00Z",
    "utcRedeemedAt": "2026-05-14T13:00:00Z",
    "utcUpdatedAt": "2026-05-14T13:00:00Z",
    "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "visibleContactFields": [
      "fullName",
      "emailAddress"
    ],
    "voucher": {
      "redemptionMethod": "DIGITAL",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "utcNoshowedAt": "2026-05-14T13:00:00Z",
      "deliveryOptions": [
        {
          "deliveryFormat": "PDF_URL",
          "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
        }
      ]
    },
    "pricing": {
      "currency": "USD",
      "currencyPrecision": 2,
      "net": 18000,
      "original": 22000,
      "retail": 20000,
      "includedTaxes": [
        {
          "name": "Sales Tax",
          "shortDescription": "Local sales tax",
          "original": 2000,
          "retail": 1800,
          "net": 1600
        }
      ],
      "offerDiscount": {
        "retail": 2000,
        "net": 2000,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "retail": 200,
            "net": 200
          }
        ]
      }
    },
    "termsAccepted": true,
    "offerCode": "SUMMER25",
    "offerComparisons": [
      {
        "offerCode": "SUMMER25",
        "offerTitle": "Summer Promotion",
        "pricing": {
          "currency": "USD",
          "currencyPrecision": 2,
          "net": 18000,
          "original": 22000,
          "retail": 20000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "original": 2000,
              "retail": 1800,
              "net": 1600
            }
          ],
          "offerDiscount": {
            "retail": 2000,
            "net": 2000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "retail": 200,
                "net": 200
              }
            ]
          }
        },
        "offer": {
          "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "tags": [
            "vip",
            "partner"
          ],
          "title": "Summer Promotion",
          "label": "Save 20%",
          "code": "SUMMER25",
          "description": "20% off selected departures this month.",
          "netDiscount": "FULL",
          "restrictions": {
            "minUnits": 1,
            "maxUnits": 10,
            "minTotal": 0,
            "maxTotal": 50000,
            "unitIds": [
              "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
              "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
            ]
          },
          "usable": true,
          "unusableReason": "Offer is not valid for the selected date.",
          "membershipBenefit": {
            "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
            "title": "Summer Promotion",
            "description": "Morning departure with central pickup included."
          }
        }
      }
    ],
    "offerIsCombination": true,
    "offerTitle": "Summer Promotion",
    "extraItems": [
      {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "resellerReference": "RES-BOOK-10045",
        "supplierReference": "SUP-BOOK-7782",
        "extraId": "extra_fast_track",
        "status": "CONFIRMED",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "contact": {
          "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "tags": [
            "vip",
            "partner"
          ],
          "fullName": "Jane Doe",
          "title": "Ms",
          "firstName": "Jane",
          "lastName": "Doe",
          "emailAddress": "[email protected]",
          "phoneNumber": "[phone]",
          "age": 34,
          "birthdate": "1992-04-23",
          "streetAddress": "223 Market Street",
          "city": "San Francisco",
          "state": "CA",
          "postalCode": "94103",
          "country": "US",
          "locales": [
            "en"
          ],
          "notes": "Vegetarian meal requested",
          "allowMarketing": false,
          "taxId": "US1234567",
          "company": "Golden Gate Tours LLC",
          "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
        },
        "visibleContactFields": [
          "fullName",
          "emailAddress"
        ],
        "requiredContactFields": [
          "fullName",
          "emailAddress"
        ],
        "ticket": {
          "redemptionMethod": "DIGITAL",
          "utcRedeemedAt": "2026-05-14T13:00:00Z",
          "utcNoshowedAt": "2026-05-14T13:00:00Z",
          "deliveryOptions": [
            {
              "deliveryFormat": "PDF_URL",
              "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
            }
          ]
        },
        "pricing": {
          "currency": "USD",
          "currencyPrecision": 2,
          "net": 18000,
          "original": 22000,
          "retail": 20000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "original": 2000,
              "retail": 1800,
              "net": 1600
            }
          ],
          "offerDiscount": {
            "retail": 2000,
            "net": 2000,
            "includedTaxes": [
              {
                "name": "Sales Tax",
                "shortDescription": "Local sales tax",
                "retail": 200,
                "net": 200
              }
            ]
          }
        },
        "offerCode": "SUMMER25",
        "offerTitle": "Summer Promotion",
        "offerIsCombination": true,
        "offerComparisons": [
          {
            "offerCode": "SUMMER25",
            "offerTitle": "Summer Promotion",
            "pricing": {
              "currency": "USD",
              "currencyPrecision": 2,
              "net": 18000,
              "original": 22000,
              "retail": 20000,
              "includedTaxes": [
                {
                  "name": "Sales Tax",
                  "shortDescription": "Local sales tax",
                  "original": 2000,
                  "retail": 1800,
                  "net": 1600
                }
              ],
              "offerDiscount": {
                "retail": 2000,
                "net": 2000,
                "includedTaxes": [
                  {
                    "name": "Sales Tax",
                    "shortDescription": "Local sales tax",
                    "retail": 200,
                    "net": 200
                  }
                ]
              }
            },
            "offer": {
              "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
              "tags": [
                "vip",
                "partner"
              ],
              "title": "Summer Promotion",
              "label": "Save 20%",
              "code": "SUMMER25",
              "description": "20% off selected departures this month.",
              "netDiscount": "FULL",
              "restrictions": {
                "minUnits": 1,
                "maxUnits": 10,
                "minTotal": 0,
                "maxTotal": 50000,
                "unitIds": [
                  "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
                  "6b65fd83-4a1f-4744-8f4a-c24d8d770f29"
                ]
              },
              "usable": true,
              "unusableReason": "Offer is not valid for the selected date.",
              "membershipBenefit": {
                "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
                "title": "Summer Promotion",
                "description": "Morning departure with central pickup included."
              }
            }
          }
        ]
      }
    ],
    "packageIncludeId": "package_include_id-example",
    "packageUnitItemUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "packageUuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "dropoffDispatch": {
      "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
      "name": "Morning City Tour",
      "phoneNumber": "[phone]",
      "vehicle": "coach_12"
    },
    "dropoffNotes": "Drop-off at Fisherman's Wharf.",
    "dropoffPoint": {
      "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
      "title": "Summer Promotion",
      "description": "Morning departure with central pickup included.",
      "localDateTime": "2026-05-14",
      "localDateTimeTo": "2026-05-14",
      "latitude": 10,
      "longitude": 10,
      "address": "123 Main St, San Francisco, CA",
      "googlePlaceId": "google_place_id-example"
    },
    "dropoffPointId": "dropoff_fishermans_wharf",
    "pickupDispatch": {
      "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
      "name": "Morning City Tour",
      "phoneNumber": "[phone]",
      "vehicle": "coach_12"
    },
    "pickupHotel": "Hilton Union Square",
    "pickupHotelRoom": "1208",
    "pickupNotes": "Meet the guide by the hotel lobby.",
    "pickupPoint": {
      "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
      "title": "Summer Promotion",
      "description": "Morning departure with central pickup included.",
      "localDateTime": "2026-05-14",
      "localDateTimeTo": "2026-05-14",
      "latitude": 10,
      "longitude": 10,
      "address": "123 Main St, San Francisco, CA",
      "googlePlaceId": "google_place_id-example"
    },
    "pickupPointId": "pickup_union_square",
    "questionAnswers": [
      {
        "questionId": "question_dietary_requirements",
        "value": "value-example"
      }
    ],
    "resourceAllocations": [
      {
        "resourceGroupId": "resource_group_front_row",
        "resourceGroup": {
          "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
          "title": "Summer Promotion",
          "split": true,
          "required": true
        },
        "resourceId": "resource_coach_12",
        "resource": {
          "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "title": "Summer Promotion",
          "capacity": 2,
          "seating": true,
          "seats": [
            {
              "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
              "row": "A",
              "column": "4",
              "status": "CONFIRMED"
            }
          ]
        },
        "seatIds": [
          "seat_one",
          "seat_two"
        ],
        "seats": [
          {
            "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
            "row": "A",
            "column": "4",
            "status": "CONFIRMED"
          }
        ],
        "paxCount": 2
      }
    ],
    "rentalDuration": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "duration": "2",
      "durationAmount": 220,
      "durationUnit": "HOUR",
      "title": "Summer Promotion",
      "description": "Morning departure with central pickup included."
    },
    "rentalDurationId": "rental_duration_2h",
    "mappings": [
      {
        "resellerReference": "RES-BOOK-10045",
        "resellerStatus": "CONFIRMED",
        "resellerProduct": "grand-canyon-day-tour",
        "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
        "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
        "unitId": "unit_adult",
        "optionRequired": true,
        "unitRequired": true,
        "validityDays": 2,
        "webhookUrl": "https://www.city-sightseeing.com"
      }
    ],
    "orderId": "ord_20260514_9f3c21",
    "orderInvoicePdfUrl": "https://www.city-sightseeing.com",
    "orderReference": "ORDER-2026-0514-1001",
    "primary": true,
    "giftPayment": {
      "giftCode": "GIFT-2026-0001",
      "code": "SUMMER25",
      "amount": 220,
      "currency": "USD"
    },
    "checkedIn": true,
    "checkinAvailable": true,
    "checkinUrl": "https://checkin.city-sightseeing.com/booking/89fe0192",
    "cardPayment": {
      "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
      "cardPaymentId": "cp_20260514_42ad10",
      "gateway": "adyen",
      "source": "POS",
      "paid": 2,
      "totalPaid": 2,
      "totalRefunded": 2,
      "paidSurcharge": 2,
      "balance": 2,
      "surcharge": 2,
      "outstandingBalance": 2,
      "amount": 220,
      "currency": "USD",
      "currencyPrecision": 2,
      "status": "CONFIRMED",
      "reusableCards": [
        {
          "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
          "brand": "visa",
          "bin": "411111",
          "last4": "1111",
          "expMonth": 2,
          "expYear": 2
        }
      ],
      "adyen": {
        "environment": "test",
        "clientKey": "test_client_key_123",
        "session": {
          "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "sessionData": "session_data_payload"
        },
        "countryCode": "US",
        "paymentMethodsConfiguration": {}
      },
      "external": {},
      "provider": "adyen",
      "providerReference": "PROV-REF-2026-001",
      "createdAt": "2026-05-14T13:00:00Z"
    },
    "returnUrl": "https://checkout.city-sightseeing.com/return",
    "appendMembershipValidity": true,
    "membership": {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "title": "Annual Membership",
      "contact": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "tags": [
          "vip",
          "partner"
        ],
        "fullName": "Jane Doe",
        "title": "Ms",
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "[email protected]",
        "phoneNumber": "[phone]",
        "age": 34,
        "birthdate": "1992-04-23",
        "streetAddress": "223 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94103",
        "country": "US",
        "locales": [
          "en"
        ],
        "notes": "Vegetarian meal requested",
        "allowMarketing": false,
        "taxId": "US1234567",
        "company": "Golden Gate Tours LLC",
        "photoUrl": "https://images.ventrata.com/profiles/jane-doe.jpg"
      },
      "reference": "REF-2026-001",
      "resellerReference": "RES-MEM-10045",
      "supplierReference": "SUP-MEM-7782",
      "availabilityLocalDateStart": "2026-01-01",
      "availabilityLocalDateEnd": "2026-12-31"
    },
    "adjustments": [
      {
        "per": "BOOKING",
        "amount": 220,
        "quantity": 2,
        "notes": "Vegetarian meal requested",
        "netDiscount": "NONE"
      }
    ],
    "identity": {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "key": "loyalty_number"
    },
    "identityId": "identity_customer_001"
  }
]

After Confirmation: Fields to Use

When POST /bookings/{uuid}/confirm succeeds, prioritize these fields from the booking response:

• booking.supplierReference: Human-readable supplier reference. Give this to the guest and store it for customer support and billing reconciliation.

• booking.voucher: Use when booking.deliveryMethods contains VOUCHER (one ticket media object per booking).

• booking.unitItems[].ticket: Use when booking.deliveryMethods contains TICKET (one ticket media object per person/unit item).

• booking.pricing.retail: Retail amount in minor units that you must charge the guest for the booking.

• booking.pricing.net: Net amount in minor units that the supplier will invoice for the booking.

If booking.deliveryMethods contains both VOUCHER and TICKET, the reseller can choose what the guest prefers: one voucher for the booking, or one ticket per person.

The booking.voucher and booking.unitItems[].ticket objects have the same shape and provide guest-facing media in deliveryOptions (for example PDF_URL, QRCODE, and wallet links).

{
  "supplierReference": "SUP-20260304-009871",
  "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
  "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
  "availabilityId": "2026-03-04T18:30:00+01:00",
  "deliveryMethods": ["VOUCHER", "TICKET"],
  "voucher": {
    "deliveryOptions": [
      {
        "deliveryFormat": "PDF_URL",
        "deliveryValue": "https://api.ventrata.com/octo/download/booking/89fe0192-ddcd-430a-b285-e1396a4725d2.pdf"
      }
    ]
  },
  "unitItems": [
    {
      "ticket": {
        "deliveryOptions": [
          {
            "deliveryFormat": "QRCODE",
            "deliveryValue": "TKT-11111111"
          }
        ]
      }
    }
  ],
  "pricing": {
    "retail": 4600,
    "net": 3220,
    "currency": "USD",
    "currencyPrecision": 2
  }
}

For GET /bookings, include one primary filter from this set:

• resellerReference

• supplierReference

• localDate

• localDateStart + localDateEnd

• availabilityId

• utcCreatedAtStart + utcCreatedAtEnd

• utcUpdatedAtStart + utcUpdatedAtEnd

• utcRedeemedAtStart + utcRedeemedAtEnd

• utcNoshowedAtStart + utcNoshowedAtEnd

• utcRebookedAtStart + utcRebookedAtEnd

• utcCancelledAtStart + utcCancelledAtEnd

• contactEmailAddress

• contactPhoneNumber

• contactLastName

Supported status filter values are:

• REDEEMED

• NO_SHOW

• ON_HOLD

• CANCELLED

• EXPIRED

• PENDING

• REJECTED

• REBOOKED

• QUOTE

• CONFIRMED

Pagination notes:

• page and perPage are supported.

• Octo-Total-Pages response header is set when paginating.

• When page is omitted, the API may aggregate all pages internally and return one combined array.

Voucher/ticket delivery URLs are returned directly in voucher.deliveryOptions[].deliveryValue and unitItems[].ticket.deliveryOptions[].deliveryValue.