Ctrlk
Ventrata.comOCTO.travel
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Gift Vouchers

Allows you to sell and redeem gift vouchers

To use this capability, add octo/gifts to your Octo-Capabilities header.

Gift vouchers allow you to sell fixed value monetary amounts in the form of a gift card which can be redeemed later as a form of payment against a new order.

All paths below are under /octo.

Endpoints

Gift voucher routes are documented below.

Create Gift

post

Create a gift with offerCode.

Body
amountnumber · floatOptional

Amount numeric value.

Example: 220
currencystringOptional

ISO 4217 currency code.

Example: USD
messagestringOptional

Message value.

Example: Request accepted for asynchronous processing.
resellerReferencestringOptional

Reseller reference value.

Example: RES-BOOK-10045
uuidstringOptional

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
orderIdstringOptional

From capability octo/cart.

Example: ord_20260514_9f3c21
returnUrlstring · uriOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001
Responses
200

Successful response

application/json
activebooleanOptional

Whether active is enabled.

Example: true
aliasstring · nullableOptional

Alias value.

Example: booking-alias-001
amountnumber · floatOptional

Amount numeric value.

Example: 200
cancellablebooleanOptional

Whether cancellable is enabled.

Example: true
confirmablebooleanOptional

Whether confirmable is enabled.

Example: true
currencystringRequired

ISO 4217 currency code.

Example: USD
deliveryMethodsstring[]Optional

List of delivery method values.

Example: ["VOUCHER","TICKET"]
idstring · uuidOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2
messagestring · nullableOptional

Message value.

Example: Request accepted for asynchronous processing.
notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested
resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045
settlementMethodstringOptional

Settlement method value.

Example: DIRECT
statusstringRequired

Current status value.

Example: CONFIRMED
supplierReferencestring · nullableOptional

Supplier reference value.

Example: SUP-BOOK-7782
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
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: gift_20260514_ba21f7
weightnumberOptional

Weight numeric value.

Example: 0
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
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
returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001
post/gifts
POST /octo/gifts HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 1970

{
  "amount": 220,
  "contact": {
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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",
  "message": "Request accepted for asynchronous processing.",
  "recipient": {
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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",
  "termsAccepted": true,
  "offerCode": "SUMMER25",
  "orderId": "ord_20260514_9f3c21",
  "giftPayment": {
    "code": "SUMMER25"
  },
  "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",
  "membership": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "email": "jane.doe@goldengatetours.com",
    "mobile": "+12025550123",
    "country": "US",
    "reference": "REF-2026-001",
    "verification": "123456"
  },
  "identityId": "identity_customer_001"
}
200

Successful response

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "alias": "booking-alias-001",
  "amount": 200,
  "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": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  ],
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "message": "Request accepted for asynchronous processing.",
  "notes": "Vegetarian meal requested",
  "recipient": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  },
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "settlementMethod": "DIRECT",
  "status": "CONFIRMED",
  "supplierReference": "SUP-BOOK-7782",
  "testMode": false,
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "gift_20260514_ba21f7",
  "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"
      }
    ]
  },
  "weight": 0,
  "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,
  "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."
    }
  },
  "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",
  "offers": [
    {
      "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."
      }
    }
  ],
  "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"
  },
  "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",
  "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": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123",
      "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"
  },
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

The UUID on the request body is optional but recommended if you're requesting from a source of poor network connectivity. If the connection fails or you do not receive a response, you can repeat the same request with the same UUID and it will respond with the same gift object without duplicating the gift voucher.

The gift voucher object returned by all gift endpoints in this section is also used in order responses under gifts[].

Update Gift

patch

Update a gift with offerCode.

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
amountnumber · floatOptional

Amount numeric value.

Example: 220
currencystringOptional

ISO 4217 currency code.

Example: USD
messagestringOptional

Message value.

Example: Request accepted for asynchronous processing.
resellerReferencestringOptional

Reseller reference value.

Example: RES-BOOK-10045
uuidstringOptional

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
orderIdstringOptional

From capability octo/cart.

Example: ord_20260514_9f3c21
returnUrlstring · uriOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001
Responses
200

Successful response

application/json
activebooleanOptional

Whether active is enabled.

Example: true
aliasstring · nullableOptional

Alias value.

