CobberX Tours & Activities API

GET `/api/suppliers/productMinDetails`

Get all the product ids and availabilities grouped by the supplier id

productStatus

If True, return supplier even if it is not in accessible inventory.

Response

GET `/api/products/{productId}`

Retrieve a product via its ID.

productId

Product.id to retrieve.

If True, return product even if it is not in accessible inventory.

includeDisabled

Response

GET `/api/serverInfo/buildTime`

Get the application build time.

Response

POST `/api/login`

Login from a secure backend server using your secret API login credentials and a unique identifier of a client/cusomer in your application to generate a JSON Web Token that can be used to secure subsequent requests directly from a browser-based client frontend.

Request Body

Response

GET `/api/bookings`

Retrieve bookings via one of the following references: id, livnReference, clientReference, supplierReference, partyName, or partyEmailAddress. Plus optionally, date the booking was confirmed and date of travel.

anyReference

Booking reference to retrieve. Could be any of the id, livnReference, etc.

Booking.id to retrieve.

clientId

Booking.clientId to limit results to. Note: this parameter can only be used when the clientId isn't explicitly locked in by a JWT authentication token, e.g. in conjunction with Basic HTTP authentication.

supplierIds

Comma separated list of Booking.flow.supplierId values to narrow down on.

productIds

Comma-separated list of Booking.flow.productId values to narrow down on.

livnReference

Booking.livnReference to retrieve.

clientReference

Booking.clientReference to retrieve.

supplierReference

Booking.supplierReference to retrieve.

partyName

Booking.partyName to retrieve.

partyEmailAddress

Booking.partyEmailAddress to retrieve.

confirmedFrom

If specified, limit search results to bookings confirmed on or after this date. Can be used in combination with confirmedTo. Format yyyy-MM-dd

confirmedTo

If specified, limit search results to bookings confirmed on or before this date. Can be used in combination with confirmedFrom. Format yyyy-MM-dd

travelFrom

If specified, limit search results to bookings with travel dates falling on or after this date. Can be used in combination with travelTo. Format yyyy-MM-dd

travelTo

If specified, limit search results to bookings with travel dates falling on or before this date. Can be used in combination with travelFrom. Format yyyy-MM-dd

order

Specify the sort order of the returned results.

Reverse the default ascending order direction.

orderDescending

resultsPerPage

The number of results on each page of the requested search.

currentPage

The current page to view from the requested search.

Include the Booking.channel. This option only makes sense for Hybrid API clients that trade both as a Livn Direct Connect Distributor as well as purchase product from Livn Wholesale and thus operate through multiple Channels.

includeChannel

Include the Booking.distributor. This option only makes sense for Hybrid API clients that trade both as a Livn Direct Connect Distributor as well as purchase product from Livn Wholesale and thus deal with multiple Distributors.

includeDistributor

Response

GET `/api/products/{productId}/departures`

Retrieves cached departures information for a specific product ID.

productId

Product.id to retrieve.

startDate

Start date of cached departures to retrieve.

endDate

End date of cached departures to retrieve.

If True, return product departures even if product is not in accessible inventory.

includeDisabled

Response

GET `/api/tickets/pdf/{ticketId}`

Generate the ticket voucher in PDF format

ticketId

Ticket.id of the ticket.

sellerInfo

Overrides the seller information printed on the voucher (if any, top right corner). Use %0D%0A (Windows CRLF) or %0A (Unix LF) for line breaks.

Response

GET `/api/products/categories`

Retrieves the list of all product categories.

Response

GET `/api/permissions`

Lists the permissions of the authenticating API user.

Response

GET `/api/suppliers/{supplierId}`

Retrieve a supplier via its ID.

supplierId

Supplier.id to retrieve.

If True, return supplier even if it is not in accessible inventory.

includeDisabled

Response

GET `/api/flows/{flowId}`

Retrieve a checkout flow via its ID.

flowId

Flow.id to retrieve.

If true, the response will contain all steps. If false, the response will contain only the current/active step.

includeAllSteps

Response

DELETE `/api/bookings/{bookingId}`

Request to cancel a confirmed booking.

bookingId

Booking.id to be cancelled.

reason

