Shipment Documents

PEAK Connect Shipment Documents allows you to retrieve shipment documents in PEAK TMS programmatically.

Resource URL

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

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

Request/Response Examples

JSON Request Body

{
“accessToken”:”str1234″,
“shipmentNumber”:”ship1234″,
” documentTypes”:[
{“documentType”:”BOL”},
{“documentType”:”POD”},
{“documentType”:”LABELS”}
]
}

JSON Response Body

{
“shipmentNumber”: “ship1234”,
“shipmentDocuments”: [
{
“documentType”: 0,
“documentData”: “AAAAZg==”
},
{
“documentType”: 1,
“documentData”: “AAAAZg==”
},
{
“documentType”: 2,
“documentData”: “AAAAZg==”
}
],
“errors”: [
{
“code”: “BErr”,
“message”: “BOL Error”
},
{
“code”: “PErr”,
“message”: “POD Error”
},
{
“code”: “LErr”,
“message”: “LABELS Error”
}
]
}

XML Request Body

<?xml version=”1.0″ encoding=”utf-8″?>
<DocumentRequest>
<!–BOL–>
<accessToken>str1234</accessToken>
<shipmentNumber>ship1234</shipmentNumber>
<documentTypes>
<documentType>BOL</documentType>
<documentType>POD</documentType>
<documentType>LABELS</documentType>

</documentTypes>

</DocumentRequest>

XML Response Body

<DocumentResponse xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>
<shipmentNumber>ship1234</shipmentNumber>
<shipmentDocuments>
<shipmentDocument>
<documentType>BOL</documentType>
<documentData>AAAAZg==</documentData>
</shipmentDocument>
<shipmentDocument>
<documentType>POD</documentType>
<documentData>AAAAZg==</documentData>
</shipmentDocument>
<shipmentDocument>
<documentType>LABELS</documentType>
<documentData>AAAAZg==</documentData>
</shipmentDocument>
</shipmentDocuments>
<errors>
<error>
<code>BErr</code>
<message>BOL Error</message>
</error>
<error>
<code>PErr</code>
<message>POD Error</message>
</error>
<error>
<code>LErr</code>
<message>LABELS Error</message>
</error>
</errors>
</DocumentResponse>

Menu