Shipment

PEAK™ Connect Shipment allows you to create shipments in PEAK™ programmatically, whether you need to generate BOL’s or want to pre-populate shipment details for order fulfillment.

Resource URL

QA: http(s)://qa-connect.ascentgl.com/v1/shipment/

Production: http(s)://connect.ascentgl.com/v1/shipment/

Parameters

Property NameRequiredFormatDefinition
companyNumberYCompany identifier supplied by Ascent
pickupDateYYYYY-MM-DDEarliest date the shipment is available for pickup
shipmentTypeY1 characterO == outbound, I == inbound, P == third-party
paymentTypeY1 characterP == pre-paid, C == collect
bolNumberN10 characters maximumBOL number for shipment
dockOpenTimeNEarliest time the shipment can be picked up on the pickupDate
dockCloseTimeNLatest time the shipment can be picked up on the pickupDate
specialInstructionsN255 characters maximumAny notes related to the shipment. This will appear on the BOL document
stopsYCollection of stop detailsSee below for the stop details. There must be 3 stops for each shipment - a Pickup, a Delivery and a Bill To
itemsYCollection of itemsSee below for item details
referencesNA collection of stringsThis can be used for any customer references needed, eg: PO Numbers
accessorialsNA collection of string providing accessorial codesSee below for the list of accepted accessorial codes

Stop Details

Property NameRequiredFormatDefinition
typeYSupported types: "Pickup", "Drop", "Bill To"
addressYan address detailSee below for address details

Address Details

Property NameRequiredFormatDefinition
nameYAddress name for the address
line1YStreet address line 1 for the address
line2YStreet address line 2 for the address
cityYCity name for the address
stateY2 charactersState/province code for the address
postalCodeY5 digit US Zip Code or 6 character Canadian postal codePostal code for the address
contactsYA collection of contact detailsSee below for contact details

Contact Details

Property NameRequiredFormatDefinition
nameYContact name
phoneY10 digit phone number.Contact phone number with area code - no extension
emailYvalid email addressContact email address

Item Details

Property NameRequiredFormatDefinition
descriptionY80 character maximum
lengthYdigits only
widthYdigits only
heightYdigits only
weightYdigits only
piecesYdigits only
nmfcClassYNMFC Class
nmfcItemNumberNNMFC Item Code
hazardousMaterialY1 characterAllowed values: "Y", "N"

Accessorial Codes

Accessorial CodeDefinition
ADDAdditional Charge
AFFAdditional after fuel charge
ALCHContains Alcohol
APPTAppointment Charge
ARNArrival Notice
BLNDBlind Shipment
BXNGBorder Crossing Fee
CODPCOD Prepaid
CODCCOD Collect
CONSConstruction Site Fee
CRBLCorrected BOL Fee
CSADCustoms Admin Fee
DICEContains Dry Ice
DTNTDetention Fee
FRKLForklift Service
FRZRFreezer Protection
FUELFuel Surcharge
GTEDGuaranteed Service
HAZMHaz Mat Fee
IACInspection of Shipment
INSDInside Delivery
INSPInside Pickup
INSUInsurance
LACDLimited Access Delivery
LACPLimited Access Pickup
LFGDLiftgate Destination
LFGPLiftgate Pickup
MARKMarking and Tagging
NOTFNotify
OVRDOver-Dimensional Freight
PRIOPriority Shipment
RECNReConsignment Fee
REDVRedelivery Fee
RESDResidential Delivery
RESPResidential Pick Up
SIGNDelivery Signature
SRTSSort and Segregate
SSHPSingle Shipment
STOPStop Off
STORStorage
TRSDTrade Show Delivery
TRSPTrade Show Pickup
UNLDUnloading Fee
WTIWeight and Inspection
WTVWeight Verification Fee

Request/Response Examples

JSON

JSON Shipment Request

{
  "authToken": null,
  "accessToken": "Qw6+V7EYs/FsXCxK5lS+1C8pj8wZ7LQ5aPfa80bxpd7twmlJb5wLw=",
  "shipmentNumber": "123123",
  "customerNumber": "ATL10",
  "shipmentType": "O",
  "paymentType": "P",
  "shipmentDate": "2019-02-14",
  "bolNumber": "0080000890",
  "specialInstructions": "2019-01-28",
  "collectAmount": 0.0,
  "insuredAmount": 0.0,
  "commodities": [
    {
      "nmfcItemNumber": "161870-04",
      "nmfcClass": "50",
      "description": "",
      "itemCount": "1",
      "weight": "250",
      "length": "24",
      "width": "24",
      "height": "24",
      "declaredValue": 0.0,
      "packageType": null,
      "hazardousMaterial": false,
      "hazardousDetails": null
    }
  ],
  "pallets": [
    {
      "description": "00000000001000002010",
      "palletCount": "1",
      "weight": "250",
      "length": "36",
      "width": "36",
      "height": "36",
      "declaredValue": 0.0,
      "palletWeight": "0",
      "hazardousMaterial": false,
      "hazardousDetails": null
    }
  ],
  "accessorials": null,
  "stops": [
    {
      "type": "Pickup",
      "address": {
        "name": "Pickup Company",
        "line1": "Address Line 1",
        "line2": "",
        "city": "CHARLOTTE",
        "state": "NC",
        "postalCode": "28273-3713",
        "country": "US",
        "contacts": [
          {
            "contactName": "Contact Name",
            "contactPhone": "5555555555",
            "contactEmail": "name@mail.com"
          },
          {
            "contactName": "Contact Name1",
            "contactPhone": "5555555555",
            "contactEmail": "Name1@mail.com"
          }
        ]
      }
    },
    {
      "type": "Drop",
      "address": {
        "name": "Drop Company Name",
        "line1": "Address Line 1",
        "line2": "",
        "city": "BAY MINETTE",
        "state": "AL",
        "postalCode": "36507",
        "country": "US",
        "contacts": [
          {
            "contactName": "Drop Contact Name",
            "contactPhone": "55555555555",
            "contactEmail": "Name2@mail.com"
          }
        ]
      }
    },
    {
      "type": "Bill To",
      "address": {
        "name": "Bill to Company Name",
        "line1": "Address Line 1",
        "line2": "",
        "city": "BAY MINETTE",
        "state": "AL",
        "postalCode": "36507",
        "country": "US",
        "contacts": [
          {
            "contactName": "Bill to Conact Name",
            "contactPhone": "5555555555",
            "contactEmail": "name3@mail.com"
          }
        ]
      }
    }
  ],
  "references": null,
  "priceSheet": {
    "carrierId": "(85720847750,3840,0)",
    "contractId": "",
    "scac":"SEFL",
    "type":"Cost"
  }
}

