New Tender
POST v2/quotes/tender
The tender endpoint is used to tender White Arrow loads from a quote generated by the user.
Request
Tender Object
quoteNumber
string
Yes
Quote number is the id from the quote response service level that you wish to tender. Ex. P12345 or G12345 or E12345
referenceNumber
string
Yes
The quoting party's unique load identification number / BOL number / Pro number.
notes
string
No
Any relevant notes to be included with the load.
tenderStops
array
Yes
An array of tender stop objects. See Below.
tenderCommodities
array
Conditional
An array of tender commodity objects. See Below. Only required if there is more than one pickup or more than one delivery
Tender Stop Object
shipConID
int
Yes
The id of the stop that was returned in the quote response.
name
string
Yes*
The name of the location of the stop. Ex. Acme Warehouse
line1
string
Yes*
The street address of the stop. Ex. 500 Citadel Dr.
city
string
Yes*
The city of the stop
state
string
Yes*
The state of the stop. Must be in two letter format i.e. 'CA'
zip
string
Yes*
The zip code of the stop.
referenceNumber
string
Yes
Any relevant reference number / BOL number / Pro Number for the stop.
confimationNumber
string
No
The confirmation number for the stop if any.
date
string
Yes
Required for pickups only. The date of the stop in the form '2016-01-31' (YEAR-MONTH-DAY).
timeFrom
string
No
The earliest time of an appointment window for a stop in the form '14:00' ALL TIMES ARE THE LOCAL TIME OF THE STOP.
timeTo
string
No
The latest time of an appoinmtment window for a stop in the form '16:00' ALL TIMES ARE THE LOCAL TIME OF THE STOP.
contactName
string
No
Name of contact person at the stop location.
phone
string
No
Contact phone number for the stop location.
notes
string
No
Any notes for the stop.
*The field is only required if the quote stop did not return a locationId
Tender Commodity Object
shipperID
int
Yes
The id of the pickup for the commodity. The id comes from the stop that was returned in the quote response.
consigneeID
int
Yes
The id of the delivery for the commodity. The id comes from the stop that was returned in the quote response.
pallets
int
Yes
Pallets in the commodity. The total pallets of all the commodities must match the pallets from the quote response.
feet
int
Yes
Linear feet of the commodity. The total feet of all the commodities must match the feet from the quote response.
weight
int
Yes
Weight of the commodity. The total weight of all the commodities must match the weight of quote response.
pieces
int
No
Optional number of pieces for the commodity.
notes
string
No
Any notes for the commodity. Any relevant ID numbers can go here as well.
Example Request
Example 1 - request with 1 pickup and 1 delivery
{
"quoteNumber":"G1430621",
"referenceNumber":"6e6666sd33",
"tenderStops":[
{
"shipConID":3045341,
"referenceNumber":"12223",
"date":"2018-02-15",
"timeFrom":"7:00AM",
"timeTo":"7:00AM",
"contactName":"Sterling Archer"
},
{
"shipConID":3045342,
"referenceNumber":"12224"
}
],
"tenderCommodities":[
{
"shipperID":3045341,
"consigneeID":3045342,
"pallets":5,
"feet":6,
"weight":1000,
"notes":"Hello"
}
]
}Example 2 - request with multiple stops
{
"quoteNumber":"P1430650",
"referenceNumber":"6e6666sd33",
"tenderStops":[
{
"shipConID":3045413,
"name":"The Beverly Hills Hotel",
"line1":"9641 Sunset Blvd",
"city":"Beverly Hills",
"state":"CA",
"zip":"90210",
"referenceNumber":"12223",
"date":"2018-04-16",
"timeFrom":"07:00",
"timeTo":"07:00",
"contactName":"Sterling Archer"
},
{
"shipConID":3045414,
"name":"Alfred Coffee Silverlake",
"line1":"3337 Sunset Blvd",
"city":"Los Angeles",
"state":"CA",
"zip":"90026",
"referenceNumber":"12224",
"date":"2018-04-16",
"timeFrom":"12:00",
"timeTo":"13:00",
"contactName":"Alfred"
},
{
"shipConID":3045415,
"name":"University of Illinois",
"line1":"750 S Halsted St",
"city":"Chicago",
"state":"IL",
"zip":"60607",
"referenceNumber":"12225",
"date":"2018-04-23",
"timeFrom":"12:00",
"timeTo":"13:00",
"contactName":"Michael Jordan"
}
],
"tenderCommodities":[
{
"shipperID":3045413,
"consigneeID":3045415,
"pallets":4,
"feet":6,
"weight":6000,
"notes":""
},
{
"shipperID":3045414,
"consigneeID":3045415,
"pallets":6,
"feet":8,
"weight":7000,
"notes":"Coffee"
}
]
}Tender Response
Response Object
id
int
Yes
loadId
int
The ID of the newly created load. This is used to identify the load in White Arrow's system.
quoteNumber
string
Original quote number sent.
serviceLevel
string
The service level of the load.
referenceNumber
string
The quoting party's reference number.
totalRate
float
The total price of the load.
baseRate
float
The base rate of the load.
fuelRate
float
The fuel surcharge of the load.
extra
float
The total of all accessorials excluding fuel surcharge.
accessorials
array
An array of accessorial objects. See Below.
stops
array
An array of stop objects. See Below.
Accessorial Object
costAmount
float
The cost of the accessorial.
name
string
The name of the accessorial
accessorialId
int
The id of the accessorial.
stopId
int
The id of the stop object this accessorial is for. Omitted if the accessorial is not part of a stop.
stopName
string
The name of the stop object this accessorial is for. Omitted if the accessorial is not part of a stop.
Stop Object
id
int
The unique id of the stop.
name
string
The name of the location of the stop.
type
string
Either shipper (pickup) or consignee (delivery)
referenceNumber
string
The supplied reference number / BOL number / Pro Number for the stop.
date
string
The date of the stop in the form '2016-01-31' (YEAR-MONTH-DAY).
timeFrom
string
The earliest time of an appointment window for a stop in the form '14:00' ALL TIMES ARE THE LOCAL TIME OF THE STOP.
timeTo
string
The latest time of an appointment window for a stop in the form '14:00' ALL TIMES ARE THE LOCAL TIME OF THE STOP.
address
object
An object representing the address of the stop. See Below.
Address Object
locationId
int
If the address is a valid location then the id is returned.
city
string
The city name.
state
string
The two letter state abbreviation. Ex "CA"
zip
string
The zip code of the address.
latitude
float
The latitude of the address.
longitude
float
The longitude of the address.
Example 1 - response with 1 pickup and 1 delivery
{
"id":19,
"loadId":744068,
"quoteNumber":"P1430635",
"quoteId":1430635,
"serviceLevel":"premium",
"referenceNumber":"6e6666sd33",
"totalRate":1528,
"baseRate":1379,
"fuelRate":249,
"extra":-100,
"accessorials":[
{
"costAmount":-50,
"name":"Online Quote Discount",
"accessorialId":66
},
{
"costAmount":-50,
"name":"Online Tender Discount",
"accessorialId":68
}
],
"stops":[
{
"id":3045373,
"name":"Casper c/o Iron Mountain",
"referenceNumber":"12223",
"type":"shipper",
"date":"2018-4-15",
"timeFrom":"07:00",
"timeTo":"07:00",
"address":{
"locationId":70678,
"line1":"8595 Milliken Ave",
"city":"Rancho Cucamonga",
"state":"CA",
"zip":"91730",
"latitude":34.0973,
"longitude":-117.555
}
},
{
"id":3045374,
"name":"Mule Creek State Prison - DOC",
"referenceNumber":"12224",
"type":"consignee",
"address":{
"locationId":74248,
"line1":"4001 CA-104",
"city":"Plymouth",
"state":"CA",
"zip":"95669",
"latitude":38.3687,
"longitude":-120.959
}
}
]
}Example 2 - response with multiple stops
{
"id":20,
"loadId":744073,
"quoteNumber":"P1430650",
"quoteId":1430650,
"serviceLevel":"premium",
"referenceNumber":"6e6666sd33",
"totalRate":1129,
"baseRate":1041,
"fuelRate":188,
"extra":-100,
"accessorials":[
{
"costAmount":-50,
"name":"Online Quote Discount",
"accessorialId":66
},
{
"costAmount":-50,
"name":"Online Tender Discount",
"accessorialId":68
}
],
"stops":[
{
"id":3045413,
"name":"The Beverly Hills Hotel",
"referenceNumber":"12223",
"type":"shipper",
"date":"2018-4-16",
"timeFrom":"07:00",
"timeTo":"07:00",
"address":{
"locationId":74262,
"line1":"9641 Sunset Blvd",
"city":"Beverly Hills",
"state":"CA",
"zip":"90210",
"latitude":34.0818,
"longitude":-118.413
}
},
{
"id":3045414,
"name":"Alfred Coffee Silverlake",
"referenceNumber":"12224",
"type":"shipper",
"date":"2018-4-16",
"timeFrom":"12:00",
"timeTo":"13:00",
"address":{
"locationId":74263,
"line1":"3337 Sunset Blvd",
"city":"Los Angeles",
"state":"CA",
"zip":"90026",
"latitude":34.0875,
"longitude":-118.276
}
},
{
"id":3045415,
"name":"University of Illinois",
"referenceNumber":"12225",
"type":"consignee",
"date":"2018-4-23",
"timeFrom":"12:00",
"timeTo":"13:00",
"address":{
"locationId":74264,
"line1":"750 S Halsted St",
"city":"Chicago",
"state":"IL",
"zip":"60607",
"latitude":41.8719,
"longitude":-87.648
}
}
]
}Last updated