---
title: "StopResponse"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665/schemas/StopResponse"
---

> Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-fulfillment-api-1-0-0/versions/8637c155-7ff6-49fa-ac0a-3b4df78c9665.md

# StopResponse

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:
    StopResponse:
      type: object
      properties:
        shipmentDescriptionId:
          type: string
          description: The ID of the shipment description.
          format: uuid
          nullable: true
          example: 519e0000-e89b-12d3-a456-426614174000
        href:
          type: string
          description: The URL used to query the current collection of the resource.
          nullable: true
          example: https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000
        stopId:
          type: string
          description: The system assigned UUID of the stop.
          format: uuid
          example: 9b6e0fad-8722-4da1-907c-f9522c04ef12
        sequenceId:
          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
          nullable: true
          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.
          nullable: true
          example: DEALER
        stopTypeDescription:
          type: string
          description: The name of the stop.
          nullable: true
          example: Dealership in the heart of the city.
        locationName:
          type: string
          description: The name of the stop.
          nullable: true
          example: ABC Cars lot
        externalLocationId:
          type: string
          description: A location identifier managed by the user.
          nullable: true
          example: Loc123
        address:
          type: string
          description: The street address.
          nullable: true
          example: 345 W Elm St.
        address2:
          type: string
          description: Additional street address line.
          nullable: true
          example: 2nd Floor
        city:
          type: string
          description: The city.
          nullable: true
          example: Anaheim
        state:
          type: string
          description: The state.
          nullable: true
          example: CA
        zipCode:
          type: string
          description: The ZIP code. Must be a valid United States ZIP code or Canadian
            postal code.
          nullable: true
          example: "92802"
        country:
          type: string
          description: The country code. US or CA.
          nullable: true
          example: US
        phone:
          type: string
          description: The primary phone number of the contact.
          nullable: true
          example: 949-555-0101
        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
        siteId:
          type: string
          description: The ID of the site.
          nullable: true
          example: ABC
        contactName:
          type: string
          description: The name of the contact.
          nullable: true
          example: Mickey Smith
        contactPhone:
          type: string
          description: The primary phone number of the contact.
          nullable: true
          example: 949-555-0101
        contactCellPhone:
          type: string
          description: The cell phone number of the contact.
          nullable: true
          example: 949-555-1212
        contactEmail:
          type: string
          description: The email address of the contact. Must be a valid email address
            format.
          nullable: true
          example: mickey@snoogle.com
        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.
          example: true
        latitude:
          type: number
          description: The latitude of the location.
          format: double
          nullable: true
          example: 33.81228788622535
        longitude:
          type: number
          description: The longitude of the location.
          format: double
          nullable: true
          example: -117.91836265987132
        buyerNumber:
          type: string
          description: The buyer reference number.
          nullable: true
          example: "12345"
      description: Details of a stop.
```