Resources

Adds the ability to see and edit resource allocations

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

Resources are allocated to each booking and determine availability for resource-based products (for example vehicles, rooms, or seat maps).

Even for products that rely on resources, this capability is optional. If you do not provide resource selections, allocations are assigned automatically.

Operations below use the /octo prefix.

Check Available Resources

get

Retrieve available resources for a specific availability.

Responses

200

Successful response

application/json

From capability octo/resources.

resourceIdstringRequired

Resource identifier.

Example: res_bus_12

namestringOptional

Name value.

Example: Coach 12

remainingintegerOptional

Remaining numeric value.

Example: 24

totalintegerOptional

Total numeric value.

Example: 30

statusstringRequired

Current status value.

Example: AVAILABLE

startstringOptional

Start value.

Example: 2026-03-01T08:30:00-08:00

endstringOptional

End value.

Example: 2026-03-01T12:30:00-08:00

resourceGroupIdstringOptional

Resource group identifier.

Example: resource_group_front_row

get

/availability/resources

HTTPcURLJavaScriptPython

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

200

Successful response

[
  {
    "resourceId": "res_bus_12",
    "name": "Coach 12",
    "remaining": 24,
    "total": 30,
    "status": "AVAILABLE",
    "start": "2026-03-01T08:30:00-08:00",
    "end": "2026-03-01T12:30:00-08:00",
    "resourceGroupId": "resource_group_front_row",
    "resourceGroup": {
      "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
      "title": "Summer Promotion",
      "split": true,
      "required": true
    },
    "resources": [
      {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "title": "Summer Promotion",
        "capacity": 2,
        "seating": true,
        "seats": [
          {
            "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
            "row": "A",
            "column": "4",
            "status": "CONFIRMED"
          }
        ]
      }
    ],
    "availableSeats": [
      {
        "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
        "row": "A",
        "column": "4",
        "status": "CONFIRMED"
      }
    ],
    "selectedSeats": [
      {
        "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
        "row": "A",
        "column": "4",
        "status": "CONFIRMED"
      }
    ],
    "seller": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "name": "Morning City Tour",
      "reference": "REF-2026-001",
      "tags": [
        "vip",
        "partner"
      ],
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]"
    }
  }
]

Check Available Resources

post

Retrieve available resources for a specific availability.

Body

application/json

From capability octo/resources.

availabilityIdstringOptional

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

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

dropoffPointIdstringOptional

From capability octo/pickups.

Example: dropoff_fishermans_wharf

pickupPointIdstringOptional

From capability octo/pickups.

Example: pickup_union_square

Responses

200

Successful response

application/json

From capability octo/resources.

resourceIdstringRequired

Resource identifier.

Example: res_bus_12

namestringOptional

Name value.

Example: Coach 12

remainingintegerOptional

Remaining numeric value.

Example: 24

totalintegerOptional

Total numeric value.

Example: 30

statusstringRequired

Current status value.

Example: AVAILABLE

startstringOptional

Start value.

Example: 2026-03-01T08:30:00-08:00

endstringOptional

End value.

Example: 2026-03-01T12:30:00-08:00

resourceGroupIdstringOptional

Resource group identifier.

Example: resource_group_front_row

post

/availability/resources

HTTPcURLJavaScriptPython

POST /octo/availability/resources HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 637

{
  "availabilityId": "2026-05-14T09:00:00-04:00",
  "units": [
    {
      "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
      "quantity": 2,
      "weightValue": 20,
      "weightUnit": "kg"
    }
  ],
  "dropoffPointId": "dropoff_fishermans_wharf",
  "pickupPointId": "pickup_union_square",
  "resourceAllocations": [
    {
      "resourceGroupId": "resource_group_front_row",
      "resourceGroup": {
        "title": "Summer Promotion",
        "split": true,
        "required": true
      },
      "resourceId": "resource_coach_12",
      "resource": {
        "title": "Summer Promotion",
        "capacity": 2,
        "seating": true,
        "seats": [
          {
            "row": "A",
            "column": "4",
            "status": "CONFIRMED"
          }
        ]
      },
      "seatIds": [
        "seat_one",
        "seat_two"
      ],
      "seats": [
        {
          "row": "A",
          "column": "4",
          "status": "CONFIRMED"
        }
      ],
      "paxCount": 2
    }
  ]
}

