---
title: "StopRequest"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-listing-api-2-0-0/versions/6459c118-c2b9-484e-816d-5657457559e4/schemas/StopRequest"
---

> Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-listing-api-2-0-0/versions/6459c118-c2b9-484e-816d-5657457559e4.md

# StopRequest

Details of a stop.

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Listing API
  version: 2.0.0
servers:
  - url: https://marketplace-api.centraldispatch.com
    description: Production server
components:
  schemas:
    GeoCodeRequest:
      type: object
      properties:
        longitude:
          type: number
          description: The longitude of the location.
          format: double
          example: -117.91836265987132
        latitude:
          type: number
          description: The latitude of the location.
          format: double
          example: 33.81228788622535
      description: Details of the geographical coordinates for a location.
      nullable: true
    StopRequest:
      type: object
      properties:
        stopId:
          type: string
          description: The system assigned UUID of the stop. Read-only on create (POST).
            Required on update (PUT).
          format: uuid
        stopNumber:
          type: integer
          description: The sequential number of the stop along the route e.g. 1 is the
            pick up stop and 2 is the delivery stop.
          format: int32
          example: 1
        locationName:
          maxLength: 200
          type: string
          description: The name of the stop.
          nullable: true
          example: ABC Cars lot
        address:
          maxLength: 100
          type: string
          description: The street address.
          nullable: true
          example: 345 W Elm St.
        address2:
          maxLength: 100
          type: string
          description: Additional street address line.
          nullable: true
          example: 2nd Floor
        city:
          maxLength: 50
          type: string
          description: The city.
          example: Anaheim
        state:
          type: string
          description: The state.
          example: CA
        postalCode:
          maxLength: 20
          type: string
          description: The ZIP code. Must be a valid United States ZIP code or Canadian
            postal code.
          example: "92802"
        country:
          maxLength: 2
          type: string
          description: The country code. US or CA.
          nullable: true
          example: US
        phone:
          maxLength: 50
          type: string
          description: The primary phone number of the contact.
          nullable: true
          example: 949-555-1323
        phone2:
          maxLength: 50
          type: string
          description: An additional phone number of the contact.
          nullable: true
          example: 949-555-2434
        phone3:
          maxLength: 50
          type: string
          description: An additional phone number of the contact.
          nullable: true
          example: 949-555-3545
        siteId:
          type: string
          description: The ID of the site.
          nullable: true
          example: ABC
        contactName:
          maxLength: 100
          type: string
          description: The name of the contact.
          nullable: true
          example: Mickey Smith
        contactPhone:
          maxLength: 50
          type: string
          description: The primary phone number of the contact.
          nullable: true
          example: 949-555-1323
        contactCellPhone:
          maxLength: 50
          type: string
          description: The cell phone number of the contact.
          nullable: true
          example: 949-555-1212
        buyerNumber:
          maxLength: 70
          type: string
          description: The buyer reference number.
          nullable: true
          example: "12345"
        metroArea:
          maxLength: 150
          type: string
          description: The metro area of the stop.
          nullable: true
          example: Orange County
        twic:
          type: boolean
          description: Indicates whether the stop requires driver to have a Transportation
            Worker Identification Credential (TWIC). A TWIC is a credential
            required by the Maritime Transportation Security Act for carriers to
            access some locations. If you are not sure if a TWIC is needed,
            please contact the location.
          default: false
          example: true
        geoCode:
          $ref: "#/components/schemas/GeoCodeRequest"
        locationType:
          enum:
            - Unspecified
            - AirportRentalCenter
            - Auction
            - AuctionSatelliteLot
            - CommercialBusiness
            - CorporateOfficePlant
            - CrossDockSatelliteStagingLot
            - Dealership
            - Impound
            - MarshallingYard
            - MilitaryBase
            - MobileAuction
            - Port
            - RailYard
            - ReconFacility
            - RentalCarRetailSite
            - Repo
            - Residence
            - ServiceCenter
            - ConsumerMoves
            - Terminal
            - Other
            - MechanicShop
            - Warehouse
            - ParkingLot
          type: string
          description: The facility type of the stop. This list is not exhaustive and
            additional values may be added at any time.
          default: Unspecified
          nullable: true
          example: Dealership
        contactEmailAddress:
          type: string
          description: The email address of the contact. Must be a valid email address
            format.
          nullable: true
          example: mickey@snoogle.com
      description: Details of a stop.
```