[OPTIONAL] Additional Stop Details

Adding Additional Stop Details

All optional stop parameters can be seen below:

Parameter

Type

Description

StopDescription

String

The description of the specific stop.

IsCarrierEtaOverride

Boolean

Does the carrier's supplied ETA override the derived Freight Portal ETA?

StopName

String

The name of the specific stop.

StopContactName

String

The contact's name of the specific stop.

StopContactPhoneNumber

String

The contact's phone number of the specific stop in E.164 format, if the number is a US number and not defined, +1 will be used. Multiple phone numbers can be provided separated by commas.

StopContactEmailAddress

String

The contact's email address of the specific stop. Multiple email addresses can be provided separated by commas.

StopContactFaxNumber

String

The contact's fax number of the specific stop.

StopContactPhoneExtension

String

The contact's phone extension of the specific stop.

StreetAddress2

String

The secondary street address of the stop.

LocationCode

String

Fixed Location code if one is available for the stop. Will overdrive any stop address if fixed location is used.

DwellTime

Integer

Dwell time is number of minutes.

IsDropTrailer

Boolean

Defines if a drop trailer is in use for the stop.

ShipmentStopNote

Array

Notes at a stop for each stop can be added via this.

Here is an example of a stop-detail rich JSON Object:

{
  "FreightProviderReferenceNumber":"111222333",
  "CarrierScac":"WODO",
  "Stops":
  [
    {
      "StopReference":"Origin",
      "StopScheduledDatePart":"2018-08-11",
      "StopSequence":1,
      "StopType":1,
      "Latitude":50.1234,
      "Longitude":-45.1234,
      "StopDescription":"A place where one stops",
      "IsCarrierEtaOverride":1,
      "StopName":"StoppityMcStopFace",
      "StopContactName":"Some Guy",
      "StopContactPhoneNumber":"1234567891",
      "StopContactEmailAddress":"[email protected]",
      "StopContactFaxNumber":"0198765432",
      "StopContactPhoneExtension":"887",
      "StreetAddress2":"Unit #103",
      "LocationCode": null,
      "DwellTime":50
      "additionalInformation": "Park on side driveway off Hollister Ave, deliver packages to parcel drop box at back gate.",
    },
    {
      "StopReference":"Destination",
      "StopScheduledDatePart":"2018-08-12",
      "StopSequence":2,
      "StopType":3,
      "Latitude":50.4920,
      "Longitude":-44.5543,
      "StopDescription":"Example of Stop 2",
      "IsCarrierEtaOverride":1,
      "StopName":"NM Bottling Plant 3",
      "StopContactName":"Stacey Edith",
      "StopContactPhoneNumber":"5553291185",
      "StopContactEmailAddress":"[email protected]",
      "StopContactFaxNumber":"1112223333",
      "StopContactPhoneExtension":"183",
      "StreetAddress2":"Dock #12",
      "LocationCode": null,
      "DwellTime":10,
      "additionalInformation": "Park on side street",
      "IsDropTrailer": false,
      "ShipmentStopNote": [
          {"Text": "Gate will lock at 22:00"},
          {"Text": "Return truck to loading zone."}
          ]
    }
  ],
  "IsDropTrailer":1
}