---
title: "StopRequest"
url: "https://api-docs.centraldispatch.com/apis/fulfillment-api-1-0-0/versions/ed4f06d9-fab0-4a1d-a6a8-ce631f6542d0/schemas/StopRequest"
---

> Full API specification: https://api-docs.centraldispatch.com/apis/fulfillment-api-1-0-0/versions/ed4f06d9-fab0-4a1d-a6a8-ce631f6542d0.md

# StopRequest

Details of a stop.

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Fulfillment API
  version: 1.0.0
servers:
  - url: https://fulfillment-api.centraldispatch.com
    description: Production server
components:
  schemas:
    AddressRequest:
      type: object
      properties:
        address1:
          type: string
          description: The street address.
          example: 345 W Elm St.
        address2:
          type: string
          description: Additional street address line.
          nullable: true
          example: 2nd Floor
        city:
          type: string
          description: The city.
          example: Anaheim
        state:
          type: string
          description: The state.
          example: CA
        zipCode:
          type: string
          description: The ZIP code. Must be a valid United States ZIP code or Canadian
            postal code.
          example: "92802"
        countryCode:
          type: string
          description: The country code. US or CA.
          default: US
          nullable: true
          example: US
      description: Details of an address.
    ContactRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the contact.
          nullable: true
          example: Mickey Smith
        phone:
          type: string
          description: The primary phone number of the contact.
          nullable: true
          example: 949-555-0101
        phone1:
          type: string
          description: An additional phone number of the contact.
          nullable: true
          example: 949-555-1323
        phone2:
          type: string
          description: An additional phone number of the contact.
          nullable: true
          example: 949-555-2434
        phone3:
          type: string
          description: An additional phone number of the contact.
          nullable: true
          example: 949-555-3545
        cellPhone:
          type: string
          description: The cell phone number of the contact.
          nullable: true
          example: 949-555-1212
        email:
          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 contact.
    StopRequest:
      type: object
      properties:
        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
        stopType:
          enum:
            - OTHER
            - AIRPORT_RENTAL_CENTER
            - AUCTION
            - AUCTION_SATELLITE_LOT
            - COMMERCIAL_BUSINESS
            - CORPORATE_OFFICE_PLANT
            - CROSS_DOCK_OR_SATELLITE_STAGING_LOT
            - DEALER
            - IMPOUND
            - MARSHALLING_YARD
            - MILITARY_BASE
            - MOBILE_AUCTION
            - PORT
            - RAIL_YARD
            - RECON_FACILITY
            - RENTAL_CAR_RETAIL_SITE
            - REPO
            - RESIDENCE
            - SERVICE_CENTER
            - TERMINAL
          type: string
          description: The facility type of the stop. This list is not exhaustive and
            additional values may be added at any time.
          example: DEALER
        name:
          type: string
          description: The name of the stop.
          nullable: true
          example: ABC Cars lot
        address:
          $ref: "#/components/schemas/AddressRequest"
        contact:
          $ref: "#/components/schemas/ContactRequest"
        externalLocationId:
          type: string
          description: A location identifier managed by the user.
          nullable: true
          example: Loc123
        isTWIC:
          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
        siteId:
          type: string
          description: The ID of the site.
          nullable: true
          example: ABC
        latitude:
          type: string
          description: The latitude of the location.
          nullable: true
          example: "33.81228788622535"
        longitude:
          type: string
          description: The longitude of the location.
          nullable: true
          example: "-117.91836265987132"
        buyerNumber:
          type: string
          description: The buyer reference number.
          nullable: true
          example: "12345"
      description: Details of a stop.
```