> ## Documentation Index
> Fetch the complete documentation index at: https://voyant.travel/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get ship

> Get details for a ship.



## OpenAPI

````yaml /api-specs/platform-storefront.json get /v1/public/cruises/ships/{key}
openapi: 3.1.0
info:
  title: Voyant Storefront API
  version: 1.0.0
  description: >-
    The customer-facing /v1/public/* REST API exposed by the framework modules
    in your deployed Voyant app. Most routes are public or session-scoped. The
    server URL is your own app domain.
servers:
  - url: https://{operatorDomain}
    variables:
      operatorDomain:
        default: app.example.com
        description: The domain of your deployed Voyant operator app.
security: []
tags:
  - name: Accommodations
    description: >-
      Customer-facing accommodation content detail. Mounted at
      /v1/public/accommodations.
  - name: Booking requirements
    description: Public product transport-requirement discovery.
  - name: Bookings
    description: Public guest checkout sessions and booking overview/lookup.
  - name: Catalog
    description: >-
      Storefront catalog search and the customer booking journey (quote, book,
      drafts, holds), mounted at /v1/public/catalog.
  - name: Charters
    description: >-
      Customer-facing charter catalog reads and voyage quotes. Mounted at
      /v1/public/charters.
  - name: Cruises
    description: >-
      Customer-facing cruise catalog reads and sailing quotes. Mounted at
      /v1/public/cruises.
  - name: Customer portal
    description: >-
      Customer-facing payment journey: payment sessions, payment options,
      vouchers, schedule/guarantee/invoice payment-session starts, and the
      revocable accountant portal.
  - name: Departures
    description: >-
      Customer-facing departures: list per product, detail, pricing preview, and
      transport eligibility, mounted at /v1/public/departures and
      /v1/public/products/{productId}/departures.
  - name: Finance
    description: >-
      Public finance reads and document lookups used during the
      checkout/customer journey (mounted at /v1/public/finance).
  - name: Legal
    description: >-
      Public-facing legal reads and customer signature/acceptance flows for
      contracts, policies, and terms (mounted at /v1/public/legal).
  - name: Offers
    description: >-
      Customer-facing promotional offers: product offers, offer-by-slug, apply,
      and redeem, mounted at /v1/public/offers and
      /v1/public/products/{productId}/offers.
  - name: Operator profile
    description: >-
      Customer-facing operator profile/settings plus storefront CRM intake:
      leads and newsletter subscription. Mounted under /v1/public.
  - name: Products
    description: >-
      Customer-facing product catalog: products, categories, tags, destinations,
      detail by slug/id, and brochures, mounted at /v1/public/products.
  - name: Quotes
    description: >-
      Public proposal surface: view, accept and decline a sent quote version.
      Mounted at /v1/public/proposals.
  - name: Settings
    description: Public operator settings read surface. Mounted under /v1/public.
  - name: Storefront
    description: >-
      Customer-facing storefront catalog reads, departure pricing,
      booking-session bootstrap, offers and eligibility. Mounted under
      /v1/public (storefront uses publicPath "/").
  - name: Trips
    description: >-
      Public trip composition, pricing, reservation and checkout (mutating
      component edits are forbidden on the public surface).
paths:
  /v1/public/cruises/ships/{key}:
    get:
      tags:
        - Cruises
      summary: Get ship
      description: Get details for a ship.
      operationId: publicGetCruiseShip
      parameters:
        - name: key
          in: path
          required: true
          schema:
            type: string
          example: crsh_01h...
      responses:
        '200':
          description: Ship detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CruisesPublicShip'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl --request GET \
              --url https://app.example.com/v1/public/cruises/ships/<key>
        - lang: javascript
          label: Node
          source: >-
            const response = await
            fetch("https://app.example.com/v1/public/cruises/ships/<key>", {
              method: "GET",
            });


            const data = await response.json();
        - lang: python
          label: Python
          source: |-
            import requests

            response = requests.get(
                "https://app.example.com/v1/public/cruises/ships/<key>"
            )

            data = response.json()
components:
  schemas:
    CruisesPublicShip:
      type: object
      properties:
        key:
          type: string
          example: crsh_01h...
        name:
          type: string
        decks:
          type: array
          items:
            type: object
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
        code:
          type: string
          description: >-
            Stable, machine-readable error code (e.g. invalid_request,
            unauthorized, forbidden). Absent for unmapped 500s.
        requestId:
          type: string
          description: >-
            Correlation id for this request. Also returned in the X-Request-Id
            response header.
        details:
          type: object
          additionalProperties: true
          description: >-
            Optional structured context. Validation errors (400) include
            `issues` and `fields` from the failed schema.
  responses:
    BadRequest:
      description: >-
        The request was malformed or failed schema validation (`code:
        invalid_request`).
      headers:
        X-Request-Id:
          description: >-
            Correlation id for this request, echoed on every response including
            errors.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: The requested resource does not exist.
      headers:
        X-Request-Id:
          description: >-
            Correlation id for this request, echoed on every response including
            errors.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ServerError:
      description: >-
        An unexpected error occurred. The `X-Request-Id` header identifies the
        failed request.
      headers:
        X-Request-Id:
          description: >-
            Correlation id for this request, echoed on every response including
            errors.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'

````