JSON Shipment Request


{"PRO":"636857434236484538","shipmentNumber":
null,"status":"Pending","customers":null,"errors":
[{"code":"REQUEST_ID","message":
"636857434212917859"}],"primaryReference":"3000589939"}
XML

XML Shipment Request

<?xml version="1.0" encoding="UTF-8"?>
<ShipmentRequest>
    <accessToken>Qw6+V7EYs/FsXCxK5lmB8uxMelJb5wLw=</accessToken>
    <shipmentNumber>123123</shipmentNumber>
    <customerNumber>ATL10</customerNumber>
    <shipmentType>O</shipmentType>
    <paymentType>P</paymentType>
    <shipmentDate>2019-02-14</shipmentDate>
    <bolNumber>0080000890</bolNumber>
    <specialInstructions>2019-01-28</specialInstructions>
    <collectAmount>0</collectAmount>
    <insuredAmount>0</insuredAmount>
    <commodities>
        <nmfcItemNumber>161870-04</nmfcItemNumber>
        <nmfcClass>50</nmfcClass>
        <description></description>
        <itemCount>1</itemCount>
        <weight>250</weight>
        <length>24</length>
        <width>24</width>
        <height>24</height>
        <hazardousMaterial>false</hazardousMaterial>
    </commodities>
    <pallets>
        <description>00000000001000002010</description>
        <palletCount>1</palletCount>
        <weight>250</weight>
        <length>36</length>
        <width>36</width>
        <height>36</height>
        <palletWeight>0</palletWeight>
        <hazardousMaterial>false</hazardousMaterial>
    </pallets>
    <stops>
        <type>Pickup</type>
        <address>
            <name>Pickup Company Name</name>
            <line1>Address Line 1</line1>
            <line2></line2>
            <city>CHARLOTTE</city>
            <state>NC</state>
            <postalCode>28273</postalCode>
            <country>US</country>
            <contacts>
                <contactName>Contact Name</contactName>
                <contactPhone>5555555555</contactPhone>
                <contactEmail>name@mail.com</contactEmail>
            </contacts>
            <contacts>
                <contactName>Contact Name 1</contactName>
                <contactPhone>5555555555</contactPhone>
                <contactEmail>name1@mail</contactEmail>
            </contacts>
        </address>
    </stops>
    <stops>
        <type>Drop</type>
        <address>
            <name>Drop Company Name</name>
            <line1>Address Line 1</line2>
            <city>BAY MINETTE</city>
            <state>AL</state>
            <postalCode>36507</postalCode>
            <country>US</country>
            <contacts>
                <contactName>Contact Name 2</contactName>
                <contactPhone>5555555555</contactPhone>
                <contactEmail>name2@mail.com</contactEmail>
            </contacts>
        </address>
    </stops>
    <stops>
        <type>Bill To</type>
        <address>
            <name>Bill Company Name</name>
            <line1>Address Line 1</line1>
            <line2></line2>
            <city>BAY MINETTE</city>
            <state>AL</state>
            <postalCode>36507</postalCode>
            <country>US</country>
            <contacts>
                <contactName>Contact Name 3</contactName>
                <contactPhone>5555555555</contactPhone>
                <contactEmail>name3@mail.com</contactEmail>
            </contacts>
        </address>
    </stops>
 <pricesheet>
                <carrierId>(85720847750,3840,0)</carrierId>
                <contractId>(87493647813,3023,0)</contractId>
                <scac>SEFL</scac>
                <type>Cost</type>
            </pricesheet>
</ShipmentRequest>

XML Shipment Response

<ShipmentResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <PRO>636857434236484538</PRO>
    <status>Pending</status>
    <errors>
        <code>REQUEST_ID</code>
        <message>636857434212917859</message>
    </errors>
    <primaryReference>3000589939</primaryReference>
e.xml</ShipmentResponse>
Menu