Example: booking-alias-001
amountnumber · floatOptional

Amount numeric value.

Example: 200
cancellablebooleanOptional

Whether cancellable is enabled.

Example: true
confirmablebooleanOptional

Whether confirmable is enabled.

Example: true
currencystringRequired

ISO 4217 currency code.

Example: USD
deliveryMethodsstring[]Optional

List of delivery method values.

Example: ["VOUCHER","TICKET"]
idstring · uuidOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2
messagestring · nullableOptional

Message value.

Example: Request accepted for asynchronous processing.
notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested
resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045
settlementMethodstringOptional

Settlement method value.

Example: DIRECT
statusstringRequired

Current status value.

Example: CONFIRMED
supplierReferencestring · nullableOptional

Supplier reference value.

Example: SUP-BOOK-7782
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
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: gift_20260514_ba21f7
weightnumberOptional

Weight numeric value.

Example: 0
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
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
returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001
patch/gifts/{uuid}
PATCH /octo/gifts/{uuid} HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 1970

{
  "amount": 220,
  "contact": {
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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",
  "message": "Request accepted for asynchronous processing.",
  "recipient": {
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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",
  "termsAccepted": true,
  "offerCode": "SUMMER25",
  "orderId": "ord_20260514_9f3c21",
  "giftPayment": {
    "code": "SUMMER25"
  },
  "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",
  "membership": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "email": "jane.doe@goldengatetours.com",
    "mobile": "+12025550123",
    "country": "US",
    "reference": "REF-2026-001",
    "verification": "123456"
  },
  "identityId": "identity_customer_001"
}
200

Successful response

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "alias": "booking-alias-001",
  "amount": 200,
  "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": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  ],
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "message": "Request accepted for asynchronous processing.",
  "notes": "Vegetarian meal requested",
  "recipient": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  },
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "settlementMethod": "DIRECT",
  "status": "CONFIRMED",
  "supplierReference": "SUP-BOOK-7782",
  "testMode": false,
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "gift_20260514_ba21f7",
  "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"
      }
    ]
  },
  "weight": 0,
  "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,
  "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."
    }
  },
  "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",
  "offers": [
    {
      "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."
      }
    }
  ],
  "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"
  },
  "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",
  "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": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123",
      "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"
  },
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

You can update a gift voucher before and after it has been confirmed as long as it has not been redeemed and is still updateable. To check this, use the gift.updatable field.

Gift Offers Preview

patch

Preview gift updates with offerCode.

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
amountnumber · floatOptional

Amount numeric value.

Example: 220
currencystringOptional

ISO 4217 currency code.

Example: USD
messagestringOptional

Message value.

Example: Request accepted for asynchronous processing.
resellerReferencestringOptional

Reseller reference value.

Example: RES-BOOK-10045
uuidstringOptional

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
orderIdstringOptional

From capability octo/cart.

Example: ord_20260514_9f3c21
returnUrlstring · uriOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001
Responses
200

Successful response

application/json
activebooleanOptional

Whether active is enabled.

Example: true
aliasstring · nullableOptional

Alias value.

Example: booking-alias-001
amountnumber · floatOptional

Amount numeric value.

Example: 200
cancellablebooleanOptional

Whether cancellable is enabled.

Example: true
confirmablebooleanOptional

Whether confirmable is enabled.

Example: true
currencystringRequired

ISO 4217 currency code.

Example: USD
deliveryMethodsstring[]Optional

List of delivery method values.

Example: ["VOUCHER","TICKET"]
idstring · uuidOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2
messagestring · nullableOptional

Message value.

Example: Request accepted for asynchronous processing.
notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested
resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045
settlementMethodstringOptional

Settlement method value.

Example: DIRECT
statusstringRequired

Current status value.

Example: CONFIRMED
supplierReferencestring · nullableOptional

Supplier reference value.

Example: SUP-BOOK-7782
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
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: gift_20260514_ba21f7
weightnumberOptional

Weight numeric value.

Example: 0
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
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
returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001
patch/gifts/{uuid}/preview
PATCH /octo/gifts/{uuid}/preview HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 1970

