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

# Search vehicle pick-up places

> Searches pick-up and drop-off places for a vehicle search.

Use it to fill the pick-up and drop-off pickers before you create a vehicle search, then send the place's `id` — or its `slug` — as `pickUpLocation` or `dropOffLocation`. Matches come most relevant first, and an empty `results` means nothing matched. An error the travel provider reports about the request is returned with its own status, `code` and `message`.


## OpenAPI

````yaml /api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/locations
openapi: 3.0.3
info:
  title: Travel
  version: 1.0.0
  description: >-
    Portão 3 travel API. Every endpoint requires a bearer token in the
    Authorization header (Authorization: Bearer <token>) unless its page states
    otherwise; see the Authentication guide. That requirement is not repeated
    per endpoint. Generated by tools/openapi from code (routes + security) and
    the hand-written spec (request/response bodies). Passenger directory, trips
    and the search proxy (air/hotel/bus/vehicle). Every route validates path,
    query and body through a zod Input class (`travel/src/domain/*/input`),
    which documents its parameters and body; responses are the named interfaces
    in `travel/src/domain/*/response.ts`. Confidence tiers: generated:typed=53
    copied:manual=0 unknown=0.
servers:
  - url: https://api.travel.v2.portao3.com.br/
    description: production
  - url: https://api.travel.dev.3pers.com.br/
    description: development
security: []
tags:
  - name: Passengers
  - name: Trips
  - name: Air search
  - name: Hotel search
  - name: Bus search
  - name: Vehicle search
paths:
  /realms/{realmId}/organizations/{organizationId}/vehicle/locations:
    get:
      tags:
        - Vehicle search
      summary: Search vehicle pick-up places
      description: Searches pick-up and drop-off places for a vehicle search.
      operationId: getRealmsByRealmIdOrganizationsByOrganizationIdVehicleLocations
      parameters:
        - name: realmId
          in: path
          required: true
          description: |-
            ID of your realm.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b
        - name: organizationId
          in: path
          required: true
          description: |-
            ID of your organization.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: c4bd3f21-dfbd-44e8-8055-68ba15bed410
        - name: query
          in: query
          required: true
          description: >-
            Text to search pick-up and drop-off places for: part of a city,
            airport or place name, a slug or an address, case-insensitive.
          schema:
            type: string
            minLength: 1
          example: Sao Paulo
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: >-
                            ID of the place. Use it, or its `slug`, as
                            `destinationId` of a hotel search or as a pick-up or
                            drop-off place of a vehicle search.
                          example: lctn_Mr4Bn7YcQd1Ks9TeVw2Xh
                        slug:
                          type: string
                          description: Readable unique identifier of the place.
                          example: sao-paulo-sp
                        name:
                          type: string
                          description: Display name.
                          example: São Paulo
                        region:
                          type: string
                          description: Region the place belongs to.
                          example: Brasil
                        address:
                          type: object
                          properties:
                            shortAddress:
                              type: string
                              nullable: true
                              description: >-
                                The address in a single line. `null` when
                                unknown.
                              example: Guarulhos, SP, Brazil
                            adressLines:
                              type: array
                              items:
                                type: string
                                example: Rod. Hélio Smidt, s/n
                              description: >-
                                The address in postal lines. Empty when unknown.
                                The field name is spelled `adressLines`.


                                ---


                                Example: `["Rod. Hélio Smidt, s/n"]`
                            locality:
                              type: string
                              nullable: true
                              description: City. `null` when unknown.
                              example: Guarulhos
                            administrativeArea:
                              type: string
                              nullable: true
                              description: State or province code. `null` when unknown.
                              example: SP
                            administrativeAreaName:
                              type: string
                              nullable: true
                              description: State or province name. `null` when unknown.
                              example: São Paulo
                            postalCode:
                              type: string
                              nullable: true
                              description: Postal code. `null` when unknown.
                              example: 07190-100
                            country:
                              type: string
                              description: Country (ISO 3166-1 alpha-2).
                              example: BR
                            timezone:
                              type: string
                              description: IANA time zone of the place, or `Unknown`.
                              example: America/Sao_Paulo
                            coordinates:
                              description: Position of the place. `null` when unknown.
                              type: object
                              properties:
                                lat:
                                  type: number
                                  description: Latitude, in decimal degrees.
                                  example: -23.4356
                                lng:
                                  type: number
                                  description: Longitude, in decimal degrees.
                                  example: -46.4731
                              required:
                                - lat
                                - lng
                              nullable: true
                            localityId:
                              type: string
                              nullable: true
                              description: >-
                                ID of the locality the bus station belongs to.
                                Bus stations only; `null` when the station is
                                not grouped under a locality.
                          required:
                            - shortAddress
                            - adressLines
                            - locality
                            - administrativeArea
                            - administrativeAreaName
                            - postalCode
                            - country
                            - timezone
                            - coordinates
                          description: Address and position of the place.
                        type:
                          type: string
                          enum:
                            - AIRPORT
                            - LOCALITY
                            - LOCALITY_AND_SURROUNDINGS
                            - GENERIC_PLACE
                          description: >-
                            What the place is: `AIRPORT`, `LOCALITY`,
                            `LOCALITY_AND_SURROUNDINGS` or `GENERIC_PLACE`.
                          example: LOCALITY
                      required:
                        - id
                        - slug
                        - name
                        - region
                        - address
                        - type
                      description: >-
                        A destination or pick-up place (`hotel` and `vehicle`
                        locations).
                    description: >-
                      Matching places, most relevant first. Empty when nothing
                      matches.
                required:
                  - results
                description: >-
                  The pick-up and drop-off places matching a vehicle location
                  search.
        '422':
          description: >-
            `BAD_REQUEST` — A path parameter is not a valid ID, or `query` is
            missing or blank; `fields` lists each one.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - BAD_REQUEST
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - TRAVEL
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                  fields:
                    type: array
                    description: >-
                      One entry per invalid request field (validation errors
                      only).
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          description: >-
                            Path of the invalid field, e.g. `label` or
                            `values[0].value`.
                          example: label
                        message:
                          type: string
                          description: Why the field was rejected.
                          example: label is required
                        code:
                          type: string
                          description: >-
                            `<FIELD>_<REASON>` — e.g. `LABEL_REQUIRED`,
                            `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.
                          example: LABEL_REQUIRED
                        values:
                          type: array
                          items:
                            type: string
                          description: >-
                            The accepted values, when the field is an
                            enumeration.
                      required:
                        - field
                        - message
                        - code
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: BAD_REQUEST
                origin: TRAVEL
                message: >-
                  Bad Request: Your request is invalid or incomplete. Please
                  make sure you are requesting with the right fields.
                fields:
                  - field: query
                    message: 'Invalid input: expected string, received undefined'
                    code: QUERY_REQUIRED
        '503':
          description: >-
            `PROVIDER_UNAVAILABLE` — The travel provider could not be reached.
            Retry later.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - PROVIDER_UNAVAILABLE
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - TRAVEL
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: PROVIDER_UNAVAILABLE
                origin: TRAVEL
                message: Travel provider temporarily unavailable, please retry.

````

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