Go to ABF Home Page
About ABF Services Coverage eCommerce Resource Center  help contacts suggestion print e-mail  save
Go to ABF Home Page
 To use the advanced features of abf.com -> Logon | Register | Benefits
eCenter Tools
eCommerce
eCenter Online Tools
ABF Anywhere
Shipping Charges Calculator
Tracking by E-mail
Document Retrieval by E-mail
eInvoicing
eProvider Network
Transparent Direct Links
Register
Bill of Lading
Pickup Request
BOL/Pickup Request
Document Retrieval
Rate Quotation
Tracking
Transit Times
Q-Family of Electronic Services

This type of server to server connection enables you to request a pickup and create a bill of lading and/or shipping labels by making a direct call to the ABF server from your server. The ABF server will return an XML document that you can parse to extract the information you need. The following is the XML data-type definition for the document returned by this type of bill of lading and pickup request:


<ABF>   ABF Pickup Request and Bill of Lading Data Type Definition.
  <CONFIRMATION>   Confirmation returned for successful pickup request. This section will only be returned when there are no errors in originally entered information (NUMERRORS = 0). "WWW0000000" will be returned if you are testing (Test=Y).
  <DOCUMENT>   Path of Bill of Lading created. This section will only be returned when there are no errors in originally entered information (NUMERRORS = 0).
  <LABELDOCUMENT>   Path of Shipping Label Document created. This section will only be returned when there are no errors in originally entered information (NUMERRORS = 0).
  <PROLABELDOCUMENT>   Path of Pro Number Label Document created. This section will only be returned when there are no errors in originally entered information (NUMERRORS = 0).
  <SHIP>   Shipper Information. This section will be returned if there has been an error in the shipper's address/location information.
    <CITYCODEINFO>   City Code Information.
    <SIMILARCITIES>   Similar Cities.
    <CITYRECORD>   City Record. This section may contain listings of locations comparable to the shipper information originally entered.
    <CITY>   Possible city intended for the shipper/origin.
    <STATE>   Possible state intended for the shipper/origin.
    <ZIP>   Possible zip code intended for the shipper/origin.
    <STATION>   The 3-digit ABF assigned station number.
    <SERVICE>   Service.
    </CITYRECORD>  
    <NUMRECORDS>   Number of City Records.
    <NUMUNIQUECITIES>   Number of Unique Cities.
    </SIMILARCITIES>  
    <SIMILARZIPS>   Similar Zips.
    <ZIPRECORD>   Zip Record. This section may contain listings of locations comparable to the shipper information originally entered.
    <CITY>   Possible city intended for the shipper/origin.
    <STATE>   Possible state intended for the shipper/origin.
    <ZIP>   Possible zip code intended for the shipper/origin.
    <STATION>   The 3-digit ABF assigned station number.
    <SERVICE>   Service.
    </ZIPRECORD>  
    <NUMRECORDS>   Number of Zip Records.
    <NUMUNIQUEZIPS>   Number of Unique Zips.
    </SIMILARZIPS>  
    <ZIPINFO>   Zip Code Information. This section shows the address/location information that was originally entered.
    <CITY>   Originally entered city of the shipper.
    <STATE>   Originally entered state of the shipper.
    <ZIP>   Originally entered zip of the shipper.
    <STATION>   The 3-digit ABF assigned station number.
    <FIPS>   FIPS.
    </ZIPINFO>  
    <NUMERRORS>   Number of Errors.
    </CITYCODEINFO>  
    <DROPDOWN>   This section contains HTML code needed to populate a drop down list box of <CITYRECORD> and <ZIPRECORD> entries.
  </SHIP>  
  <CONS>   Consignee Information. This section will be returned if there has been an error in the consignee's address/location information. The information contained within the <CONS> tags follows the same format as that contained within the <SHIP> tags.
  </CONS>  
  <TPB>   Third Party Information. This section will be returned if there has been an error in the third party's address/location information. The information contained within the <TPB> tags follows the same format as that contained within the <SHIP> tags.
  </TPB>  
  <COD>   COD Remit-To Information. This section will be returned if there has been an error in the COD remit-to's address/location information. The information contained within the <COD> tags follows the same format as that contained within the <SHIP> tags.
  </COD>  
  <NUMERRORS>   Number of errors associated with request. Must be "0" to return confirmation number.
  <ERROR>   Group of errors. This section will only be returned if NUMERRORS > 0.
