ABF Freight System, Inc. - Transparent Links, Pickup Requests

This type of server to server connection enables you to make a pickup request 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 pickup request:


`<ABF>`						ABF Pickup Request 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).
	`<SHIP>`					Shipper Information. This section will only be returned if there has been an error in the shipper's address/location information.
		`<CITYCODEINFO>`				City Code Information.
			`<SIMILARCITIES>`			Similar Cities. This section contains listings of <CITYRECORD> locations comparable to the shipper information originally entered.
				`<CITYRECORD>`		City Record.
					`<CITY>`	Possible city intended for the shipper.
					`<STATE>`	Possible state intended for the shipper.
					`<ZIP>`	Possible zip code intended for the shipper.
					`<STATION>`	The 3-digit ABF assigned station number.
					`<SERVICE>`	Service.
				`</CITYRECORD>`
				`<NUMRECORDS>`		Number of City Records in <SIMILARCITIES>.
				`<NUMUNIQUECITIES>`		Number of Unique Cities in <SIMILARCITIES>.
			`</SIMILARCITIES>`
			`<SIMILARZIPS>`			Similar Zips. This section contains listings of <ZIPRECORD> locations comparable to the shipper information originally entered.
				`<ZIPRECORD>`		Zip Record.
					`<CITY>`	Possible city intended for the shipper.
					`<STATE>`	Possible state intended for the shipper.
					`<ZIP>`	Possible zip code intended for the shipper.
					`<STATION>`	The 3-digit ABF assigned station number.
					`<SERVICE>`	Service.
				`</ZIPRECORD>`
				`<NUMRECORDS>`		Number of Zip Records in <SIMILARZIPS>.
				`<NUMUNIQUEZIPS>`		Number of Unique Zips in <SIMILARZIPS>.
			`</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 associated with shipper city code information.
		`</CITYCODEINFO>`
		`<DROPDOWN>`				This section contains HTML code needed to populate a drop down list box of <CITYRECORD> and <ZIPRECORD> entries.
		`<ADDRESSINFO>`				Address Information. This section contains listings of <ADDRESSRECORD> locations. This section will only be returned when the shipper's account location address is needed.
				`<ADDRESSRECORD>`		Address Record.
					`<LOC>`	Possible account location for the shipper.
					`<ADDRESS>`	Possible location address for the shipper.
				`</ADDRESSRECORD>`
				`<NUMADDRESSRECORDS>`		Number of Address Records in <ADDRESSINFO>.
		`</ADDRESSINFO>`
		`<ADDRESSDROPDOWN>`				Dropdown for address information. This section contains HTML code needed to populate a drop down list box of <ADDRESSRECORD> entries.
	`</SHIP>`
	`<CONS>`					Consignee Information. The information contained within the <CONS> tags follows the same format as that contained within the <SHIP> tags. This section will be returned if there has been an error in the consignee's address/location information.
	`</CONS>`
	`<TPB>`					Third Party Information. The information contained within the <TPB> tags follows the same format as that contained within the <SHIP> tags. This section will be returned if there has been an error in the third party's address/location information.
	`</TPB>`
	`<NUMERRORS>`					Number of errors associated with request. NUMERRORS must be "0" to get pickup confirmation number.
	`<ERROR>`					Group of errors. Click here for a list of possible error codes and messages. This section will only be returned when errors were found in originally entered information.
		`<ERRORCODE>`				Code associated with error.
		`<ERRORMESSAGE>`				Message assigned to error code.
	`</ERROR>`
`</ABF>`

To call the XML pickup request 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/pickupxml.asp?DL=2

Add the following variables:

Account
Information AcctNum Your abf.com User ID.

Password Your abf.com Password.

Test "Y" if you are testing and do not want to request an actual pickup.

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.

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.

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) Total 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.

Shipment
Specifics PickupDate Date shipment will be available for pickup (MM/DD/YYYY).

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.

Pronumber Pro Number.

CheckDigit Check Digit for the Pro Number.

LF Total linear footage needed for shipment.

Instructions Special instructions about the 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 pickup request 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.

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 Coverage option.

DeclaredValue Declared value of excess liability coverage (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.

Acc_BLKH "Y" for Secure Shipment Divider (bulkhead) option.

Example: http://www.abfs.com/xml/pickupxml.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
&HN1=100&HT1=PLT&PN1=20&PT1=BX&WT1=1000&CL1=65
&NMFC1=123456&SUB1=78&CB1=321&Desc1=MISC+AUTO+PARTS&HZ1=N
&PickupDate=3/16/2010&AT=01:00&OT=08:00&CT=05:00&LF=20
&Pronumber=123456789&CheckDigit=0&Instructions=DO+NOT+STACK
&Bol=123BOL45&PO1=1231235435&POPiece1=100&POWeight1=1000
&CRN1=1234567890&PkupCopyShip=Y&PkupCopyAdd=ADDITIONALCOPY@ABF.COM
&Acc_ARR=Y&Acc_COD=Y&CODAmount=100

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/pickupxml.asp?DL=2

Add the following variables:

ParameterFile The URL of an XML file with parameter list.

AcctNum Your abf.com User ID.

Password Your abf.com Password.

Test "Y" if you are testing and do not want to request an actual pickup.

Example: http://www.abfs.com/xml/pickupxml.asp?DL=2
&ParameterFile=http://www.abfs.com/ecommerce/tlinks/mypkup.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]

<?xml version ="1.0"?>

<REQUESTERTYPE>1</REQUESTERTYPE>
 <REQUESTERNAME>Requester Name</REQUESTERNAME>
 <REQUESTERPHONE>501-784-4444</REQUESTERPHONE>
 <REQUESTERPHONEEXT>4444</REQUESTERPHONEEXT>
 <REQUESTEREMAIL>REQUESTER@ABF.COM</REQUESTEREMAIL>

<SHIPCONTACT>Shipper Contact</SHIPCONTACT>
 <SHIPNAME>Shipper Name</SHIPNAME>
 <SHIPNAMEPLUS>Shipper Name Plus</SHIPNAMEPLUS>
 <SHIPADDRESS>Shipper Address</SHIPADDRESS>
 <SHIPCITY>Fort Smith</SHIPCITY>
 <SHIPSTATE>AR</SHIPSTATE>
 <SHIPZIP>72903</SHIPZIP>
 <SHIPCOUNTRY>US</SHIPCOUNTRY>
 <SHIPPHONE>501-784-1111</SHIPPHONE>
 <SHIPPHONEEXT>5555</SHIPPHONEEXT>
 <SHIPFAX>501-785-1111</SHIPFAX>
 <SHIPEMAIL>SHIPPER@ABF.COM</SHIPEMAIL>

<CONSCONTACT>Consignee Contact</CONSCONTACT>
 <CONSNAME>Consignee Name</CONSNAME>
 <CONSNAMEPLUS>Consignee Name Plus</CONSNAMEPLUS>
 <CONSADDRESS>Consignee Address</CONSADDRESS>
 <CONSCITY>Fort Smith</CONSCITY>
 <CONSSTATE>AR</CONSSTATE>
 <CONSZIP>72903</CONSZIP>
 <CONSCOUNTRY>US</CONSCOUNTRY>
 <CONSPHONE>501-784-2222</CONSPHONE>
 <CONSPHONEEXT>6666</CONSPHONEEXT>
 <CONSFAX>501-785-2222</CONSFAX>
 <CONSEMAIL>CONSIGNEE@ABF.COM</CONSEMAIL>

<TPBCONTACT>Third Party Contact</TPBCONTACT>
 <TPBNAME>Third Party Name</TPBNAME>
 <TPBNAMEPLUS>Third Party Name Plus</TPBNAMEPLUS>
 <TPBADDRESS>Third Party Address</TPBADDRESS>
 <TPBCITY>Fort Smith</TPBCITY>
 <TPBSTATE>AR</TPBSTATE>
 <TPBZIP>72903</TPBZIP>
 <TPBCOUNTRY>US</TPBCOUNTRY>
 <TPBPHONE>501-784-3333</TPBPHONE>
 <TPBPHONEEXT>7777</TPBPHONEEXT>
 <TPBFAX>501-785-3333</TPBFAX>
 <TPBEMAIL>THIRDPARTY@ABF.COM</TPBEMAIL>

<COMMODITIES>
 <COMMODITY>
 <HANDLINGNO>100</HANDLINGNO>
 <HANDLINGTYPE>BAG</HANDLINGTYPE>
 <PACKAGENO>200</PACKAGENO>
 <PACKAGETYPE>BDL</PACKAGETYPE>
 <WEIGHT>200</WEIGHT>
 <CLASS>50</CLASS>
 <NMFC>100000</NMFC>
 10
 <CUBE>30</CUBE>
 <DESC>Miscellaneous auto parts and related accessories</DESC>
 <HAZMAT>Y</HAZMAT>
 </COMMODITY>
 <COMMODITY>
 <HANDLINGNO>200</HANDLINGNO>
 <HANDLINGTYPE>BKT</HANDLINGTYPE>
 <PACKAGENO>200</PACKAGENO>
 <PACKAGETYPE>BL</PACKAGETYPE>
 <WEIGHT>300</WEIGHT>
 <CLASS>60</CLASS>
 <NMFC>200000</NMFC>
 20
 <CUBE>40</CUBE>
 <DESC>Miscellaneous parts and related accessories</DESC>
 <HAZMAT>Y</HAZMAT>
 </COMMODITY>
 <COMMODITY>
 <HANDLINGNO>300</HANDLINGNO>
 <HANDLINGTYPE>BLKH</HANDLINGTYPE>
 <PACKAGENO>400</PACKAGENO>
 <PACKAGETYPE>BRL</PACKAGETYPE>
 <WEIGHT>400</WEIGHT>
 <CLASS>70</CLASS>
 <NMFC>300000</NMFC>
 30
 <CUBE>50</CUBE>
 <DESC>Misc industrial parts and related accessories</DESC>
 <HAZMAT>N</HAZMAT>
 </COMMODITY>
 <COMMODITY>
 <HANDLINGNO>400</HANDLINGNO>
 <HANDLINGTYPE>BSK</HANDLINGTYPE>
 <PACKAGENO>500</PACKAGENO>
 <PACKAGETYPE>BX</PACKAGETYPE>
 <WEIGHT>600</WEIGHT>
 <CLASS>70</CLASS>
 <NMFC>400000</NMFC>
 40
 <CUBE>80</CUBE>
 <DESC>Sheet metal</DESC>
 <HAZMAT>Y</HAZMAT>
 </COMMODITY>
 <COMMODITY>
 <HANDLINGNO>500</HANDLINGNO>
 <HANDLINGTYPE>CHT</HANDLINGTYPE>
 <PACKAGENO>600</PACKAGENO>
 <PACKAGETYPE>CL</PACKAGETYPE>
 <WEIGHT>700</WEIGHT>
 <CLASS>80</CLASS>
 <NMFC>500000</NMFC>
 50
 <CUBE>90</CUBE>
 <DESC>Books and periodicals</DESC>
 <HAZMAT>Y</HAZMAT>
 </COMMODITY>
 </COMMODITIES>

<PAYMENTTERMS>P</PAYMENTTERMS>
 <PICKUPDATE>3/16/2010</PICKUPDATE>
 <AVAILABLETIME>01:00</AVAILABLETIME>
 <OPENTIME>08:00</OPENTIME>
 <CLOSETIME>05:00</CLOSETIME>
 <PRONUMBER>123456789</PRONUMBER>
 <CHECKDIGIT>0</CHECKDIGIT>
 <LINEARFEET>5</LINEARFEET>
 <CALLSHIPPER>Y</CALLSHIPPER>
 <INSTRUCTIONS>Special Instructions.</INSTRUCTIONS>

<REFNUMS>
 <REFNUM>
 <PO>PONum1</PO>
 <POPIECE>POPiece1</POPIECE>
 <POWEIGHT>POWeight1</POWEIGHT>
 <PODEPT>PODept1</PODEPT>
 <CRN>CRNum1</CRN>
 </REFNUM>
 <REFNUM>
 <PO>PONum2</PO>
 <POPIECE>POPiece2</POPIECE>
 <POWEIGHT>POWeight2</POWEIGHT>
 <PODEPT>PODept2</PODEPT>
 <CRN>CRNum2</CRN>
 </REFNUM>
 <REFNUM>
 <PO>PONum3</PO>
 <POPIECE>POPiece3</POPIECE>
 <POWEIGHT>POWeight3</POWEIGHT>
 <PODEPT>PODept3</PODEPT>
 <CRN>CRNum3</CRN>
 </REFNUM>
 </REFNUMS>

<ADDITIONALSERVICES>
 <ADDITIONALSERVICE>ACC_GRD_PU</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_IPU</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_LAP</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_RPU</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_CSD</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_DELON</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_GRD_DEL</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_IDEL</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_LAD</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_RDEL</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_ARR</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_CAP</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_COD</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_ELC</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_OD</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_SS</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_SEG</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_TRPACK</ADDITIONALSERVICE>
 <ADDITIONALSERVICE>ACC_BOND</ADDITIONALSERVICE>
 </ADDITIONALSERVICES>

<PKUPCOPYSHIP>Y</PKUPCOPYSHIP>
 <PKUPCOPYCONS>Y</PKUPCOPYCONS>
 <PKUPCOPYTPB>Y</PKUPCOPYTPB>
 <PKUPCOPYADD>ADDITIONALCOPY@ABF.COM</PKUPCOPYADD>
 <PKUPCONFIRMSHIP>Y</PKUPCONFIRMSHIP>
 <PKUPCONFIRMCONS>Y</PKUPCONFIRMCONS>
 <PKUPCONFIRMTPB>Y</PKUPCONFIRMTPB>
 <PKUPCONFIRMADD>ADDITIONALCONFIRM@ABF.COM</PKUPCONFIRMADD>

</ABFPICKUP>

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.