{
  "amount": 220,
  "contact": {
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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",
  "message": "Request accepted for asynchronous processing.",
  "recipient": {
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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",
  "termsAccepted": true,
  "offerCode": "SUMMER25",
  "orderId": "ord_20260514_9f3c21",
  "giftPayment": {
    "code": "SUMMER25"
  },
  "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",
  "membership": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "email": "jane.doe@goldengatetours.com",
    "mobile": "+12025550123",
    "country": "US",
    "reference": "REF-2026-001",
    "verification": "123456"
  },
  "identityId": "identity_customer_001"
}
200

Successful response

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "alias": "booking-alias-001",
  "amount": 200,
  "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": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  ],
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "message": "Request accepted for asynchronous processing.",
  "notes": "Vegetarian meal requested",
  "recipient": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  },
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "settlementMethod": "DIRECT",
  "status": "CONFIRMED",
  "supplierReference": "SUP-BOOK-7782",
  "testMode": false,
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "gift_20260514_ba21f7",
  "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"
      }
    ]
  },
  "weight": 0,
  "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,
  "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."
    }
  },
  "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",
  "offers": [
    {
      "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."
      }
    }
  ],
  "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"
  },
  "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",
  "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": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123",
      "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"
  },
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

Gift Offers Confirmation

post

Confirm an existing gift with offerCode.

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
amountnumber · floatOptional

Amount numeric value.

Example: 220
currencystringOptional

ISO 4217 currency code.

Example: USD
messagestringOptional

Message value.

Example: Request accepted for asynchronous processing.
resellerReferencestringOptional

Reseller reference value.

Example: RES-BOOK-10045
uuidstringOptional

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
orderIdstringOptional

From capability octo/cart.

Example: ord_20260514_9f3c21
returnUrlstring · uriOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001
Responses
200

Successful response

application/json
activebooleanOptional

Whether active is enabled.

Example: true
aliasstring · nullableOptional

Alias value.

Example: booking-alias-001
amountnumber · floatOptional

Amount numeric value.

Example: 200
cancellablebooleanOptional

Whether cancellable is enabled.

Example: true
confirmablebooleanOptional

Whether confirmable is enabled.

Example: true
currencystringRequired

ISO 4217 currency code.

Example: USD
deliveryMethodsstring[]Optional

List of delivery method values.

Example: ["VOUCHER","TICKET"]
idstring · uuidOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2
messagestring · nullableOptional

Message value.

Example: Request accepted for asynchronous processing.
notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested
resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045
settlementMethodstringOptional

Settlement method value.

Example: DIRECT
statusstringRequired

Current status value.

Example: CONFIRMED
supplierReferencestring · nullableOptional

Supplier reference value.

Example: SUP-BOOK-7782
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
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: gift_20260514_ba21f7
weightnumberOptional

Weight numeric value.

Example: 0
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
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
returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001
post/gifts/{uuid}/confirm
POST /octo/gifts/{uuid}/confirm HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 1970

{
  "amount": 220,
  "contact": {
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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",
  "message": "Request accepted for asynchronous processing.",
  "recipient": {
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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",
  "termsAccepted": true,
  "offerCode": "SUMMER25",
  "orderId": "ord_20260514_9f3c21",
  "giftPayment": {
    "code": "SUMMER25"
  },
  "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",
  "membership": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "email": "jane.doe@goldengatetours.com",
    "mobile": "+12025550123",
    "country": "US",
    "reference": "REF-2026-001",
    "verification": "123456"
  },
  "identityId": "identity_customer_001"
}
200

Successful response

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "alias": "booking-alias-001",
  "amount": 200,
  "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": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  ],
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "message": "Request accepted for asynchronous processing.",
  "notes": "Vegetarian meal requested",
  "recipient": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  },
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "settlementMethod": "DIRECT",
  "status": "CONFIRMED",
  "supplierReference": "SUP-BOOK-7782",
  "testMode": false,
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "gift_20260514_ba21f7",
  "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"
      }
    ]
  },
  "weight": 0,
  "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,
  "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."
    }
  },
  "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",
  "offers": [
    {
      "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."
      }
    }
  ],
  "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"
  },
  "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",
  "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": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123",
      "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"
  },
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

See the confirmation operation above for request examples.

Once the gift is confirmed and deliverable, voucher delivery options are populated on the response.

The deliveryValue for QRCODE can be typed online to redeem the gift voucher, and URL-based formats can be shared directly with the guest.

