Pickup Request Web Service

The pickup request service lets Estes customers request a freight pickup and cancel or update existing pickup requests. There is also a service operation for retrieving all pickup information.

• Authentication
• WSDL
• shipper/shipperAddress
• shipper/accountCode
• requestAction
• paymentTerms
• pickupStartTime
• pickupEndTime
• hazmatFlag
• expeditedCode
• whoRequested
• respondByTime
• trailer/trailerInfo/length
• trailer/trailerInfo/type
• referenceNumbers/referenceNumber/referenceInfo/type
• commodities/commodity/commodityInfo/code
• commodities/commodity/commodityInfo/packageCode
• commodities/commodity/commodityInfo/hazmat/hazmatCode
• commodities/commodity/commodityInfo/hazmat/hazmatFlag
• comments/comment/commentInfo/type
• addresses/address/addressInfo/addressType
• contacts/contact/contactInfo/contactType
• contacts/contact/contactInfo/notificationMethod
• notifications/notification/notificationInfo/type
• */*/operation/operationType

Authentication

You must have a valid My Estes username and password to use the web service. These credentials are sent in the HTTP headers with BASIC AUTH. If you don’t yet have a My Estes account, you may register for one on the My Estes signup page. Please note that your Estes account number is not required for authentication because it’s tied to your My Estes profile.

WSDL

The WSDL describes the valid operations for the web service and serves as a template for the requests and responses for each operation. The pickup web service has operations to create, update, cancel or view an Estes pickup request. Send the data required for the operation in the SOAP request. Samples of each request are listed in the following pages. The question marks are placeholders and not meant to represent real data.

WSDL Production

https://api.estes-express.com/tools/pickup/request/v1.0?wsdl

WSDL Test

https://apitest.estes-express.com/tools/pickup/request/v1.0?wsdl

Operations

• Cancel - cancel an existing pickup request
• Create - create a new pickup request
• Retrieve - retrieve pickup request information
• Update - update existing pickup information

shipper/shipperAddress

This is the address of the pickup location. Although it’s optional, either it or the accountCode must be indicated. If an accountCode is provided, the shipper address (pickup location) is pulled from the Estes account master by the account code. If an address is provided in addition to the account code, the address associated with the account code will override the information provided in the shipperAddress element.

requestAction

This is the pickup action to perform. If the request is for Estes to pick up a full trailer, choose HE (to indicate empty) or HL (to indicate loaded). If you need Estes to drop off an empty trailer, choose SE. If the request is for a pickup of freight from your dock that is not a trailer-load, then pass LL (or don’t pass this element, and it will default to LL). If Estes must call to set up an appointment before arriving, then pass AP. Valid values are listed below:

• AP — Appointment required
• HE — LTL hook empty
• HL — LTL hook loaded
• LL — LTL live load [default]
• SE — LTL spot/drop empty

paymentTerms

These are the requested payment terms to apply to any resulting shipments picked up. Valid values include:

• COL — Collect
• PPD — Prepaid

pickupStartTime

This is a 4-digit time with a 2-digit hour and 2-digit minute that indicates the start of the time-window when the client expects Estes to execute the pickup.

pickupEndTime

This is a 4-digit time with a 2-digit hour and 2-digit minute that indicates the end of the time-window when the client expects Estes to execute the pickup.

hazmatFlag

Use this to indicate the requirement to pick up hazardous materials. Cite additional details and specify the identity and type of hazardous materials in the request’s commodity elements area.

expeditedCode

This is an optional code indicating the priority of the resulting shipment after successful pickup. Valid values are listed below:

• (BLANK) — normal [default]
• E — Estes Forwarding
• G — Guaranteed
• H — Hot

whoRequested

This optional code indicates the party that requested the pickup. The following are the valid values:

• (BLANK) — Unknown
• C — Consignee
• S — Shipper
• 3 — 3rd party
• 4 — 4th party

respondByTime

Not used for web pickups.

trailer/trailerInfo/length

Use this optional code if the request directs Estes to hook or drop off a trailer at the pickup location. The following are the valid values:

• (BLANK) — Trailer length not specified
• 20 — 20 feet
• 28 — 28 feet
• 40 — 40 feet
• 45 — 45 feet
• 48 — 48 feet
• 53 — 53 feet

trailer/trailerInfo/type

This optional code indicates the trailer type if the request requires Estes to hook up or drop off a trailer at the pickup location. The following are the valid values:

• (BLANK) — Trailer type not specified
• CT — Straight Container
• LG — Lift Gate
• RD — Roll Door
• SD — Side Door
• ST — Swing Door Truck

referenceNumbers/referenceNumber/referenceInfo/type

Used in each referenceNumber element of the optional unbounded referenceNumbers element, this code defines the type of reference number passed in that element. Below are the valid values:

• BOL — Bill of Lading number
• DPT — Consignee department number
• NUM — Shipper ID number
• PKG — Shipper package ID number
• PON — Consignee purchase order number
• RAU — Return authority

commodities/commodity/commodityInfo/code

Used in each commodity element of the optional unbounded commodities element, this unique commodity code defines the type of commodity being passed. It supports custom commodity code values or you may leave it blank (an empty string) and it will default to “MISC” (without quotes). If you are unsure what to pass, use MISC.

commodities/commodity/commodityInfo/packageCode

Used in each commodity element of the optional unbounded commodities element, this is a unit of measure for the commodity. Valid values are listed below:

• BD — Bundles
• BG — Bags
• BK — Buckets
• BL — Bales
• BR — Barrels
• BX — Boxes
• CN — Cans
• CR — Crates
• CS — Cases
• CT — Cartons
• CY — Cylinders
• DR — Drums
• JC — Jerrican
• KT — Kits
• PC — Pieces
• PK — Packages
• PL — Pails
• PT — Pallets
• RE — Reels
• RL — Rolls
• SK — Skids
• TL — Truckload
• TO — Totes

commodities/commodity/commodityInfo/hazmat/hazmatCode

The hazmat element is optional. If the commodity is not hazardous, omit this element from the commodity being passed to prevent validations from requiring its child elements.

Used in each commodity element of the optional unbounded commodities element, this is required if the adjacent hazmat flag has a value. It must start with one of the two values listed here to be a valid industry standard hazardous material code.

• NA
• UN

commodities/commodity/commodityInfo/hazmat/hazmatFlag

Used in each commodity element of the optional unbounded commodities element, the hazmat code here represents the type of hazmat commodity. Valid values are listed below:

• (BLANK)
• C — Corrosive
• D — Dangerous
• E — Explosives
• F — Flammable
• G — Flammable gas
• H — Hazardous
• L — Chlorine
• M — Combustible
• N — Nonflammable gas
• P — Poison
• R — Radioactive
• S — Flammable solid
• X — Oxidizer

comments/comment/commentInfo/type

Used in each comment element of the optional unbounded comments element, the type code here indicates the type of comment. Valid values are listed below:

• CCM — Consignee Comment
• CSI — Consignee Special Instruction
• SCM — Shipper/Stop Comment
• SSI — Shipper/Stop Special Instruction
• 3CM — 3rd Party Comment
• 3SI — 3rd Party Special Instruction
• 4CM — 4th Party Comment
• 4SI — 4th Party Special Instruction
• 5CM — 5th Party Comment
• 5SI — 5th Party Special Instruction
• 6CM — 6th Party Comment
• 6SI — 6th Party Special Instruction

addresses/address/addressInfo/addressType

Used in each address element of the optional unbounded addresses element, the type code here indicates the type of address being passed. Valid values are listed below:

• C — Consignee Address
• 3 — 3rd Party Address
• 4 — 4th Party Address
• 5 — 5th Party Address
• 6 — 6th Party Address

contacts/contact/contactInfo/contactType

Used in each contact element of the optional unbounded contacts element, the type code here indicates the type of contact being passed. Valid values are listed below:

• A — Actual Submitter
• C — Consignee Contact
• R — Requested Response Contact
• S — Shipper Contact
• 3 — Third Party Contact
• 4 — Fourth Party Contact
• 5 — Fifth Party Contact
• 6 — Sixth Party Contact

contacts/contact/contactInfo/notificationMethod

This code indicates the method of notification if the receiveNotifications element is enabled for the contact (Y). Valid values are listed below:

• E — Email
• F — Fax (NOTE: Fax-based notifications are unavailable at this time.)

notifications/notification/notificationInfo/type

You can subscribe to automatic notification emails, which are sent at key events throughout the pickup lifecycle. This code indicates the type of event to subscribe to for automatic notifications. (Valid values are listed below.) It’s also possible to pass multiple notification elements with a different type on each to receive notifications when more than one of the following events occur. The notifications will be sent to all contacts passed with the receiveNotifications element set to Y via a valid associated email address.

• ACC — Terminal accepted pickup
• BGN — Work has begun
• RCV — Pickup request received
• RJT — Pickup request rejected
• WRK — Pickup request worked (Estes has the freight.)

*/*/operation/operationType

The operation type is ignored for all operations except the Update operation. Used for each of the child element types, the operation type controls the behavior of the update regarding that child element. Specify which operation type should be performed during that update of the pickup request based on your needs. When performing the update or deletion of a child element using this update operation, it must also be accompanied by the ID element of the same element in order for the service to properly identify which child element is to be updated or deleted.

• C — Create new child record
• U — Update existing child record
• D — Delete existing child record