Click here for a list of possible error codes and messages.
    <ERRORCODE>   Code associated with error.
    <ERRORMESSAGE>   Message assigned to error code.
  </ERROR>  
</ABF>  

To call the XML pickup request and bill of lading from your server, you must be using an XML parser. You can use one of the following two methods:

1. Append parameters to the URL.

To use this method, initialize the parser and set URL to the following:

Note: Required variables are in Red. All other variables are optional.
Start with this URL: http://www.abfs.com/xml/bolpkupxml.asp?DL=2
 
Add the following variables:
Account
Information
AcctNum Your 6-digit ABF account number.
Password Your 6-character ABF password.
  Test "Y" if you are testing.
 
Requester
Affiliation
RequesterType Who the requester is:
"1" for Shipper.
  "2" for Consignee.
  "3" for Third Party.
  PayTerms Payment Terms:
  "P" for prepaid.
  "C" for collect.
 
Requester
Information
RequesterName Requester contact name.
RequesterPhone Requester phone number.
  RequesterPhoneExt Requester phone extension.
  RequesterEmail Requester e-mail address.
  RequesterFax Requester fax number.
 
Shipper
Information
ShipContact Shipper contact.
ShipName Shipper full name.
  ShipNamePlus Shipper name plus.
  ShipAddress Shipper address.
  ShipCity Shipper city.
  ShipState Shipper state.
  ShipZip Shipper zip or postal code.
  ShipCountry Shipper country.
  ShipPhone Shipper phone number.
  ShipPhoneExt Shipper phone extension.
  ShipFax Shipper fax number.
  ShipEmail Shipper e-mail address.
 
Consignee
Information
ConsContact Consignee contact.
ConsName Consignee full name.
  ConsNamePlus Consignee name plus.
  ConsAddress Consignee address.
  ConsCity Consignee city.
  ConsState Consignee state.
  ConsZip Consignee zip or postal code.
  ConsCountry Consignee country.
  ConsPhone Consignee phone number.
  ConsPhoneExt Consignee phone extension.
  ConsFax Consignee fax number.
  ConsEmail Consignee e-mail address.
 
Third Party
Information
TPBContact Third Party contact.
TPBName Third Party full name.
  TPBNamePlus Third Party name plus.
  TPBAddress Third Party address.
  TPBCity Third Party city.
  TPBState Third Party state.
  TPBZip Third Party zip or postal code.
  TPBCountry Third Party country.
  TPBPhone Third Party phone number.
  TPBPhoneExt Third Party phone extension.
  TPBFax Third Party fax number.
  TPBEmail Third Party e-mail address.
 
COD Remit-To
Information
CODAmt COD Remit-To amount.
CODFee COD Remit-To fee terms:
  "P" for prepaid.
  "C" for collect.
  CCAFlag "Y" if Company Check Acceptable.
  CODName COD Remit-To full name.
  CODAddress COD Remit-To address.
  CODCity COD Remit-To city.
  CODState COD Remit-To state.
  CODZip COD Remit-To zip or postal code.
  CODCountry COD Remit-To country.
 
Commodity Lines
(Enter up to 15)
HN1 (to HN15) Number of Handling Units of commodity.
HT1 (to HT15) Type of Handling Units of commodity.
  PN1 (to PN15) Number of Packages of commodity.
  PT1 (to PT15) Type of Packages of commodity.
  WT1 (to WT15) Weight of commodity.
  CL1 (to CL15) Class of commodity.
  NMFC1 (to NMFC15) NMFC Item Number of commodity.
  SUB1 (to SUB15) NMFC Sub Number of commodity.
  CB1 (to CB15) Cube of commodity in cubic feet.
  Desc1 (to Desc15) Description of commodity.
  HZ1 (to HZ15) "Y" if a commodity contains hazardous materials.
  HZCL1 (to HZCL15) Hazardous materials class.
  HZUN1 (to HZUN15) Hazardous materials UN/NA number.
  HZPH1 (to HZPH15) Hazardous materials emergency contact phone number.
  HZEXT1 (to HZEXT15) Hazardous materials emergency contact phone extension.
 
