QuoteStop

One stop on the route. A rate request describes a geographic point rather than a facility, so no street address is sent.

  • address
    Type: object
    required

    A geographic point. The field names match LoadRouteStop.address, but only city, stateOrProvince and country are required. Quote requests routinely arrive with no ZIP, and street lines are never sent.

    • city
      Type: string
      required

      City name

    • country
      Type: string enum
      required

      Two-letter ISO country code

      values
      • US
      • CA
      • MX
    • stateOrProvince
      Type: string
      required

      State or province code

    • postalCode
      Type: string | null

      Postal or ZIP code, when the source document had one

  • sequence
    Type: integer
    min:  
    1
    required

    Position of the stop in the route. Starts at 1 and goes up by 1 for each stop after it.

  • stopActivity
    enum
    required
    values
    • PICKUP
    • DELIVERY