Source
stringThe source of the listing.
Allowed values:APIUI
"API"StopRequest
objectDetails of a stop.
The system assigned UUID of the stop. Read-only on create (POST). Required on update (PUT).
The sequential number of the stop along the route e.g. 1 is the pick up stop and 2 is the delivery stop.
Example:1
The name of the stop.
<= 200 characters
Example:ABC Cars lot
The street address.
<= 100 characters
Example:345 W Elm St.
Additional street address line.
<= 100 characters
Example:2nd Floor
The city.
<= 50 characters
Example:Anaheim
The state.
Example:CA
The ZIP code. Must be a valid United States ZIP code or Canadian postal code.
<= 20 characters
Example:92802
The country code. US or CA.
<= 2 characters
Example:US
The primary phone number of the contact.
<= 50 characters
Example:949-555-1323
An additional phone number of the contact.
<= 50 characters
Example:949-555-2434
An additional phone number of the contact.
<= 50 characters
Example:949-555-3545
The ID of the site.
Example:ABC
The name of the contact.
<= 100 characters
Example:Mickey Smith
The primary phone number of the contact.
<= 50 characters
Example:949-555-1323
The cell phone number of the contact.
<= 50 characters
Example:949-555-1212
The buyer reference number.
<= 70 characters
Example:12345
The metro area of the stop.
<= 150 characters
Example:Orange County
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
Details of the geographical coordinates for a location.
Show Child Parameters
The facility type of the stop.
Allowed values:UnspecifiedAirportRentalCenterAuctionAuctionSatelliteLotCommercialBusinessCorporateOfficePlantCrossDockSatelliteStagingLotDealershipImpoundMarshallingYardMilitaryBaseMobileAuctionPortRailYardReconFacilityRentalCarRetailSiteRepoResidenceServiceCenterConsumerMovesTerminalOtherMechanicShopWarehouseParkingLot
Default:Unspecified
Example:Dealership
The email address of the contact. Must be a valid email address format.
Example:mickey@snoogle.com
{
"stopId": "stopId",
"stopNumber": 1,
"locationName": "ABC Cars lot",
"address": "345 W Elm St.",
"address2": "2nd Floor",
"city": "Anaheim",
"state": "CA",
"postalCode": "92802",
"country": "US",
"phone": "949-555-1323",
"phone2": "949-555-2434",
"phone3": "949-555-3545",
"siteId": "ABC",
"contactName": "Mickey Smith",
"contactPhone": "949-555-1323",
"contactCellPhone": "949-555-1212",
"buyerNumber": "12345",
"metroArea": "Orange County",
"twic": true,
"geoCode": {
"longitude": -117.91836265987132,
"latitude": 33.81228788622535
},
"locationType": "Dealership",
"contactEmailAddress": "mickey@snoogle.com"
}StopResponse
objectDetails of a stop.
The system assigned UUID of the stop.
Example:4e2efc84-6add-435c-9f12-8b19e3e5ba21
The sequential number of the stop along the route e.g. 1 is the pick up stop and 2 is the delivery stop.
Example:1
The name of the stop.
Example:ABC Cars lot
The street address.
Example:345 W Elm St.
Additional street address line.
Example:2nd Floor
The city.
Example:Anaheim
The state.
Example:CA
The ZIP code. Must be a valid United States ZIP code or Canadian postal code.
Example:92802
The country code. US or CA.
Example:US
The distance to the next stop in miles.
Example:267
The primary phone number of the contact.
Example:949-555-1323
An additional phone number of the contact.
Example:949-555-2434
An additional phone number of the contact.
Example:949-555-3545
The ID of the site.
Example:ABC
The name of the contact.
Example:Mickey Smith
The primary phone number of the contact.
Example:949-555-1323
The cell phone number of the contact.
Example:949-555-1212
The metro area of the stop.
Example:Orange County
The facility type of the stop.
Allowed values:UnspecifiedAirportRentalCenterAuctionAuctionSatelliteLotCommercialBusinessCorporateOfficePlantCrossDockSatelliteStagingLotDealershipImpoundMarshallingYardMilitaryBaseMobileAuctionPortRailYardReconFacilityRentalCarRetailSiteRepoResidenceServiceCenterConsumerMovesTerminalOtherMechanicShopWarehouseParkingLot
Example:Dealership
Details of the geographical coordinates for a location.
Show Child Parameters
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
The email address of the contact. Must be a valid email address format.
Example:mickey@snoogle.com
{
"stopId": "4e2efc84-6add-435c-9f12-8b19e3e5ba21",
"stopNumber": 1,
"locationName": "ABC Cars lot",
"address": "345 W Elm St.",
"address2": "2nd Floor",
"city": "Anaheim",
"state": "CA",
"postalCode": "92802",
"country": "US",
"distanceToNextStopInMiles": 267,
"phone": "949-555-1323",
"phone2": "949-555-2434",
"phone3": "949-555-3545",
"siteId": "ABC",
"contactName": "Mickey Smith",
"contactPhone": "949-555-1323",
"contactCellPhone": "949-555-1212",
"metroArea": "Orange County",
"locationType": "Dealership",
"geoCode": {
"longitude": -117.91836265987132,
"latitude": 33.81228788622535
},
"twic": true,
"contactEmailAddress": "mickey@snoogle.com"
}TagRequest
objectDetails of a tag.
The name of the tag.
<= 100 characters
Example:contractedCarrier
The value of the tag.
<= 500 characters
Example:true
{
"name": "contractedCarrier",
"value": "true"
}TagResponse
objectDetails of a listing tag.
The name of the tag.
Example:contractedCarrier
The value of the tag.
Example:true
{
"name": "contractedCarrier",
"value": "true"
}