Shipment
Specifics
ShipDate Shipping date (MM/DD/YYYY).
Pronumber Pro Number.
  CheckDigit Check Digit for the Pro Number.
  ProAutoAssign "Y" to have your Pro Number auto-assigned.
  Instructions Special instructions about the shipment.
  PickupDate Date shipment will be available for pickup (MM/DD/YYYY). ShipDate will replace PickupDate if both passed in.
  AT Time shipment will be available for pickup. Time should be military in half-hour increments (HH:MM).
  OT Time pickup location will open. Time should be military in half-hour increments (HH:MM).
  CT Time pickup location will close. Time should be military in half-hour increments (HH:MM).
  CallShipper "Y" if ABF should call shipper to arrange pickup.
  LF Total linear footage needed for shipment.
 
Reference
Numbers
Bol Bill of Lading number for the shipment.
PO1 (to PO10) Purchase Order number, enter up to 10.
  POPiece1 (to POPiece10) Purchase Order pieces, enter up to 10.
  POWeight1 (to POWeight10) Purchase Order weight, enter up to 10.
  PODept1 (to PODept10) Purchase Order department, enter up to 10.
  CRN1 (to CRN10) Customer Reference Number, enter up to 10.
 
Copy / Confirm PkupCopyShip "Y" to e-mail a copy of pickup request to Shipper.
PkupCopyCons "Y" to e-mail a copy of pickup request to Consignee.
  PkupCopyTPB "Y" to e-mail a copy of bill of lading to Third Party.
  PkupCopyAdd Additional e-mail address to send a copy of pickup request to.
  PkupConfirmShip "Y" to e-mail a copy of pickup confirmation to Shipper.
  PkupConfirmCons "Y" to e-mail a copy of pickup confirmation to Consignee.
  PkupConfirmTPB "Y" to e-mail a copy of pickup confirmation to Third Party.
  PkupConfirmAdd Additional e-mail address to send a confirmation of pickup request to.
  BolCopyShip "Y" to e-mail a copy of bill of lading to Shipper.
  BolCopyCons "Y" to e-mail a copy of bill of lading to Consignee.
  BolCopyTPB "Y" to e-mail a copy of bill of lading to Third Party.
  BolCopyAdd Additional e-mail address to send a copy of bill of lading to.
 
Additional Service
Options
Pickup Options:
Acc_GRD_PU "Y" for Liftgate-Ground Pickup option. 
  Acc_IPU "Y" for Inside Pickup option. 
  Acc_LAP "Y" for Limited Access Pickup option. 
  LAPType Type of Limited Access Pickup. Required for Acc_LAP:
  "C" for Church pickup.
  "M" for Military Site pickup.
  "S" for School pickup.
  "U" for Mini-Storage pickup.
  "O" for Other type of limited access pickup.
  Acc_RPU "Y" for Residential Pickup option. 
Delivery Options:
Acc_CSD "Y" for Construction Site Delivery option. 
  Acc_DELON "Y" for Delivery On option. 
  Acc_GRD_DEL "Y" for Liftgate-Ground Delivery option. 
  Acc_IDEL "Y" for Inside Delivery option. 
  Acc_LAD "Y" for Limited Access Delivery option. 
  LADType Type of Limited Access Delivery. Required for Acc_LAD:
  "C" for Church delivery.
  "M" for Military Site delivery.
  "S" for School delivery.
  "U" for Mini-Storage delivery.
  "O" for Other type of limited access delivery.
  Acc_RDEL "Y" for Residential Delivery option. 
  Acc_FLATBD "Y" for Flatbed Delivery option. 
Other Options:
Acc_ARR "Y" for Arrival Notification option. 
  Acc_CAP "Y" for Capacity Load option. 
  Acc_COD "Y" for COD (collect for goods) option. 
  CODAmount Amount to collect for goods (in U.S. dollars). Required for Acc_COD.
  Acc_BOND "Y" for Customs Or In-Bond Freight option. 
  Acc_ELC "Y" for Excess Liability Charge option. 
  DeclaredValue Declared value of excess liability charge (in U.S. dollars). Required for Acc_ELC.
  Acc_OD "Y" for Over-Dimension option. 
  Acc_SS "Y" for Single Shipment option. 
  Acc_SEG "Y" for Sort and Segregate / Special Handling option. 
  SegPieces Number of Pieces to Sort and Seg. Required for Acc_SEG.
  Acc_TRPACK "Y" for TruckPack Shipment option. 
  TPBoxes Number of TruckPack boxes. Required for Acc_TRPACK.
 