Reason for cancellation.

Response

POST `/api/logout`

Logout and invalidate the JSON Web Token used to authenticate this call without waiting for it to expire.

Response

GET `/api/products/{productId}/fareCache`

Note: This endpoint is in open preview to gather feedback from our customers. We recommend that you please do not include this in your implementation until it is officially released for general availability as details of the model and functionality might yet change. Retrieves all recently observed and cached BaseVariants, TimeSlots, Fares and AddOns available for the product via its ID in a single "flat" ProductFareCache record. Please note that the coverage of occurrences, i.e. dates on which these items have been observed, is not necessarily complete.

productId

Product.id to retrieve data for.

If True, return data even if Product is not in a bookable state.

includeDisabled

Response

GET `/api/products/{productId}/fareDetailsFromCache/{date}`

Note: This endpoint is in open preview to gather feedback from our customers. We recommend that you please do not include this in your implementation until it is officially released for general availability as details of the model and functionality might yet change. Retrieves a set of currency-specific hierarchically structured FareDetails objects similar to what you would expect in a checkout Flow in the FARE_SELECTION milestone Step, but reconstructed from ProductFareCache data where it is available for the specified product and date. If the data for the requested product and date has not been scraped and cached or is considered stale this endpoint will return a code 404 Not Found.

productId

Product.id to retrieve data for.

date

Local date to retrieve data for.

Response

POST `/api/suppliers/search`

Retrieves the list of suppliers.

Request Body

Response

POST `/api/flows`

Start a new or proceed to the next step of an unfinished checkout flow.

True if user wants to go back to a previous step to change some selections or answers.

back

If true, the response will contain all steps. If false, the response will contain only the current/active step.

includeAllSteps

Request Body

Response

GET `/api/serverInfo/serverTime`

Get the current server time.

Response

GET `/api/bookings/pdf/{bookingId}`

Generate the booking voucher in PDF format

bookingId

Booking.id of the booking.

sellerInfo

Overrides the seller information printed on the voucher (if any, top right corner). Use %0D%0A (Windows CRLF) or %0A (Unix LF) for line breaks.

Response

GET `/api/exchangeRates`

Retrieves the map of current exchange rates for all known product currencies.

Response

GET `/api/tickets`

Retrieve tickets via one of the following references: id, supplierReference, passengerName.

anyReference

Ticket reference to retrieve. Could be the id, supplierReference, or passenger name.

Ticket.id to retrieve.

supplierReference

Ticket.supplierReference to retrieve.

bookingSupplierReference

Booking.supplierReference to retrieve.

passengerName

Any passenger name associated with the ticket to retrieve.

order

Specify the sort order of the returned results.

Reverse the default ascending order direction.

orderDescending

resultsPerPage

The number of results on each page of the requested search.

currentPage

The current page to view from the requested search.

Response

GET `/api/suppliers/search/{searchId}`

Retrieves suppliers based on search id.

searchId

The unique identifier (UUID) initially assigned to the supplier search.

resultsPerPage

The number of results on each page of the requested search.

currentPage

The current page to view from the requested search.

Response

GET `/api/products/operatingDates`

Retrieves product operating dates for all products in the user's accessible inventory as a single data dump using CSV formatting.

Set to true to include data for disabled products.

includeDisabled

Set to false to disable gzip compression which we use by default to reduce the payload volume.

gzipResponse

Response

GET `/api/suppliers`

Retrieves list of suppliers with minimal details.

If True, include suppliers not in accessible inventory.

includeDisabled

Response

POST `/api/products/search`

Initiates a new product search and returns the first page of results. Results can subsequently be retrieved via the getSearchResults call.

Request Body

Response

GET `/api/products/search/{searchId}`

Retrieves a page of products from an existing product search.

searchId

The unique identifier (UUID) initially assigned to the product search.

resultsPerPage

The number of results on each page of the requested search.

currentPage

The current page to view from the requested search.

Response

POST `/api/flows/previewPrice`

Request a price preview for an active checkout flow with a specific product selection without proceeding to the next step.

Request Body

Response

POST `/api/products/cities`

Get product cities that appear as a product search reference start location, i.e. Product.locationsStart.

Request Body

Response