Update Pickup Request
General Operation Information
This web service operation enables Estes customers to update an existing Estes pickup request via the unique pickup ID.
The standard process is to first call the retrieve operation, modify the returned document as needed, set the operation type accordingly for each child record and then send it. The pickup will be updated to reflect the specified changes.
To control the behavior or the child elements (such as Contacts and Comments), those elements have an operation type which can be set to D (delete), U (update) or C (create) depending on the desired behavior. If a contact must be deleted, send the pickup document with that child element marked with an operation type of D. To change a child element, use a U. To add a new one, just use a C.
- Communication Pattern
- Preconditions
- Postconditions
- Input
- Output
- Errors & Exceptions
Communication Pattern
Request/Reply – This is a communication pattern in which the service requester sends a request to the service provider. The service provider processes the request and sends a reply back to the requester. This is an on-time operation, which means that there are no (long) time intervals between sending the request, the processing of the request, and sending the reply.
Preconditions
- A requester must have a valid My Estes user account, and this account must have the appropriate privileges to call the pickup web service.
- A valid pickup ID is required to identify the pickup information for updating.
- Due to the update’s expectations, all required information for creating a pickup request must be provided.
Postconditions
- A general error is provided, which indicates that the service failed due to a system error.
- The pickup request update was successful, with a message indicating success in the SOAP response.
- Business validation errors are returned in a list with a code and description for each.
Input
Date and time elements are handled as described in the Create Pickup operation. A valid request number is required.
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:est="https://estespickup.base.ws.provider.soapws.pickupRequest">
<soapenv:Header/>
<soapenv:Body>
<est:updatePickupRequestWS>
<pickupRequestInput>
<!--Optional:-->
<requestNumber>?</requestNumber>
<shipper>
<shipperName>?</shipperName>
<!--Optional:-->
<accountCode>?</accountCode>
<!--Optional:-->
<shipperAddress>
<!--Optional:-->
<addressInfo>
<addressLine1>?</addressLine1>
<!--Optional:-->
<addressLine2>?</addressLine2>
<city>?</city>
<stateProvince>?</stateProvince>
<postalCode>?</postalCode>
<!--Optional:-->
<postalCode4>?</postalCode4>
<countryAbbrev>?</countryAbbrev>
</addressInfo>
</shipperAddress>
<!--Optional:-->
<shipperContacts>
<!--1 or more repetitions:-->
<shipperContact>
<!--Optional:-->
<id>?</id>
<!--Optional:-->
<operation>
<operationType>?</operationType>
</operation>
<!--Optional:-->
<contactInfo>
<name>
<!--Optional:-->
<firstName>?</firstName>
<!--Optional:-->
<middleName>?</middleName>
<!--Optional:-->
<lastName>?</lastName>
</name>
<!--Optional:-->
<email>?</email>
<phone>
<areaCode>?</areaCode>
<number>?</number>
<!--Optional:-->
<extension>?</extension>
</phone>
<!--Optional:-->
<fax>
<areaCode>?</areaCode>
<number>?</number>
</fax>
<!--Optional:-->
<receiveNotifications>?</receiveNotifications>
<!--Optional:-->
<notificationMethod>?</notificationMethod>
</contactInfo>
</shipperContact>
</shipperContacts>
</shipper>
<!--Optional:-->
<requestAction>?</requestAction>
<!--Optional:-->
<paymentTerms>?</paymentTerms>
<pickupDate>?</pickupDate>
<!--Optional:-->
<pickupStartTime>?</pickupStartTime>
<!--Optional:-->
<pickupEndTime>?</pickupEndTime>
<!--Optional:-->
<totalPieces>?</totalPieces>
<!--Optional:-->
<totalWeight>?</totalWeight>
<!--Optional:-->
<totalHandlingUnits>?</totalHandlingUnits>
<!--Optional:-->
<hazmatFlag>?</hazmatFlag>
<!--Optional:-->
<expeditedCode>?</expeditedCode>
<!--Optional:-->
<whoRequested>?</whoRequested>
<!--Optional:-->
<trailer>
<!--Optional:-->
<trailerInfo>
<id>?</id>
<!--Optional:-->
<length>?</length>
<!--Optional:-->
<type>?</type>
</trailerInfo>
</trailer>
<!--Optional:-->
<referenceNumbers>
<!--1 or more repetitions:-->
<referenceNumber>
<!--Optional:-->
<id>?</id>
<!--Optional:-->
<operation>
<operationType>?</operationType>
</operation>
<!--Optional:-->
<referenceInfo>
<type>?</type>
<value>?</value>
<!--Specify whether or not the reference number is required at the time of pickup. For instance, if the reference number is a gate code required for the driver to enter the loading dock, this value should be specified as Y.:-->
<required>?</required>
<!--Optional:-->
<totalPieces>?</totalPieces>
<!--Optional:-->
<totalWeight>?</totalWeight>
</referenceInfo>
</referenceNumber>
</referenceNumbers>
<!--Optional:-->
<commodities>
<!--1 or more repetitions:-->
<commodity>
<!--Optional:-->
<id>?</id>
<!--Optional:-->
<operation>
<operationType>?</operationType>
</operation>
<!--Optional:-->
<commodityInfo>
<!--Optional:-->
<code>?</code>
<!--Optional:-->
<packageCode>?</packageCode>
<description>?</description>
<!--Optional:-->
<hazmat>
<!--Optional:-->
<hazmatCode>?</hazmatCode>
<!--Optional:-->
<hazmatFlag>?</hazmatFlag>
</hazmat>
<!--Optional:-->
<pieces>?</pieces>
<!--Optional:-->
<weight>?</weight>
<!--Optional:-->
<nmfcNumber>?</nmfcNumber>
<!--Optional:-->
<nmfcSubNumber>?</nmfcSubNumber>
</commodityInfo>
</commodity>
</commodities>
<!--Optional:-->
<comments>
<!--1 or more repetitions:-->
<comment>
<!--Optional:-->
<id>?</id>
<!--Optional:-->
<operation>
<operationType>?</operationType>
</operation>
<!--Optional:-->
<commentInfo>
<type>?</type>
<commentText>?</commentText>
</commentInfo>
</comment>
</comments>
<!--Optional:-->
<addresses>
<!--1 or more repetitions:-->
<address>
<!--Optional:-->
<id>?</id>
<!--Optional:-->
<operation>
<operationType>?</operationType>
</operation>
<!--Optional:-->
<addressInfo>
<addressType>?</addressType>
<addressLine1>?</addressLine1>
<!--Optional:-->
<addressLine2>?</addressLine2>
<city>?</city>
<stateProvince>?</stateProvince>
<postalCode>?</postalCode>
<!--Optional:-->
<postalCode4>?</postalCode4>
<countryAbbrev>?</countryAbbrev>
</addressInfo>
</address>
</addresses>
<!--Optional:-->
<contacts>
<!--1 or more repetitions:-->
<contact>
<!--Optional:-->
<id>?</id>
<!--Optional:-->
<operation>
<operationType>?</operationType>
</operation>
<!--Optional:-->
<contactInfo>
<contactType>?</contactType>
<name>
<!--Optional:-->
<firstName>?</firstName>
<!--Optional:-->
<middleName>?</middleName>
<!--Optional:-->
<lastName>?</lastName>
</name>
<!--Optional:-->
<email>?</email>
<phone>
<areaCode>?</areaCode>
<number>?</number>
<!--Optional:-->
<extension>?</extension>
</phone>
<!--Optional:-->
<fax>
<areaCode>?</areaCode>
<number>?</number>
</fax>
<!--Optional:-->
<receiveNotifications>?</receiveNotifications>
<!--Optional:-->
<notificationMethod>?</notificationMethod>
</contactInfo>
</contact>
</contacts>
<!--Optional:-->
<notifications>
<!--1 or more repetitions:-->
<notification>
<!--Optional:-->
<id>?</id>
<!--Optional:-->
<operation>
<operationType>?</operationType>
</operation>
<!--Optional:-->
<notificationInfo>
<type>?</type>
</notificationInfo>
</notification>
</notifications>
</pickupRequestInput>
</est:updatePickupRequestWS>
</soapenv:Body>
</soapenv:Envelope>
Output
User authentication and authorization work the same for all web service operations. See Errors & Exceptions below for failures.
If the pickup update is successful, a message indicating success will be returned. It will include the unique pickup request number. The following is an example of a successful response to a pickup request update:
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ser-root:updatePickupRequestWSResponse xmlns:ser-root="https://estespickup.base.ws.provider.soapws.pickup" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<statusMessage>Update of pickup request ID 50396 is complete.</statusMessage>
</ser-root:updatePickupRequestWSResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors & Exceptions
Web service authentication will fail if the user is not authorized. It will also fail if the provided username and password provided are not from a valid and active My Estes profile.
If a business validation rule is violated, an error code and description will be returned to the user in the following format:
<error>
<elementName/>
<code>PKE2050</code>
<description>Shipper state must be a valid state abbreviation.</description>
<badData></badData>
</error>
NOTE: Business validation error codes have three letters followed by four numbers.Exceptions
Several error conditions will cause exceptions (faults) in the web service. You can view these error codes and their associated descriptions as a PDF or downloaded as a CSV.
Simplify Your Shipping with APIs
See the codes, definitions, and capabilities of our latest REST APIs.