Document
Information
FileFormat File format for the bill of lading / shipping labels / pro number labels:
"A" for Adobe Acrobat.
  "R" for Rich Text format.
  "H" for HTML format.
  InkJetPrinter "Y" if using an inkjet printer.
  LabelNum Number of Shipping Labels to create.
  LabelStartNum Starting page position of Shipping Labels.
Click here to view the Avery 5264 standard page layout.
  ProLabelNum Number of Pro Number Labels to create.
  ProLabelStartNum Starting page position of Pro Number Labels.
Click here to view the Avery 5160 standard page layout.
 
Example: http://www.abfs.com/xml/bolpkupxml.asp?DL=2
&AcctNum=999999&Password=test01&Test=Y
&RequesterType=1&PayTerms=P&RequesterName=JOHN+BLACK
&RequesterPhone=5555555555&RequesterPhoneExt=5555
&RequesterEmail=REQUESTER@ABF.COM
&ShipContact=BOB+SMITH&ShipName=TEST+CLIENT
&ShipNamePlus=BIG+CORPORATION&ShipAddress=123+MAIN+STR
&ShipCity=FORT+SMITH&ShipState=AR&ShipZip=72906
&ShipCountry=US&ShipPhone=5012222222&ShipPhoneExt=2222
&ShipFax=5012222233&ShipEmail=SHIPPER@ABF.COM
&ConsContact=BILL+JONES&ConsName=ANOTHER+COMPANY
&ConsNamePlus=VERY+BIG+CORPORATION
&ConsAddress=321+BROAD+AVE&ConsCity=LAWRENCE
&ConsState=KS&ConsZip=66044&ConsCountry=US
&ConsPhone=7853333333&ConsPhoneExt=3333&ConsFax=7853333344
&ConsEmail=CONSIGNEE@ABF.COM&TPBContact=DICK+JOE
&TPBName=THIRD+CLIENT&TPBNamePlus=SMALL+CORPORATION
&TPBAddress=456+LEXINGTON+AVE&TPBCity=MIAMI&TPBState=FL
&TPBZip=33106&TPBCountry=US&TPBPhone=3055555555
&TPBPhoneExt=5555&TPBFax=3055555566
&TPBEmail=THIRDPARTY@ABF.COM&CODAmt=100
&CODFee=P&CCAFlag=Y&CODName=MIKE+HUTCH
&CODAddress=876+SOUTH+23RD+STR&CODCity=DETROIT&CODState=MI
&CODZip=48238&CODCountry=US&HN1=100&HT1=PLT&PN1=20&PT1=BX
&WT1=1000&CL1=65&NMFC1=123456&SUB1=78&CB1=321&HZ1=N
&Desc1=MISC+AUTO+PARTS&PickupDate=01/02/2007&AT=01:00
&Pronumber=123456789&CheckDigit=0&Instructions=DO+NOT+STACK
&Bol=123BOL45&PO1=1231235435&POPiece1=100
&POWeight1=1000&CRN1=1234567890&PkupCopyShip=Y
&PkupCopyAdd=ADDITIONALPICKUPCOPY@ABF.COM
&BolCopyShip=Y&BolCopyAdd=ADDITIONALBOLCOPY@ABF.COM
&Acc_ARR=Y&Acc_COD=Y&CODAmount=100&FileFormat=A
&InkJetPrinter=Y&LabelNum=6&LabelStartNum=1
&ProLabelNum=10&ProLabelStartNum=1
 

2. Refer to an XML parameter file.

To use this method, initialize the parser and set URL to the following:

Note: Required variables are in Red. All other variables are optional.
Start with this URL: http://www.abfs.com/xml/bolpkupxml.asp?DL=2
 
Add the following variables:
  ParameterFile The URL of an XML file with parameter list.
  AcctNum Your 6-digit ABF account number.
  Password Your 6-character ABF password.
  Test "Y" if you are testing and do not want to request an actual pickup.
 
Example: http://www.abfs.com/xml/bolpkupxml.asp?DL=2
&ParameterFile=
http://www.abfs.com/ecommerce/tlinks/mybolpickup.xml
&AcctNum=999999&Password=TEST01&Test=Y

List the other parameters in the XML file to which you refer in the URL. See the example of an XML parameter file below or click here to view it in XML format.

[select all]



Click here for more information on this server to server method.

For more information on XML authoring, parsers, specifications, and additional resources, check out the XML section of the Web Developer's Virtual Library.

All Rights Reserved | Terms of Use | Privacy Policy