200

Successful response

[
  {
    "resourceId": "res_bus_12",
    "name": "Coach 12",
    "remaining": 24,
    "total": 30,
    "status": "AVAILABLE",
    "start": "2026-03-01T08:30:00-08:00",
    "end": "2026-03-01T12:30:00-08:00",
    "resourceGroupId": "resource_group_front_row",
    "resourceGroup": {
      "id": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
      "title": "Summer Promotion",
      "split": true,
      "required": true
    },
    "resources": [
      {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "title": "Summer Promotion",
        "capacity": 2,
        "seating": true,
        "seats": [
          {
            "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
            "row": "A",
            "column": "4",
            "status": "CONFIRMED"
          }
        ]
      }
    ],
    "availableSeats": [
      {
        "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
        "row": "A",
        "column": "4",
        "status": "CONFIRMED"
      }
    ],
    "selectedSeats": [
      {
        "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
        "row": "A",
        "column": "4",
        "status": "CONFIRMED"
      }
    ],
    "seller": {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "name": "Morning City Tour",
      "reference": "REF-2026-001",
      "tags": [
        "vip",
        "partner"
      ],
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]"
    }
  }
]

Returns resources grouped by resourceGroupId for a single availabilityId.

Request Fields

For GET, send these as query parameters. For POST, send them in the JSON body.

Response Fields

Response is an array of resource-group objects.

Seat Object

Used in resource.seats[], availableSeats[], selectedSeats[], and booking allocation seats[].

Seller Object (driver/guide)

See the resource operations above for response payload examples.

Each booking must allocate enough resources from every required resource group. When resourceGroup.split is false, one resource in that group must cover the full requested size.

Booking Reservation / Update

Resource allocations are accepted on all booking write routes that call booking create/update logic:

• POST /bookings

• PATCH /bookings/{uuid}

• POST /bookings/{uuid}/confirm

Request resourceAllocations[].paxCount and resourceAllocations[].seatIds are ignored by current booking write parsing. Pax and seat assignment are computed server-side from allocation/unit data.

When resourceAllocations is present and non-empty, allocations not included in the submitted list are removed from the booking. Sending resourceAllocations: [] is currently a no-op (existing allocations remain unchanged).

resourceAllocations is appended to serialized booking objects on:

• POST /bookings

• PATCH /bookings/{uuid}

• POST /bookings/{uuid}/confirm

• GET /bookings/{uuid}

• GET /bookings

• POST /bookings/{uuid}/cancel

• POST /bookings/{uuid}/extend

The same booking-response additions are also present in any other response that serializes a booking object.

Base booking schema: Bookings.

Added Availability Field

This capability also adds hasResources to serialized availability objects returned by:

• POST /availability

• POST /availability/batch

• booking.availability inside serialized booking responses

Base availability schema: Availability.

hasResources is added to /availability responses, not /availability/calendar responses.

Schema Additions (JSON)

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

Availability

{
  "// ...rest of availability object": "...",
  "hasResources": true
}

AvailabilityBatchRow

{
  "// ...rest of availability batch row object": "...",
  "hasResources": true
}

AvailabilityResourcesRequest

{
  "// ...rest of availability resources request object": "...",
  "resourceAllocations": [
    {
      "resourceId": "resource_coach_12"
    }
  ]
}

Booking

{
  "// ...rest of booking object": "...",
  "resourceAllocations": [
    {
      "resourceGroupId": "resource_group_front_row",
      "resourceGroup": {
        "title": "Front Row"
      },
      "resourceId": "resource_coach_12",
      "resource": {
        "title": "Coach 12"
      },
      "seatIds": [
        "seat_one",
        "seat_two"
      ],
      "seats": [
        {
          "row": "A",
          "column": "4"
        }
      ],
      "paxCount": 2
    }
  ]
}

BookingWriteRequest

{
  "// ...rest of booking write request object": "...",
  "resourceAllocations": [
    {
      "resourceId": "resource_coach_12"
    }
  ]
}

PackageAvailability

{
  "// ...rest of package availability object": "...",
  "hasResources": true
}