SlaResponse
objectDetails of the service level agreement (SLA) for a listing.
How many days the customer has to pick up/deliver. The format is ISO 8601 duration format P{duration in days}D where the number of days comes from when the listing becomes available. For example, P2D means 2 days. This sets the deadline for completing the transport.
Example:P2D
Which time zone to use for SLA calculations. For example, -5.00 represents Eastern Time and +0.00 represents UTC/GMT. Can be negative. Acceptable range: -12:00 to +14:00 hours.
Example:-7:00
The time of day the “business day” ends. For example, 17:30 means 5:30 PM. If the load is accepted after this time and available for immediate pickup, the ability for it to be picked up on the same day is determined by includeCurrentDayAfterRollOver.
Match pattern:^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$
Example:19:00:00
Indicates whether the load can be picked up after the rollover time if it is available on the same day the load is accepted. This could be do to the pickup location not being open or reachable after the rollover time. Does not apply to listings with availableDate in the future.
Example with 5:30 PM rollover:
When true: When accepting the load, the carrier can choose to pick it up after 5:30 PM. Sla duration starts tomorrow and ends on day 3.
When false: When accepting the load, the carrier cannot choose to pick it up after 5:30 PM today. It can only be picked up tomorrow as the pickup location has closed at the rollover time. Sla duration starts tomorrow and ends on day 3.
Example:true
Source
stringThe source of the listing.
Allowed values:APIUI
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
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
Default:Unspecified
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
TagRequest
objectDetails of a tag.
The name of the tag.
<= 100 characters
Example:contractedCarrier
The value of the tag.
<= 500 characters
Example:true