Delete Gift

delete

Cancel a gift voucher.

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
Query parameters
reasonstringOptional

Cancellation reason. If not a known enum value, source stores this as cancellation notes with reason other.

Example: Customer request
forcebooleanOptional

Force cancellation when allowed by cancellation rules.

Example: true
Body
amountnumber · floatOptional

Amount numeric value.

Example: 220
currencystringOptional

ISO 4217 currency code.

Example: USD
messagestringOptional

Message value.

Example: Request accepted for asynchronous processing.
resellerReferencestringOptional

Reseller reference value.

Example: RES-BOOK-10045
uuidstringOptional

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
orderIdstringOptional

From capability octo/cart.

Example: ord_20260514_9f3c21
returnUrlstring · uriOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001
Responses
200

Successful response

application/json
activebooleanOptional

Whether active is enabled.

Example: true
aliasstring · nullableOptional

Alias value.

Example: booking-alias-001
amountnumber · floatOptional

Amount numeric value.

Example: 200
cancellablebooleanOptional

Whether cancellable is enabled.

Example: true
confirmablebooleanOptional

Whether confirmable is enabled.

Example: true
currencystringRequired

ISO 4217 currency code.

Example: USD
deliveryMethodsstring[]Optional

List of delivery method values.

Example: ["VOUCHER","TICKET"]
idstring · uuidOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2
messagestring · nullableOptional

Message value.

Example: Request accepted for asynchronous processing.
notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested
resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045
settlementMethodstringOptional

Settlement method value.

Example: DIRECT
statusstringRequired

Current status value.

Example: CONFIRMED
supplierReferencestring · nullableOptional

Supplier reference value.

Example: SUP-BOOK-7782
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
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: gift_20260514_ba21f7
weightnumberOptional

Weight numeric value.

Example: 0
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
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
returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001
delete/gifts/{uuid}
DELETE /octo/gifts/{uuid} HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 1970

{
  "amount": 220,
  "contact": {
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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",
  "message": "Request accepted for asynchronous processing.",
  "recipient": {
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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",
  "termsAccepted": true,
  "offerCode": "SUMMER25",
  "orderId": "ord_20260514_9f3c21",
  "giftPayment": {
    "code": "SUMMER25"
  },
  "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",
  "membership": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "email": "jane.doe@goldengatetours.com",
    "mobile": "+12025550123",
    "country": "US",
    "reference": "REF-2026-001",
    "verification": "123456"
  },
  "identityId": "identity_customer_001"
}
200

Successful response

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "alias": "booking-alias-001",
  "amount": 200,
  "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": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  ],
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "message": "Request accepted for asynchronous processing.",
  "notes": "Vegetarian meal requested",
  "recipient": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  },
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "settlementMethod": "DIRECT",
  "status": "CONFIRMED",
  "supplierReference": "SUP-BOOK-7782",
  "testMode": false,
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "gift_20260514_ba21f7",
  "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"
      }
    ]
  },
  "weight": 0,
  "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,
  "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."
    }
  },
  "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",
  "offers": [
    {
      "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."
      }
    }
  ],
  "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"
  },
  "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",
  "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": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123",
      "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"
  },
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

Gift Cancellation (Alias)

post

Alias of DELETE /gifts/:uuid. Supports the same reason and force parameters.

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
reasonstringOptional

Reason for the requested action.

Example: Customer request
Responses
200

Successful response

application/json
activebooleanOptional

Whether active is enabled.

Example: true
aliasstring · nullableOptional

Alias value.

Example: booking-alias-001
amountnumber · floatOptional

Amount numeric value.

Example: 200
cancellablebooleanOptional

Whether cancellable is enabled.

Example: true
confirmablebooleanOptional

Whether confirmable is enabled.

Example: true
currencystringRequired

ISO 4217 currency code.

Example: USD
deliveryMethodsstring[]Optional

List of delivery method values.

Example: ["VOUCHER","TICKET"]
idstring · uuidOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2
messagestring · nullableOptional

Message value.

Example: Request accepted for asynchronous processing.
notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested
resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045
settlementMethodstringOptional

Settlement method value.

Example: DIRECT
statusstringRequired

Current status value.

Example: CONFIRMED
supplierReferencestring · nullableOptional

