NameDescriptionTypeAdditional information
Logon

Required field, up to 8 characters in length

string

None.

Pass

Required field

string

None.

PickupDate

Required: Enter a properly formatted pickup date, in MM/DD/YYYY or MM-DD-YYYY format

string

None.

ReadyByTime

Optional: Specify the time that this shipment will be available for pickup. Format the entry as HH:MM where HH=hours in 24 hour format and MM=minutes. (e.g. 16:30 to represent 4:30PM)

string

None.

ClosingTime

Optional: Specify the ending time for the pickup window. Format the entry as HH:MM where HH=hours in 24 hour format and MM=minutes. (e.g. 19:00 to represent 7:00PM)

string

None.

PPDorCOL

Required field; fixed length of 3 characters; Use PPD for prepaid or COL for collect shipments (any other entry will be treated as PPD)

string

None.

ShipperCode

Optional: Enter the code assigned to the pickup location, if known (up to 8 characters). Shipper Codes can be retrieved from the system via the AccountLookup API if desired, otherwise leave blank if NOT known, and the code used for Logon to this Web Service will be used in its place.

string

None.

ShipperName

Required: Enter the name (up to 30 characters) for the location where this freight is to be picked up.

string

None.

ShipperAddress

Required: Enter the first address line (up to 30 characters) for the location where this freight is to be picked up.

string

None.

ShipperCity

Required: Enter the city name (up to 30 characters) for the location where this freight is to be picked up.

string

None.

ShipperState

Required: Enter the state/province abbreviation (fixed length of 2 characters) for the location where this freight is to be picked up.

string

None.

ShipperZip

Required: Enter the zip/postal code (5 digits for US Zips, 6 digits with no spaces for Canadian postal codes) for the location where this freight is to be picked up.

string

None.

ShipperContact

Optional: Enter shipper contact information for this pickup request in the form of a name or email address (up to 30 characters)

string

None.

ShipperPhone

Optional: Enter shipper telephone information for this pickup request. (Can support more than 1 number in a field that supports up to 30 characters)

string

None.

ConsigneeCode

Optional: Enter the code assigned to the delivery location, if known (up to 8 characters). Consigneer Codes can be retrieved from the system via the AccountLookup API if desired, otherwise leave blank if NOT known, and a generic code will be substituted in its place.

string

None.

ConsigneeName

Required: Enter the name that represents the delivery location for this shipment (up to 30 characters)

string

None.

ConsigneeAddress

Required: Enter the first address line (up to 30 characters) for the location where this freight is to be delivered.

string

None.

ConsigneeCity

Required: Enter the city name (up to 30 characters) for the location where this freight is to be delivered.

string

None.

ConsigneeState

Required: Enter the state/province abbreviation (fixed length of 2 characters) for the location where this freight is to be delivered.

string

None.

ConsigneeZip

Required: Enter the zip/postal code (5 digits for US Zips, 6 digits with no spaces for Canadian postal codes) for the location where this freight is to be delivered.

string

None.

ConsigneeContact

Optional: Enter consignee contact information for this pickup request in the form of a name or email address (up to 30 characters)

string

None.

ConsigneePhone

Optional: Enter consignee telephone information for this pickup request.

string

None.

BOL

Optional: Enter the Bill of Lading reference number for this shipment, if known. (up to 20 characters)

string

None.

PONUM

Optional: Enter the Purchase Order reference number for this shipment, if known. (up to 20 characters)

string

None.

SID

Optional: Enter the Shipper's Identifying reference number (SID) for this shipment, if known. (up to 30 characters)

string

None.

QuoteNum

Optional: Enter the numeric quote number that was previously assigned to this shipment from a Quote Request. Leave blank or enter a zero '0' if not applicable. Valid entries range between 1 and 2,147,483,647.

integer

None.

CODAmountInCents

Optional, numeric; Enter the number zero '0' if this shipment is NOT COD; Otherwise, enter the COD amount of the shipment in cents (e.g. $952.34 is entered as 95234)

integer

None.

Comments

Optional, alphanumeric; Enter any additional comments or special instructions associated with this pickup request.

string

None.

FreightList

Required data structure - drill down for more details; At least one entry is required for this freight list

Collection of FreightDetail

None.

AccessorialList

Optional data structure - drill down for more details; This is used to stipulate accessorial requirements (with published accessorial codes) for the shipment

Collection of Accessorial

None.