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

# Fetch a quote request

> Preview: Fetches one quote request by its customer-facing id.



## OpenAPI

````yaml /openapi.json get /v1/quote-requests/{id}
openapi: 3.1.0
info:
  title: OVRSEA API
  version: 1.3.2
servers:
  - url: https://api.cf.ovrsea.com
security: []
paths:
  /v1/quote-requests/{id}:
    get:
      tags:
        - Quote requests
      summary: Fetch a quote request
      description: 'Preview: Fetches one quote request by its customer-facing id.'
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
          description: 'Preview: Customer-facing id of the quote request.'
      responses:
        '200':
          description: 'Preview: The quote request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuoteRequest'
        '400':
          description: 'Preview: The request is malformed. The code is `invalid_request`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            Preview: The quote request is absent or not visible to the caller.
            The code is `quote_request_not_found`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    QuoteRequest:
      type: object
      modelName: QuoteRequest
      description: 'Preview: Quote request visible to the customer.'
      properties:
        id:
          description: >-
            Preview: Customer-facing REST reference of the quote request, using
            the same historical or full form as the shipment resource.
          type: string
        name:
          description: 'Preview: Customer dossier name.'
          type: string
        status:
          description: >-
            Preview: Quote-request lifecycle status, with one public value for
            each platform status.

            `draft`: the request is being prepared. Leaving draft or cancelling
            the request changes this value.

            `awaiting_quote`: the request has no customer-visible quote yet. A
            sent quote, acceptance or cancellation changes this value.

            `quote_sent`: at least one customer-visible quote was sent.
            Acceptance or cancellation changes this value; for a request that
            remains open, further quotes keep it, while all visible quotes being
            declined or expiring can change it.

            `accepted`: a quote was accepted or the request became a shipment.
            Cancelling that shipment changes this value to `cancelled`.

            `declined`: every customer-visible quote was declined. A newly sent
            customer-visible quote changes this value to `quote_sent`, and
            cancellation changes it to `cancelled`.

            `expired`: every customer-visible quote expired. A newly sent
            customer-visible quote changes this value to `quote_sent`, and
            cancellation changes it to `cancelled`.

            `cancelled`: the request was cancelled. Clearing its cancellation
            lets the platform recalculate the request or shipment status.

            Further values may be added. Clients should handle an unknown value
            as an unrecognized status.
          enum:
            - accepted
            - awaiting_quote
            - cancelled
            - declined
            - draft
            - expired
            - quote_sent
          type: string
        service:
          description: 'Preview: Service requested for the quote.'
          enum:
            - chartering
            - courier
          type:
            - string
            - 'null'
        freight_mode:
          description: 'Preview: Freight mode requested for the quote.'
          enum:
            - air
            - ocean
            - rail
            - truck
          type: string
        load_type:
          description: 'Preview: Load type requested for the quote.'
          enum:
            - fcl
            - lcl
          type: string
        incoterm:
          description: 'Preview: Incoterm requested for the quote.'
          enum:
            - exw
            - fca
            - fas
            - fob
            - cpt
            - cfr
            - cif
            - cip
            - dap
            - ddp
            - dpu
            - dat
          type: string
        cargo_ready_date:
          description: 'Preview: Date when the cargo is ready for collection.'
          format: date
          type: string
        desired_delivery_date:
          description: 'Preview: Desired delivery date.'
          format: date
          type:
            - string
            - 'null'
        route:
          description: 'Preview: Route requested for the quote.'
          type: object
          properties:
            pickup_location_id:
              description: 'Preview: Pickup location id.'
              type: string
            origin_port_id:
              description: 'Preview: Origin port id.'
              type: string
            destination_port_id:
              description: 'Preview: Destination port id.'
              type: string
            delivery_location_id:
              description: 'Preview: Delivery location id.'
              type: string
        cargo:
          description: 'Preview: Cargo requested for the quote.'
          type: object
          properties:
            total_weight:
              $ref: '#/components/schemas/Weight'
            total_volume:
              $ref: '#/components/schemas/Volume'
            containers:
              description: 'Preview: Containers requested for the quote.'
              items:
                $ref: '#/components/schemas/QuoteRequestContainer'
              type: array
            loads:
              description: 'Preview: Package lines requested for the quote.'
              type: array
              items:
                $ref: '#/components/schemas/QuoteRequestLoad'
        goods_description:
          description: 'Preview: Description of the goods being transported.'
          type: string
        specific_instructions:
          description: 'Preview: Instructions for the transport.'
          type: string
        commercial_value:
          $ref: '#/components/schemas/Price'
        insurance_type:
          description: 'Preview: Insurance selected for the quote.'
          enum:
            - not_insured
            - ad_valorem_ordinary_risk
            - ad_valorem_war_risk
          type: string
        urgent:
          description: 'Preview: Whether the request is urgent.'
          type: boolean
    ApiError:
      modelName: ApiError
      type: object
      description: 'Preview: Error returned by a preview route.'
      properties:
        code:
          description: 'Preview: Stable code describing what went wrong.'
          type: string
        field:
          description: >-
            Preview: Request input that needs correction. For a query or path
            parameter, this is the parameter name. For one body input, this is
            its root-relative dot-separated path, with array indexes in
            brackets, such as `cargo.loads[0].count`. For a refusal concerning
            several inputs on one body object, this is that object's path. For a
            refusal concerning the request as a whole, this field is omitted.
          type: string
        message:
          description: 'Preview: One-sentence explanation and next step.'
          type: string
        retry_after_seconds:
          description: >-
            Preview: Number of seconds to wait before retrying, when the
            response is rate limited.
          type: integer
      required:
        - code
        - message
    Weight:
      modelName: Weight
      type: object
      description: Weight
      properties:
        value:
          type: number
          format: float
          example: 350.25
        unit:
          type: string
          enum:
            - kg
            - lbs
          example: kg
    Volume:
      modelName: Volume
      type: object
      description: Volume in cubic metres.
      properties:
        value:
          type: number
          format: float
          example: 10.25
        unit:
          type: string
          example: m3
    QuoteRequestContainer:
      modelName: QuoteRequestContainer
      type: object
      description: 'Preview: Container requested in a quote request.'
      properties:
        container_type:
          description: 'Preview: Container type.'
          type: string
          enum:
            - twenty_foot_standard
            - twenty_foot_reefer
            - twenty_foot_flat_rack
            - twenty_foot_open_top
            - twenty_foot_non_operating_reefer
            - forty_foot_standard
            - forty_foot_reefer
            - forty_foot_flat_rack
            - forty_foot_open_top
            - forty_foot_highcube_standard
            - forty_foot_highcube_reefer
            - forty_foot_highcube_flat_rack
            - forty_foot_highcube_open_top
            - forty_foot_non_operating_reefer
            - forty_foot_high_cube_non_operating_reefer
            - forty_five_foot_highcube_standard
        container_number:
          description: 'Preview: Container number when assigned.'
          type: string
          example: TEMU8667058
        seal_number:
          description: 'Preview: Seal number when assigned.'
          type: string
          example: 1332641
    QuoteRequestLoad:
      modelName: QuoteRequestLoad
      type: object
      description: 'Preview: Package line requested in a quote request.'
      properties:
        count:
          description: 'Preview: Number of packages in the line when known.'
          type: number
          example: 3
        type:
          description: >-
            Preview: `package` is a parcel.

            `pallet` is palletized cargo.

            `rigid_crate` is a rigid crate.

            `bulk` is unpackaged cargo.

            Further values may be added. Clients should handle an unknown value
            as an unrecognized load type.
          enum:
            - pallet
            - package
            - rigid_crate
            - bulk
          format: LoadType
          type: string
        pallet_size:
          description: >-
            Preview: `120x80` is a pallet 120 cm by 80 cm.

            `120x100` is a pallet 120 cm by 100 cm.

            `specific` is a pallet of another size whose dimensions the line
            gives.

            Further values may be added. Clients should handle an unknown value
            as an unrecognized pallet size.
          enum:
            - 120x80
            - 120x100
            - specific
          type: string
        weight:
          $ref: '#/components/schemas/Weight'
        length:
          $ref: '#/components/schemas/Size'
        width:
          $ref: '#/components/schemas/Size'
        height:
          $ref: '#/components/schemas/Size'
    Price:
      modelName: Price
      type: object
      properties:
        amount:
          type: number
          format: float
          example: 150357.99
        currency:
          type: string
          enum:
            - AED
            - AUD
            - BHD
            - BRL
            - CAD
            - CHF
            - CNY
            - DKK
            - EUR
            - GBP
            - HKD
            - IDR
            - INR
            - JPY
            - MXN
            - KRW
            - KWD
            - MYR
            - NOK
            - NZD
            - PLN
            - SEK
            - SGD
            - THB
            - TND
            - TWD
            - USD
            - XOF
            - XPF
            - ZAR
          example: USD
    Size:
      type: object
      modelName: Size
      description: Size
      properties:
        value:
          type: number
          format: float
          example: 10.25
        unit:
          type: string
          enum:
            - cm
            - in
          example: cm

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.