Supplier reference value.

Example: SUP-BOOK-7782
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
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: gift_20260514_ba21f7
weightnumberOptional

Weight numeric value.

Example: 0
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
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
returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

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

{
  "reason": "Customer request"
}
200

Successful response

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "alias": "booking-alias-001",
  "amount": 200,
  "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": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  ],
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "message": "Request accepted for asynchronous processing.",
  "notes": "Vegetarian meal requested",
  "recipient": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  },
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "settlementMethod": "DIRECT",
  "status": "CONFIRMED",
  "supplierReference": "SUP-BOOK-7782",
  "testMode": false,
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "gift_20260514_ba21f7",
  "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"
      }
    ]
  },
  "weight": 0,
  "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,
  "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."
    }
  },
  "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",
  "offers": [
    {
      "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."
      }
    }
  ],
  "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"
  },
  "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",
  "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": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123",
      "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"
  },
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

Note you can only cancel a gift voucher if gift.cancellable is true.

Extend Reservation

post

Extend an existing on-hold gift reservation.

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
expirationMinutesintegerOptional

Expiration minutes numeric value.

Example: 30
Responses
200

Successful response

application/json
activebooleanOptional

Whether active is enabled.

Example: true
aliasstring · nullableOptional

Alias value.

Example: booking-alias-001
amountnumber · floatOptional

Amount numeric value.

Example: 200
cancellablebooleanOptional

Whether cancellable is enabled.

Example: true
confirmablebooleanOptional

Whether confirmable is enabled.

Example: true
currencystringRequired

ISO 4217 currency code.

Example: USD
deliveryMethodsstring[]Optional

List of delivery method values.

Example: ["VOUCHER","TICKET"]
idstring · uuidOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2
messagestring · nullableOptional

Message value.

Example: Request accepted for asynchronous processing.
notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested
resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045
settlementMethodstringOptional

Settlement method value.

Example: DIRECT
statusstringRequired

Current status value.

Example: CONFIRMED
supplierReferencestring · nullableOptional

Supplier reference value.

Example: SUP-BOOK-7782
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
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: gift_20260514_ba21f7
weightnumberOptional

Weight numeric value.

Example: 0
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
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
returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

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

{
  "expirationMinutes": 30
}
200

Successful response

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "alias": "booking-alias-001",
  "amount": 200,
  "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": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  ],
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "message": "Request accepted for asynchronous processing.",
  "notes": "Vegetarian meal requested",
  "recipient": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  },
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "settlementMethod": "DIRECT",
  "status": "CONFIRMED",
  "supplierReference": "SUP-BOOK-7782",
  "testMode": false,
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "gift_20260514_ba21f7",
  "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"
      }
    ]
  },
  "weight": 0,
  "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,
  "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."
    }
  },
  "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",
  "offers": [
    {
      "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."
      }
    }
  ],
  "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"
  },
  "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",
  "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": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123",
      "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"
  },
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

Get Gift

get

This route serializes gift objects that include offer fields.

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

Successful response

application/json
activebooleanOptional

Whether active is enabled.

Example: true
aliasstring · nullableOptional

Alias value.

Example: booking-alias-001
amountnumber · floatOptional

Amount numeric value.

Example: 200
cancellablebooleanOptional

Whether cancellable is enabled.

Example: true
confirmablebooleanOptional

Whether confirmable is enabled.

Example: true
currencystringRequired

ISO 4217 currency code.

Example: USD
deliveryMethodsstring[]Optional

List of delivery method values.

Example: ["VOUCHER","TICKET"]
idstring · uuidOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2
messagestring · nullableOptional

Message value.

Example: Request accepted for asynchronous processing.
notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested
resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045
settlementMethodstringOptional

Settlement method value.

Example: DIRECT
statusstringRequired

Current status value.

Example: CONFIRMED
supplierReferencestring · nullableOptional

Supplier reference value.

Example: SUP-BOOK-7782
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
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: gift_20260514_ba21f7
weightnumberOptional

Weight numeric value.

