Tender

PEAK Connect Tender allows for electronic booking of freight with your carrier selection. We have worked with our carrier partners to provide you with a single endpoint to submit your pickups. No need to go directly to the carrier to call for pickup or have your IT team write individual API integrations by carriers.

Resource URL

QA: http(s)://connect.ascentgl.com/v1/tender.{xml , json}

Production:http(s)://qa-connect.ascentgl.com/v1/tender.{xml , json}

Parameters

Property NameRequiredFormatDefinition
accessTokenYAccess token supplied by Ascent
shipmentNumberYStringShipment identifier returned when the shipment was created
carrierScacNString - 4 charactersSCAC Code of the carrier to submit the shipment to. If the shipment has already been assigned to a carrier, this is not needed
ediCarrierScacNString - 4 charactersAlternate SCAC Code of the carrier to submit the shipment to. If the shipment has already been assigned to a carrier, this is not needed
tenderTestNStringIndicates this is a test - if true then the pickup request will not be submitted to the carrier. Allowed values: "Y", "N", "true", "false"

Response Properties

Property NameData TypeDefinition
tenderNumberStringIf present, a unique identifier for the tender submitted. This is an identifier used internally to the tendering system and is not related to other identifiers, such as PRO or BOL Number, for the shipment.
shipmentNumberStringShipment identifier for the shipment tendered. This will match the shipmentNumber in the tender request
ediControlNumberStringIf present, the control number sent to the carrier via EDI when the pickup request was submitted
statusDetailsA collection of StatusDetail elements for the tender. See below for status detail properties.
errorsA collection of Error elements for the tender response. There will always be at least one entry, with a code of REQUEST_ID and a unique identifier in the message. See below for error properties

Tender Status

Property NameData TypeDefinition
statusCodeStringOne of SUBMITTED - pickup request transmitted to the carrier or FAILED - tender request failed. If FAILED, see the errors for more details on the issues
statusMessageStringDisplay message related to the statusCode
statusTypeStringIf present, the means by which the tender was submitted to the carrier. Most typically this will be EDI
statusDateStringTimestamp of the tender submission to the carrier. Formatted as yyyy-MM-ddThh:mm:ss
statusLocationStringIf present, the postal code for the shipment pickup
statusCodeReasonStringDeprecated as unused - likely to be removed from a future version of the API
appointmentStatusCodeStringDeprecated as unused - likely to be removed from a future version of the API
appointmentStatusCodeReasonStringDeprecated as unused - likely to be removed from a future version of the API

Tender Error

Property NameData TypeDefinition
codeStringUnique code for the message
messageStringDisplay message related to the code

Request/Response Examples

JSON

JSON Request

{
	“accessToken”:”str1234″,
	“shipmentNumber”:”1234567890″,
	“carrierScac”:”ODFL”,
	“ediCarrierScac”:”ODFL”,
	“tenderTest”:”false”
}

JSON Response

{
	“tenderNumber”: “236789”,
	“shipmentNumber”: “1234567890”,
	“ediControlNuber”: “000004321”,
	“statusDetails”: {
		“statusCode”: “SUBMITTED”,
		“statusCodeReason”: “”,
		“appointmentStatusCode”: “”,
		“appointmentStatusCodeReason”: “”,
		“statusType”: “EDI”,
		“statusMessage”: “Pickup request has been submitted to the carrier”,
		“statusDate”: “2018-05-01T12:12:12”,
		“statusLocation”: “”
	},
	“errors”: [
	{
		“code”: “0”,
		“message”: “No Errors”
	}
	]
}
XML

Request XML

<TenderShipment>
	<accessToken>ABCDEFGHIJKL</accessToken>
	<shipmentNumber>1234567890</shipmentNumber>
	<carrierScac>ODFL</carrierScac>
	<ediCarrierScac>ODFL</ediCarrierScac>
	<tenderTest>false</tenderTest>
</TenderShipment>

Response XML

<TenderResponse>
	<tenderNumber>236789</tenderNumber>
	<shipmentNumber>1234567890</shipmentNumber>
	<ediControlNuber>000004321</ediControlNuber>
	<statusDetails>
		<statusCode>SUBMITTED</statusCode>
		<statusMessage>Pickup request has been submitted to the carrier</statusMessage>
		<statsuDate>2018-05-01T12:12:12</statusDate>
		<statusType>EDI</statusType>
		<statusLocation>04347</statusLocation>
		<statusCodeReason></statusCodeReason>
		<appointmentStatusCode></appointmentStatusCode>
		<appointmentStatusCodeReason></appointmentStatusCodeReason>
	</statusDetails>
	<errors>
		<error>
			<code>REQUEST_ID</code>
			<message>6758393599608739</message>	
		</error>
	</errors>
</TenderResponse>
Menu