Endpoints & Capabilities
OCTO defines a number of Core Endpoints that are applicable to most use cases and are required for the implementation.
Since not all use cases can be fulfilled with just the core endpoints, OCTO provides a concept of Capabilities, allowing for enhancement to the integrations based on specific needs. Capabilities are optional for implementation and to enhance integration by, for example, adding additional information about pricing, content, pickups, etc.
OCTO API Core Endpoints
Name | Method | Description |
---|---|---|
| Returns a single Supplier and associated details for a given Supplier ID. |
Get Products |
| Returns a list of Products and associated details. |
Get Product |
| Returns a single Product and associated details for a given Product ID. |
Availablity Calendar |
| Returns availability for a given Product & Option as a single object per day. Optimized to be queried for large date ranges and to populate an availability calendar. |
Availability Check |
| Returns availability for a given Product & Option as a single object per start time (or day). You have to perform this step to retrieve an |
Booking Reservation |
| Creates a booking that reserves the availability (e.g. while you collect payment and contact information from the customer) for a given |
Booking Confirmation |
| Confirms previously placed Booking Reservation, finalizing the booking and making it ready to be used. |
Booking Update |
| Updates/changes your booking before and after it has been confirmed as long as it hasn't yet been redeemed or within the cancellation cutoff window. |
Booking Cancellation |
| Cancels your booking. You can only cancel a booking if |
Extend Reservation |
| Extends the Booking Reservation availability hold if the booking status is |
Get Booking |
| Returns the status and details of your existing booking. |
Get Bookings |
| Returns the list of the bookings you made for the given filters. |
Capabilities
Note the Capabilities listed on this page are NOT yet part of the official OCTO Specification and are provided for reference only.
Name | ID | Description |
---|---|---|
| ||
| ||
| ||
|
You control which capabilities you want to enable by using the Octo-Capabilities
header. For example:
It's also possible to use the _capabilities
query parameter if you're unable to use headers:
You can list all the capabilities with a comma to separate each one.
Last updated