Example: 0
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
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
returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001
get/gifts/{uuid}
GET /octo/gifts/{uuid} HTTP/1.1
Host: api.ventrata.com
Accept: */*
200

Successful response

{
  "active": true,
  "agent": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "alias": "booking-alias-001",
  "amount": 200,
  "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": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  ],
  "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
  "message": "Request accepted for asynchronous processing.",
  "notes": "Vegetarian meal requested",
  "recipient": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  },
  "reseller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "resellerReference": "RES-BOOK-10045",
  "seller": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "settlementMethod": "DIRECT",
  "status": "CONFIRMED",
  "supplierReference": "SUP-BOOK-7782",
  "testMode": false,
  "updatable": true,
  "user": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Morning City Tour",
    "reference": "REF-2026-001",
    "tags": [
      "vip",
      "partner"
    ],
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123"
  },
  "utcConfirmedAt": "2026-05-14T13:00:00Z",
  "utcCreatedAt": "2026-05-14T13:00:00Z",
  "utcExpiresAt": "2026-05-14T13:00:00Z",
  "utcRedeemedAt": "2026-05-14T13:00:00Z",
  "utcUpdatedAt": "2026-05-14T13:00:00Z",
  "uuid": "gift_20260514_ba21f7",
  "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"
      }
    ]
  },
  "weight": 0,
  "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,
  "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."
    }
  },
  "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",
  "offers": [
    {
      "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."
      }
    }
  ],
  "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"
  },
  "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",
  "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": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123",
      "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"
  },
  "identity": {
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "key": "loyalty_number"
  },
  "identityId": "identity_customer_001"
}

This endpoint will fetch the gift voucher with the provided UUID from the system.

List Gifts

get

This route serializes gift objects that include offer fields.

Query parameters
resellerReferencestringOptional

Filter by reseller reference.

Example: RES-BOOK-10045
supplierReferencestringOptional

Filter by supplier reference.

Example: SUP-BOOK-7782
utcCreatedAtStartstringOptional

UTC ISO8601 range start for created-at filter.

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

UTC ISO8601 range end for created-at filter.

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

UTC ISO8601 range start for updated-at filter.

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

UTC ISO8601 range end for updated-at filter.

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

Filter by purchaser email address.

Example: jane.doe@goldengatetours.com
Responses
200

Successful response

application/json
activebooleanOptional

Whether active is enabled.

Example: true
aliasstring · nullableOptional

Alias value.

Example: booking-alias-001
amountnumber · floatOptional

Amount numeric value.

Example: 200
cancellablebooleanOptional

Whether cancellable is enabled.

Example: true
confirmablebooleanOptional

Whether confirmable is enabled.

Example: true
currencystringRequired

ISO 4217 currency code.

Example: USD
deliveryMethodsstring[]Optional

List of delivery method values.

Example: ["VOUCHER","TICKET"]
idstring · uuidOptional

Unique identifier for this resource.

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2
messagestring · nullableOptional

Message value.

Example: Request accepted for asynchronous processing.
notesstring · nullableOptional

Notes value.

Example: Vegetarian meal requested
resellerReferencestring · nullableOptional

Reseller reference value.

Example: RES-BOOK-10045
settlementMethodstringOptional

Settlement method value.

Example: DIRECT
statusstringRequired

Current status value.

Example: CONFIRMED
supplierReferencestring · nullableOptional

Supplier reference value.

Example: SUP-BOOK-7782
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
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: gift_20260514_ba21f7
weightnumberOptional

Weight numeric value.

Example: 0
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
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
returnUrlstring · nullableOptional

From capability octo/cardPayments.

Example: https://checkout.city-sightseeing.com/return
identityIdstring · nullableOptional

From capability octo/identities.

Example: identity_customer_001
get/gifts
GET /octo/gifts HTTP/1.1
Host: api.ventrata.com
Accept: */*
200

Successful response

