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
Search:
| Property Name | Required | Format | Definition |
|---|---|---|---|
| accessToken | Y | Access token supplied by Ascent | |
| shipmentNumber | Y | String | Shipment identifier returned when the shipment was created |
| carrierScac | N | String – 4 characters | SCAC Code of the carrier to submit the shipment to. If the shipment has already been assigned to a carrier, this is not needed |
| ediCarrierScac | N | String – 4 characters | Alternate SCAC Code of the carrier to submit the shipment to. If the shipment has already been assigned to a carrier, this is not needed |
| tenderTest | N | String | Indicates 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
Search:
| Property Name | Data Type | Definition |
|---|---|---|
| tenderNumber | String | If 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. |
| shipmentNumber | String | Shipment identifier for the shipment tendered. This will match the shipmentNumber in the tender request |
| ediControlNumber | String | If present, the control number sent to the carrier via EDI when the pickup request was submitted |
| statusDetails | A collection of StatusDetail elements for the tender. See below for status detail properties. | |
| errors | A 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
Search:
| Property Name | Data Type | Definition |
|---|---|---|
| statusCode | String | One of SUBMITTED – pickup request transmitted to the carrier or FAILED – tender request failed. If FAILED, see the errors for more details on the issues |
| statusMessage | String | Display message related to the statusCode |
| statusType | String | If present, the means by which the tender was submitted to the carrier. Most typically this will be EDI |
| statusDate | String | Timestamp of the tender submission to the carrier. Formatted as yyyy-MM-ddThh:mm:ss |
| statusLocation | String | If present, the postal code for the shipment pickup |
| statusCodeReason | String | Deprecated as unused – likely to be removed from a future version of the API |
| appointmentStatusCode | String | Deprecated as unused – likely to be removed from a future version of the API |
| appointmentStatusCodeReason | String | Deprecated as unused – likely to be removed from a future version of the API |
Tender Error
Search:
| Property Name | Data Type | Definition |
|---|---|---|
| code | String | Unique code for the message |
| message | String | Display message related to the code |
Request/Response Examples
JSONXML