Ventrata

https://support.ventrata.com/en
Admin
Ventrata is a comprehensive platform for managing experiences and attractions, offering web checkout...
Tokens:307,366
Snippets:5,557
Trust Score:9.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Complete Order Response Example

Source: https://support.ventrata.com/en/articles/16053128-external-implementation-validate-order-before-payment-via-api-function

Example response when no completion issues are found.

```json
{
 valid: true, 
 issues: []
}
```

--------------------------------

### Marketing URL Example

Source: https://support.ventrata.com/en/articles/12033395-how-to-open-the-checkout-widget-automatically-from-marketing-links

A basic example of a URL structure used to trigger the widget.

```text
https://example.com/page?openWidget=true'
```

--------------------------------

### Configure viewModeMap for Upgrade

Source: https://support.ventrata.com/en/articles/9673860-how-to-switch-from-embedded-to-pop-up-mode

Enables pop-up mode starting from the upgrade page.

```json
"features": {
  "viewModeMap": {
     "upgrade": "popup"
   }
}
```

--------------------------------

### Configure viewModeMap for Questions

Source: https://support.ventrata.com/en/articles/9673860-how-to-switch-from-embedded-to-pop-up-mode

Enables pop-up mode starting from the questions page.

```json
"features": {
  "viewModeMap": {
     "questions": "popup"
   }
}
```

--------------------------------

### Multiple Issues Response Example

Source: https://support.ventrata.com/en/articles/16053128-external-implementation-validate-order-before-payment-via-api-function

Example response when multiple completion issues are returned simultaneously.

```json
{
 valid: false,
 issues: [
  {
    step: "booking-questions",
    bookingUuid: "booking-uuid-123",
    reason: 'Required booking question "question-id-123" is missing.'
  },
  {
    step: "contact-details",
    bookingUuid: "booking-uuid-123",
    reason: 'Required unit contact field "phoneNumber" is missing.'
  },
  {
    step: "order-questions",
    reason: 'Required order question "question-id-456" is missing.'
  }
 ]
}
```

--------------------------------

### Incomplete Order Response Example

Source: https://support.ventrata.com/en/articles/16053128-external-implementation-validate-order-before-payment-via-api-function

Example response when a single completion issue is identified.

```json
{
 valid: false,
 issues: [
  {
    step: "booking-questions",
    bookingUuid: "booking-uuid-123",
    reason: 'Required booking question "question-id-123" is missing.'
  }
 ]
}
```

--------------------------------

### Example DNS verification output

Source: https://support.ventrata.com/en/articles/14120455-how-to-resolve-a-certificate-error-on-your-custom-domain

Expected output format when the domain is correctly pointed to Ventrata infrastructure.

```text
[your custom domain name].com is an alias for cname.ventrata.com.
cname.ventrata.com is an alias for alb-origin.ventrata.com.
alb-origin.ventrata.com has address 34.36.123.39
```

--------------------------------

### Configure viewModeMap for Pickups

Source: https://support.ventrata.com/en/articles/9673860-how-to-switch-from-embedded-to-pop-up-mode

Enables pop-up mode starting from the pickups page.

```json
"features": {
  "viewModeMap": {
     "pickups": "popup"
   }
}
```

--------------------------------

### Occupancy Rule Ordering Example

Source: https://support.ventrata.com/en/articles/11410452-how-to-re-arrange-fares

Comparison of correct and incorrect ordering for occupancy-based fare rules to ensure optimal performance.

```text
       ✅      Price    |         ❌        Price  
1.   >= 75%    $90      |       <= 50%      $70  
2.   >= 50%    $80      |       <= 76%      $80                                       
3.   >= 0%     $70      |       <= 100%     $90
```

--------------------------------

### Checkout Started Event

Source: https://support.ventrata.com/en/articles/9714743-events-sent-to-twilio-segment

The Checkout Started event is triggered when a customer begins the checkout process. It includes specific product and transaction properties.

```APIDOC
## Checkout Started Event

### Description
Triggered when an end customer begins the checkout process by transitioning from browsing to the final steps of purchasing.

### Properties
- **name** (string) - Product name
- **product_id** (string) - Unique product and option identifier
- **variant** (string) - Option name
- **currency** (string) - Currency of the items associated with the event
- **value** (string) - Monetary value of the event (tax excluded)
- **tax** (string) - Tax cost associated with a transaction
- **order_id** (string) - Unique order identifier
```

--------------------------------

### Reseller JSON payload example

Source: https://support.ventrata.com/en/articles/13193475-how-to-use-the-reseller-agent-management-api

A sample JSON structure for creating or updating a reseller agent.

```json
{
  "active": true,
  "testMode": false,
  "name": "Viator",
  "reference": "VIA",
  "tags": ["OTA"],
  "referrers":["via:agentCode"],

  "creditLimit": 1000000,
  "defaultCurrency": "USD",
  "availableCurrencies": ["USD", "GBP", "EUR"],
  "settlementMethods": ["VOUCHER"],

  "billingCompany": "Viator Inc",
  "billingCompanyNumber": "GB123456789",
  "billingStreetAddress": "123 Example Street",
  "billingCity": "London",
  "billingPostalCode": "EC1A 1AA",
  "billingCountry": "GB",

  "billingContact": {
    "fullName": "Accounts Payable",
    "emailAddress": "ap@viator.example",
    "phoneNumber": "+44 20 0000 0000",

  "destinationId": "d6afc8f5-a762-48d3-9a29-010c74d6751a"
  }
}
```

--------------------------------

### Configure viewModeMap for Cross-sell

Source: https://support.ventrata.com/en/articles/9673860-how-to-switch-from-embedded-to-pop-up-mode

Enables pop-up mode starting from the cross-sell page.

```json
"features": {
  "viewModeMap": {
     "cross-sell": "popup"
   }
}
```

--------------------------------

### Track begin_checkout event

Source: https://support.ventrata.com/en/articles/9550944-tracking-manual

Use this dataLayer push to record the start of a checkout process. Ensure the ecommerce object is cleared before pushing new data.

```javascript
dataLayer.push({ ecommerce: null }); // Clear the previous ecommerce object.
dataLayer.push({
  "event": "begin_checkout",
  "ecommerce": {
       "order_id": "17def567-005d-43be-ad81-6a904325b17c",
       "coupons": [],
       "currency": "EUR",
       "checkout_mode": "popup",
       "items": [
       {
       "item_id": "unit_38d8b24e-89a9-488c-9f51-6981dc56a581",
       "booking_id": "2a37bb6d-a62a-4d73-b147-3155bfad1d0f",
       "product_id": "69f07800-0b30-4824-b462-09a7f195295b",
       "item_name": "Chitwan National Park",
       "option_id": "DEFAULT",
       "item_variant": "Chitwan National Park",
       "item_category": "6 seater car",
       "item_category2": "2024-09-18",
       "item_category3": "14:30:00",
       "item_category4": "",
       "crossSell": false,
       "multidate": false,
       "price": 400,
       "tax": 0,
       "discount": 0,
       "quantity": 1,
       "extras": [],
       "packages": []
       }
       ],
       "quantity": 1,
       "extras": [],
       "value": 400,
       "tax": 0,
       "discount": 0
  },
  "custom_timestamp": "1759833980195",
  "preferred_locale": "en",
  "gtm.uniqueEventId": 86
})
```

--------------------------------

### Install Fingerprint Agent

Source: https://support.ventrata.com/en/articles/10110300-fingerprint-and-google-recaptcha

Install the required NPM package for Fingerprint v4.

```bash
npm install @fingerprint/agent
```
Tokens:
Raw