[
  {
    "active": true,
    "agent": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "name": "Morning City Tour",
      "reference": "REF-2026-001",
      "tags": [
        "vip",
        "partner"
      ],
      "emailAddress": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123"
    },
    "alias": "booking-alias-001",
    "amount": 200,
    "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": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123",
      "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"
    ],
    "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
    "message": "Request accepted for asynchronous processing.",
    "notes": "Vegetarian meal requested",
    "recipient": {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "tags": [
        "vip",
        "partner"
      ],
      "fullName": "Jane Doe",
      "title": "Ms",
      "firstName": "Jane",
      "lastName": "Doe",
      "emailAddress": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123",
      "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"
    },
    "reseller": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "name": "Morning City Tour",
      "reference": "REF-2026-001",
      "tags": [
        "vip",
        "partner"
      ],
      "emailAddress": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123"
    },
    "resellerReference": "RES-BOOK-10045",
    "seller": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "name": "Morning City Tour",
      "reference": "REF-2026-001",
      "tags": [
        "vip",
        "partner"
      ],
      "emailAddress": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123"
    },
    "settlementMethod": "DIRECT",
    "status": "CONFIRMED",
    "supplierReference": "SUP-BOOK-7782",
    "testMode": false,
    "updatable": true,
    "user": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "name": "Morning City Tour",
      "reference": "REF-2026-001",
      "tags": [
        "vip",
        "partner"
      ],
      "emailAddress": "jane.doe@goldengatetours.com",
      "phoneNumber": "+12025550123"
    },
    "utcConfirmedAt": "2026-05-14T13:00:00Z",
    "utcCreatedAt": "2026-05-14T13:00:00Z",
    "utcExpiresAt": "2026-05-14T13:00:00Z",
    "utcRedeemedAt": "2026-05-14T13:00:00Z",
    "utcUpdatedAt": "2026-05-14T13:00:00Z",
    "uuid": "gift_20260514_ba21f7",
    "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"
        }
      ]
    },
    "weight": 0,
    "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,
    "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."
      }
    },
    "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",
    "offers": [
      {
        "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."
        }
      }
    ],
    "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"
    },
    "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",
    "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": "jane.doe@goldengatetours.com",
        "phoneNumber": "+12025550123",
        "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"
    },
    "identity": {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "key": "loyalty_number"
    },
    "identityId": "identity_customer_001"
  }
]

When using this endpoint you must include one of the following filters:

  • resellerReference

  • supplierReference

  • utcCreatedAtStart and utcCreatedAtEnd

  • utcUpdatedAtStart and utcUpdatedAtEnd

  • contactEmailAddress

If no valid filter is provided the API returns GIFTS_FIELDS_REQUIRED.

Results are paginated.

Notify Gift

post

Send gift notification email for an existing gift voucher.

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
campaignIdstringOptional

From capability octo/campaigns.

Example: campaign_spring_2026
useContactLanguagebooleanOptional

Whether use contact language is enabled.

Example: true
Responses
200

Successful response

application/json
statusstringRequired

Current status value.

Example: accepted
requestIdstringOptional

Request identifier.

Example: req_20260514_7f29b8
messagestringOptional

Message value.

Example: Request accepted for asynchronous processing.
post/gifts/{uuid}/notify
POST /octo/gifts/{uuid}/notify HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 581

{
  "contact": {
    "tags": [
      "vip",
      "partner"
    ],
    "fullName": "Jane Doe",
    "title": "Ms",
    "firstName": "Jane",
    "lastName": "Doe",
    "emailAddress": "jane.doe@goldengatetours.com",
    "phoneNumber": "+12025550123",
    "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"
  },
  "campaignId": "campaign_spring_2026",
  "useContactLanguage": true
}
200

Successful response

{
  "status": "accepted",
  "requestId": "req_20260514_7f29b8",
  "message": "Request accepted for asynchronous processing."
}

Gift voucher delivery URLs (PDF/PNG/PKPASS/Google Wallet) are returned directly in voucher.deliveryOptions.

With a confirmed gift code, redeem by adding giftPayment to booking/order/gift write requests.

giftPayment is accepted on the write flows documented in:

Request payload fields are included in the operation schema above.

If the code is valid, currency matches the order currency, and the gift card has available credit then payment is applied.

If giftPayment is present but code is omitted/blank, existing non-voided gift payment transactions on the order are voided.

Order responses include the same giftPayment object and also include gift objects under gifts[].

The gift card may have enough credit to cover the full order, in which case you can confirm immediately. Otherwise, add a card payment as well (see Card Payments).

Schema Additions (JSON)

These are additive fragments showing only fields introduced by this capability.

Booking

BookingWriteRequest

Gift

GiftCreateRequest

Order

OrderCreateRequest

OrderUpdateRequest

PreviousMulti-Booking Cart
NextOnline Check-in

Last updated