version 1 - pitt ohio express...b2b pickup request user’s guide v 1.0 page 5 of 30 method:...

B2B Pickup Request Version 1.0

B2B Pickup Request User’s Guide v 1.0

of 30

Copyright Notice Copyright 2013 PITT OHIO, LLC ALL RIGHTS RESERVED This documentation, the software it describes, and the information and know-how they contain constitute the proprietary, confidential and valuable trade secret information of PITT OHIO, LLC, its affiliated companies or its or their licensors, and may not be used for any unauthorized purpose, or disclosed to others without the prior written permission of the applicable PITT OHIO entity. This documentation and the software that it describes are provided “AS IS”. NO WARRANTY IS EXPRESSED AND NONE SHALL BE IMPLIED, INCLUDING THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR USE OR FOR A PARTICULAR PURPOSE. Information in this document is subject to change without notice. Please contact us at [email protected] or by calling 1-800-366-7488 and asking for a member of the E-Business Team, if you experience any problems or have questions with the contents of this guide, or the software itself.

PITT OHIO, LLC 15 27

th Street

Pittsburgh, PA 15222 1-800-366-7488

Copyright 2013 – PITT OHIO, LLC


of 30

Overview

The B2B Pickup Request application allows customers to seamlessly submit pickup requests to PITT OHIO. This document details the methods of a SOAP web service that customers may incorporate into their custom software or an existing Traffic Management System. This PITT OHIO web service uses the SOAP protocol as specified by W3C and as implemented in the Microsoft .NET platform.

Web Service Location

http://works.pittohio.com/WebServices/PBEServices/B2BServices.asmx

Web Service Description

http://works.pittohio.com/WebServices/PBEServices/B2BServices.asmx?WSDL

Namespace

Methods and data objects in the B2BServices web service are in the namespace “http://pittohio.com”. Other namespaces used in the web service description document are:

xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"

xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/"

xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"

xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"

xmlns:tns="http://pittohio.com/"

xmlns:s="http://www.w3.org/2001/XMLSchema"

xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"

xmlns:http="http://schemas.xmlsoap.org/wsdl/http/"

xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"

B2B Client Overview

GetSessionID B2BSubmit

PickupRequest

B2BStartShipper

PickupRequest

B2BStartConsignee

PickupRequest

B2BStartThirdParty

PickupRequest

B2BStart

PickupRequest

B2BAddConsigneePickup

RequestShipment

B2BAddPickup

RequestShipment

1 - 20

GetPickup

DateRange

The B2B client will need PITT OHIO web credentials in order to use this service. To obtain these credentials, please contact a member of our E-Business team by calling 1-800-366-7488 or emailing [email protected]. If your company currently interacts with PITT OHIO using another B2B application, such as our XML Rate Quoter, the same web credentials may be used for the B2B Pickup Request application. A client program will begin this B2B transaction by passing the appropriate email address and password to the GetSessionID

method. If the credentials are valid, this function will return a sessionID that the client will be required to pass to the subsequent web

functions. PITT OHIO allows pickups to be scheduled up to three weeks in advance, excluding weekends and holidays. To obtain a list of valid pickup dates, the client may choose to invoke the GetPickupDateRange operation. The list of pickup dates will be relative to the

date that the method is called. This step is optional.

http://works.pittohio.com/WebServices/PBEServices/B2BServices.asmx

http://works.pittohio.com/WebServices/PBEServices/B2BServices.asmx?WSDL


of 30

To initiate a pickup request, the B2B client will call the B2BStartPickupRequest operation and pass information about the pickup’s

requester, the shipper, pickup instructions and the sessionID. This method validates the input data and returns either an array of

errors or a pickup StagingID. Alternatively, a client may call one of three convenience methods to start the pickup request. These

methods require fewer parameters than the B2BStartPickupRequest method and are based on the customer’s role in the pickup:

B2BStartShipperPickupRequest, B2BStartConsigneePickupRequest and B2BStartThirdPartyPickupRequest.

After successfully calling one of the B2BStartPickupRequest, B2BStartShipperPickupRequest,

B2BStartConsigneePickupRequest or B2BStartThirdPartyPickupRequest methods, a client will pass the sessionID and

pickup StagingID along with information about an individual shipment to the B2BAddPickupRequestShipment method. This

method validates the pickup item and returns an array of errors if any problems are found. When the requester is either the shipper or the third party, the client may call the B2BAddPickupRequestShipment method multiple times to add up to twenty shipments to a

pickup (StagingID). If the requester is the consignee, the client may use the B2BAddConsigneePickupRequestShipment

convenience method in lieu of the B2BAddPickupRequestShipment method. Only one shipment maybe assigned to each pickup

(StagingID) when the requestor is the consignee.

Finally, a client will submit the pickup request to PITT OHIO by calling the B2BSubmitPickupRequest method and passing the

sessionID, pickup StagingID and a boolean variable indicating whether or not a confirmation email should be sent to the requester.

This function returns an array of errors if there are any. If the function is successful, a PickupNumber will be returned along with

contact information for the pickup terminal. After a pickup request has been submitted, the StagingID will become invalid and should

not be recycled. Reusing the StagingID may not generate an error in the system but could have undesired results. Please contact

the pickup terminal to make any modifications to a submitted pickup. All user accounts are initially setup to operate in a test environment. Please contact our E-Business team, by calling 1-800-366-7488 or emailing [email protected], once client-side programming has been completed. Our staff will review your test data to ensure that the client has adhered to this published procedure and will then approve the account for production use. You will not need to make any client-side programming changes in order to switch from the test environment to the production environment.


of 30

Method: GetSessionID

A client program will begin the B2B transaction by passing the appropriate email address and password to the GetSessionID method.

If the credentials are valid, this function will return a sessionID that the client will be required to pass to the subsequent web functions.

<s:element name="GetSessionID">

<s:complexType>

<s:sequence>

<s:element minOccurs="0" maxOccurs="1" name="emailAddress" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="password" type="s:string" />

</s:sequence>

</s:complexType>

</s:element>

GetSessionID: Input Parameters

Parameter Type Required Description Example

emailAddress String Required The email address that is used as the PITT OHIO web user ID. [email protected]

password String Required The password that corresponds to the emailAddress. Password123$

GetSessionID: Result Member – GetSessionIDResult

<s:element name="GetSessionIDResponse">

<s:complexType>

<s:sequence>

<s:element minOccurs="0" maxOccurs="1" name="GetSessionIDResult"

type="tns:FlaggedResult" />

</s:sequence>

</s:complexType>

</s:element>

GetSessionID: Type – FlaggedResult

<s:complexType name="FlaggedResult">

<s:sequence>

<s:element minOccurs="1" maxOccurs="1" name="Error" type="s:boolean" />

<s:element minOccurs="0" maxOccurs="1" name="Result" type="s:string" />

</s:sequence>

</s:complexType>

Field Name Type Description

Error

Boolean If there was an error in executing the GetSessionID method this value will be true; otherwise

this value will be false.

Result

String A sessionID will be returned if the method was executed successfully. If Error is true, then

the result will be an error string.

GetSessionID: Possible Errors

Unable to authenticate user

Incorrect User Name or Password


of 30

GetSessionID: Example Request

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<GetSessionID xmlns="http://pittohio.com/">

<emailAddress>[email protected]</emailAddress>

<password>Password123$</password>

</GetSessionID>

</soap:Body>

</soap:Envelope>

GetSessionID: Example Response

<?xml version="1.0" encoding="utf-8" ?>




<soap:Body>

<GetSessionIDResponse xmlns="http://pittohio.com/">

<GetSessionIDResult>

<Error>false</Error>

<Result>F406FA3F-E7A0-4CE4-80C8-A8340C1961D3</Result>

</GetSessionIDResult>

</GetSessionIDResponse>

</soap:Body>

</soap:Envelope>


of 30

Method: GetPickupDateRange

The client may choose to invoke the GetPickupDateRange operation to obtain a list of valid pickup dates relative to the current date.

This step is optional.

<s:element name="GetPickupDateRange">

<s:complexType />

</s:element>

GetPickupDateRange: Result Member – GetPickupDateRangeResult

<s:element name="GetPickupDateRangeResponse">

<s:complexType>

<s:sequence>

<s:element minOccurs="0" maxOccurs="1" name="GetPickupDateRangeResult"

type="tns:ArrayOfDateTime" />

</s:sequence>

</s:complexType>

</s:element>

GetPickupDateRange: Type - ArrayOfDateTime

<s:complexType name="ArrayOfDateTime">

<s:sequence>

<s:element minOccurs="0" maxOccurs="unbounded" name="dateTime" type="s:dateTime" />

</s:sequence>

</s:complexType>


dateTime DateTime A valid pickup date for PITT OHIO

GetPickupDateRange: Example Response




<soap:Body>

<GetPickupDateRangeResponse xmlns="http://pittohio.com/">

<GetPickupDateRangeResult>

<dateTime>2013-01-15T00:00:00</dateTime>















</GetPickupDateRangeResult>

</GetPickupDateRangeResponse>

</soap:Body>

</soap:Envelope>


of 30

Method: B2BStartPickupRequest

A B2B client will call the B2BStartPickupRequest operation and pass information about the pickup’s requester, the shipper, pickup

instructions and the sessionID generated from the GetSessionID method. If there are no errors, this method will return a

StagingID that will be used in the subsequent methods.

<s:element name="B2BStartPickupRequest">

<s:complexType>

<s:sequence>

<s:element minOccurs="0" maxOccurs="1" name="sessionID" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="requesterRole" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="requesterName" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="requesterAddress" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="requesterAddress2" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="requesterZip" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="requesterContactName" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="requesterContactPhone" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="requesterContactEmail" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="shipperName" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="shipperAddress" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="shipperAddress2" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="shipperZip" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="shipperContactName" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="shipperContactPhone" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="shipperContactEmail" type="s:string" />

<s:element minOccurs="1" maxOccurs="1" name="pickupReadyDateTime" type="s:dateTime" />

<s:element minOccurs="1" maxOccurs="1" name="shipperCloseTime" type="s:time" />

<s:element minOccurs="0" maxOccurs="1" name="pickupInstructions" type="s:string" />

</s:sequence>

</s:complexType>

</s:element>

B2BStartPickupRequest: Input Parameters


sessionID String Required, 36 characters

The sessionID that is generated from

the GetSessionID method.

F406FA3F-E7A0-4CE4-80C8-A8340C1961D3

requesterRole String Required, 100 character max

This value identifies the role of the company that is requesting the pickup. The requesterRole must be either

“SHIPPER”, “CONSIGNEE” or “THIRDPARTY”.

THIRDPARTY

requesterName String Required, 100 character max

The name of the company that is requesting the pickup.

EZ LOGISTICS CO

requesterAddress String Required, 100 character max

The address of the company that is requesting the pickup.

123 NORTH MAIN ST

requesterAddress2 String Optional, 100 character max

The second line of the address for the company that is requesting the pickup, if applicable.

ATTN: LTL DEPT

requesterZip String Required This value represents the ZIP code of the company requesting the pickup. The requesterZip must be entered as a 5-

digit US Zip Code, 5-digit US Zip Code+4 or an “ANA NAN” style Canadian Postal Code.

32830

requesterContactName String Required, 100 character max

The contact name for the company that is requesting the pickup. This person will be contacted if PITT OHIO has any questions regarding the pickup.

JENNIFER JONES


of 30

requesterContactPhone String Required, 20 character max

The phone number for the contact that is requesting the pickup.

(800)894-1245

requesterContactEmail String Required, 100 character max

The email address for the contact that is requesting the pickup.

[email protected]

shipperName String Required, 100 character max

The name of the shipping company where the pickup will be made.

SHINY SPROCKETS INC

shipperAddress String Required, 100 character max

The address where the pickup will be made.

752 GEAR GROVE

shipperAddress2 String Optional, 100 character max

The second line of the address where the pickup will be made (if applicable).

DOCK DOOR #9

shipperZip String Required This value represents the ZIP code where the pickup will be made. The shipperZip must be entered as a 5-


15239

shipperContactName String Required, 100 character max

The contact name for the shipping company. This person may be contacted if there are any questions regarding the pickup location.

MARK MATTHEWS

shipperContactPhone String Required, 20 character max

The phone number for the contact at the shipping company.

412-793-5522

shipperContactEmail String Required, 100 character max

The email address for the contact at the shipping company.

[email protected]

pickupReadyDateTime DateTime Required The date and time when the shipment(s) will be ready for pickup. PITT OHIO pickups are made in Eastern Standard Time. This value must be in ISO 8601 format, i.e. [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]

2013-01-16T09:00:00-05:00

shipperCloseTime Time Required The time that the shipper will close on the day of the pickup. This value must be formatted as hh:mm:ss[Z|(+|-)hh:mm]

17:30

pickupInstructions String Optional, 255 character max

Any additional information that is related to the pickup can be included in this field.

CALL FOR APPOINTMENT

B2BStartPickupRequest: Result Member – B2BStartPickupRequestResult

<s:element name="B2BStartPickupRequestResponse">

<s:complexType>

<s:sequence>

<s:element minOccurs="0" maxOccurs="1" name="B2BStartPickupRequestResult"

type="tns:B2BStartPickupRequestResult" />

</s:sequence>

</s:complexType>

</s:element>

B2BStartPickupRequest: Type – B2BStartPickupRequestResult

<s:complexType name="B2BStartPickupRequestResult">

<s:sequence>

<s:element minOccurs="1" maxOccurs="1" name="StagingID" type="s:int" />

<s:element minOccurs="0" maxOccurs="1" name="Errors" type="tns:ArrayOfString" />

</s:sequence>

</s:complexType>


of 30


StagingID

Integer The StagingID is an identifier that is used to build the pickup request and will be passed to

the subsequent methods. This value will be 0 (zero) if any of the input parameters have caused an error.

Errors

Array of String An array of errors will be returned if there was a problem with any of the input parameters.

B2BStartPickupRequest: Possible Errors

Session ID is invalid.

Requester Role is invalid.

Requester [Name | Address | ZIP/Postal Code | Contact Name | Contact Phone | Contact Email] is missing.

Requester [Name | Address | Address 2 | Contact Name] is too long.

Requester ZIP/Postal Code is invalid or unknown. (Invalid includes ZIP/Postal Codes that are not served by PITT OHIO or a TRNET partner, or that are too long.)

Requester [Contact Phone | Contact Email] format is invalid. (Invalid includes values that are too long.)

Shipper [Name | Address | ZIP/Postal Code | Contact Name | Contact Phone | Contact Email] is missing.

Shipper [Name | Address | Address 2 | Contact Name] is too long.

Shipper ZIP/Postal Code is invalid or unknown. (Invalid includes ZIP/Postal Codes that are not served by PITT OHIO or a TRNET partner, or that are too long.)

Shipper [Contact Phone | Contact Email] format is invalid. (Invalid includes values that are too long.)

Pickup Ready Date is on a weekend or holiday or it is too far in the future.

Pickup Ready Date is in the past.

Pickup Ready Time is after Shipper Close Time.

Pickup Instructions are too long.

B2BStartPickupRequest: Example Request




<soap:Body>

<B2BStartPickupRequest xmlns="http://pittohio.com/">

<sessionID>F406FA3F-E7A0-4CE4-80C8-A8340C1961D3</sessionID>

<requesterRole>THIRDPARTY</requesterRole>

<requesterName>EZ LOGISTICS CO</requesterName>

<requesterAddress>123 NORTH MAIN ST</requesterAddress>

<requesterAddress2>ATTN: LTL DEPT</requesterAddress2>

<requesterZip>32830</requesterZip>

<requesterContactName>JENNIFER JONES</requesterContactName>

<requesterContactPhone>(800)894-1245</requesterContactPhone>

<requesterContactEmail>[email protected]</requesterContactEmail>

<shipperName>SHINY SPROCKETS INC</shipperName>

<shipperAddress>752 GEAR GROVE</shipperAddress>

<shipperAddress2>DOCK DOOR #9</shipperAddress2>

<shipperZip>15239</shipperZip>

<shipperContactName>MARK MATTHEWS</shipperContactName>

<shipperContactPhone>412-793-5522</shipperContactPhone>

<shipperContactEmail>[email protected]</shipperContactEmail>

<pickupReadyDateTime>2013-01-16T09:00:00-05:00</pickupReadyDateTime>

<shipperCloseTime>17:30</shipperCloseTime>

<pickupInstructions>CALL FOR APPOINTMENT</pickupInstructions>

</B2BStartPickupRequest>

</soap:Body>

</soap:Envelope>


of 30

B2BStartPickupRequest: Example Response





<soap:Body>

<B2BStartPickupRequestResponse xmlns="http://pittohio.com/">

<B2BStartPickupRequestResult>

<StagingID>448436</StagingID>

</B2BStartPickupRequestResult>

</B2BStartPickupRequestResponse>

</soap:Body>

</soap:Envelope>


of 30

Method: B2BStartShipperPickupRequest

If the shipper is requesting the pickup, the client may call the B2BStartShipperPickupRequest method in lieu of the

B2BStartPickupRequest method. The requester’s role is inferred to be the shipper and is not required to be passed as an input

parameter. The shipper’s details will also be used as the requester’s information in this scenario. If there are no errors, this method will return a StagingID that will be used in the subsequent methods.

<s:element name="B2BStartShipperPickupRequest">

<s:complexType>

<s:sequence>












</s:sequence>

</s:complexType>

</s:element>

B2BStartShipperPickupRequest: Input Parameters



The sessionID that is generated from the

GetSessionID method.

F406FA3F-E7A0-4CE4-80C8-A8340C1961D3



SHINY SPROCKETS INC


The address where the pickup will be made. 752 GEAR GROVE



DOCK DOOR #9

shipperZip String Required This value represents the ZIP code where the pickup will be made. The shipperZip must

be entered as a 5-digit US Zip Code, 5-digit US Zip Code+4 or an “ANA NAN” style Canadian Postal Code.

15239



MARK MATTHEWS



412-793-5522



[email protected]


2013-01-16T09:00:00-05:00


17:30


of 30




B2BStartShipperPickupRequest: Result Member – B2BStartShipperPickupRequestResult

<s:element name="B2BStartShipperPickupRequestResponse">

<s:complexType>

<s:sequence>

<s:element minOccurs="0" maxOccurs="1" name="B2BStartShipperPickupRequestResult"


</s:sequence>

</s:complexType>

</s:element>

B2BStartShipperPickupRequest: Type – B2BStartPickupRequestResult


<s:sequence>



</s:sequence>

</s:complexType>


StagingID



Errors


B2BStartShipperPickupRequest: Possible Errors










B2BStartShipperPickupRequest: Example Request




<soap:Body>

<B2BStartShipperPickupRequest xmlns="http://pittohio.com/">










of 30




</B2BStartShipperPickupRequest>

</soap:Body>

</soap:Envelope>

B2BStartShipperPickupRequest: Example Response





<soap:Body>

<B2BStartShipperPickupRequestResponse xmlns="http://pittohio.com/">

<B2BStartShipperPickupRequestResult>


</B2BStartShipperPickupRequestResult>

</B2BStartShipperPickupRequestResponse>

</soap:Body>

</soap:Envelope>


of 30

Method: B2BStartConsigneePickupRequest

If the consignee is the party that is requesting the pickup, the client may call the B2BStartConsigneePickupRequest method in

lieu of the B2BStartPickupRequest method. When the client calls B2BAddConsigneePickupRequestShipment instead of

B2BAddPickupRequestShipment, the requester’s details will be used as the consignee’s information. The requester’s role is

inferred to be the consignee and is not required to be passed as an input parameter. If there are no errors, this method will return a StagingID that will be used in the subsequent methods.

<s:element name="B2BStartConsigneePickupRequest">

<s:complexType>

<s:sequence>



















</s:sequence>

</s:complexType>

</s:element>

B2BStartConsigneePickupRequest: Input Parameters





F406FA3F-E7A0-4CE4-80C8-A8340C1961D3



ABC WIDGET FACTORY



1900 WIDGET WAY



BUILDING A



44118



SHAWN SMITH



330-486-1122


of 30



[email protected]



SHINY SPROCKETS INC



752 GEAR GROVE



DOCK DOOR #9

shipperZip String Required This value represents the ZIP code where the pickup will be made. The shipperZip must be entered as a 5-digit

US Zip Code, 5-digit US Zip Code+4 or an “ANA NAN” style Canadian Postal Code.

15239



MARK MATTHEWS



412-793-5522



[email protected]


2013-01-16T09:00:00-05:00


17:30




B2BStartConsigneePickupRequest: Result Member – B2BStartConsigneePickupRequestResult

<s:element name="B2BStartConsigneePickupRequestResponse">

<s:complexType>

<s:sequence>

<s:element minOccurs="0" maxOccurs="1" name="B2BStartConsigneePickupRequestResult"


</s:sequence>

</s:complexType>

</s:element>

B2BStartConsigneePickupRequest: Type – B2BStartPickupRequestResult


<s:sequence>



</s:sequence>

</s:complexType>


of 30


StagingID



Errors


B2BStartConsigneePickupRequest: Possible Errors














B2BStartConsigneePickupRequest: Example Request




<soap:Body>

<B2BStartConsigneePickupRequest xmlns="http://pittohio.com/">


<requesterName>ABC WIDGET FACTORY</requesterName>

<requesterAddress>1900 WIDGET WAY</requesterAddress>

<requesterAddress2>BUILDING A</requesterAddress2>


<requesterContactName>SHAWN SMITH</requesterContactName>

<requesterContactPhone>330-486-1122</requesterContactPhone>












</B2BStartConsigneePickupRequest>

</soap:Body>

</soap:Envelope>


of 30

B2BStartConsigneePickupRequest: Example Response





<soap:Body>

<B2BStartConsigneePickupRequestResponse xmlns="http://pittohio.com/">

<B2BStartConsigneePickupRequestResult>


</B2BStartConsigneePickupRequestResult>

</B2BStartConsigneePickupRequestResponse>

</soap:Body>

</soap:Envelope>


of 30

Method: B2BStartThirdPartyPickupRequest

If the Third Party is requesting the pickup, the client may call the B2BStartThirdPartyPickupRequest method in lieu of the

B2BStartPickupRequest method. The requester’s role is inferred to be the Third Party and is not required to be passed as an in-

put parameter. If there are no errors, this method will return a StagingID that will be used in the subsequent methods.

<s:element name="B2BStartThirdPartyPickupRequest">

<s:complexType>

<s:sequence>



















</s:sequence>

</s:complexType>

</s:element>

B2BStartThirdPickupRequest: Input Parameters



The SessionID that is generated from the


F406FA3F-E7A0-4CE4-80C8-A8340C1961D3



EZ LOGISTICS CO



123 NORTH MAIN ST



ATTN: LTL DEPT



32830



JENNIFER JONES



(800)894-1245



[email protected]


of 30



SHINY SPROCKETS INC



752 GEAR GROVE



DOCK DOOR #9

shipperZip String Required This value represents the ZIP code where the pickup will be made. The shipperZip must be entered as a 5-digit

US Zip Code, 5-digit US Zip Code+4 or an “ANA NAN” style Canadian Postal Code.

15239



MARK MATTHEWS



412-793-5522



[email protected]


2013-01-16T09:00:00-05:00


17:30




B2BStartThirdPartyPickupRequest: Result Member – B2BStartThirdPartyPickupRequestResult

<s:element name="B2BStartThirdyPartyPickupRequestResponse">

<s:complexType>

<s:sequence>

<s:element minOccurs="0" maxOccurs="1" name="B2BStartThirdPartyPickupRequestResult"


</s:sequence>

</s:complexType>

</s:element>

B2BStartThirdPartyPickupRequest: Type – B2BStartPickupRequestResult


<s:sequence>



</s:sequence>

</s:complexType>


of 30


StagingID



Errors


B2BStartThirdPartyPickupRequest: Possible Errors














B2BStartThirdPartyPickupRequest: Example Request




<soap:Body>

<B2BStartThirdPartyPickupRequest xmlns="http://pittohio.com/">


<requesterName>EZ LOGISTICS CO</requesterName>

<requesterAddress>123 NORTH MAIN ST</requesterAddress>

<requesterAddress2>ATTN: LTL DEPT</requesterAddress2>


<requesterContactName>JENNIFER JONES</requesterContactName>

<requesterContactPhone>(800)894-1245</requesterContactPhone>












</B2BStartThirdPartyPickupRequest>

</soap:Body>

</soap:Envelope>

B2BStartThirdPartyPickupRequest: Example Response





of 30


<soap:Body>

<B2BStartThirdPartyPickupRequestResponse xmlns="http://pittohio.com/">

<B2BStartThirdPartyPickupRequestResult>


</B2BStartThirdPartyPickupRequestResult>

</B2BStartThirdPartyPickupRequestResponse>

</soap:Body>

</soap:Envelope>


of 30

Method: B2BAddPickupRequestShipment

After successfully calling one of the B2BStartPickupRequest, B2BStartShipperPickupRequest,

B2BStartConsigneePickupRequest or B2BStartThirdPartyPickupRequest methods, a client will pass the sessionID and

pickup StagingID along with information about an individual shipment to the B2BAddPickupRequestShipment method. This

method validates the pickup item and returns an array of errors if any problems are found. When the requester is either the shipper or the third party, the client may call the B2BAddPickupRequestShipment method multiple

times to add up to twenty shipments to a pickup (StagingID). Only one shipment maybe assigned to each pickup (StagingID) when

the requestor is the consignee. A client may choose to call the B2BAddConsigneePickupRequestShipment convenience method

in replace of the B2BAddPickupRequestShipment method.

<s:element name="B2BAddPickupRequestShipment">

<s:complexType>

<s:sequence>


<s:element minOccurs="1" maxOccurs="1" name="stagingID" type="s:int" />

<s:element minOccurs="0" maxOccurs="1" name="consigneeName" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="consigneeAddress" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="consigneeZip" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="consigneeContactName" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="consigneeContactPhone" type="s:string" />

<s:element minOccurs="1" maxOccurs="1" name="totalWeight" type="s:int" />

<s:element minOccurs="1" maxOccurs="1" name="loosePieces" type="s:int" />

<s:element minOccurs="1" maxOccurs="1" name="skids" type="s:int" />

<s:element minOccurs="1" maxOccurs="1" name="overlength" type="s:boolean" />

<s:element minOccurs="1" maxOccurs="1" name="hazmat" type="s:boolean" />

<s:element minOccurs="0" maxOccurs="1" name="deliveryInstructions" type="s:string" />

</s:sequence>

</s:complexType>

</s:element>

B2BAddPickupRequestShipment: Input Parameters





F406FA3F-E7A0-4CE4-80C8-A8340C1961D3

stagingID Integer Required The StagingID for the pickup request that

was returned by the B2BStartPickupRequest, B2BStartShipperPickupRequest,

B2BStartConsigneePickupRequest or B2BStartThirdPartyPickupRequest

method.

448436

consigneeName String Required, 100 character max

The name of the company that the shipment will be delivered to.

ABC WIDGET FACTORY

consigneeAddress String Required, 100 character max

The address where the shipment will be delivered to.

1900 WIDGET WAY

consigneeZip String Required This value represents the ZIP code where the shipment will be delivered to. The

consigneeZip must be entered as a 5-


44118

consigneeContactName String Required, 100 character max

The contact name at the company that the shipment will be delivered to. This person maybe contacted if there are any questions regarding the delivery.

SHAWN SMITH


of 30

consigneeContactPhone String Required, 20 character max

The phone number for the contact at the company where the shipment will be delivered to.

330-486-1122

totalWeight Integer Required This is the total weight of the shipment. 2521

loosePieces Integer Required, if skids is 0

The number of loose (non-skidded) pieces in the shipment.

7

skids Integer Required,

if loosePieces

is 0

The number of skids that are in the shipment.

2

overlength Boolean Required This boolean flag indicates whether the shipment is (true) or is not (false) overlength. PITT OHIO considers any shipment that is longer than twenty-one (21) feet to be overlength.

false

hazmat Boolean Required This boolean flag indicates whether the shipment does (true) or does not (false) contain hazardous materials as per the Department of Transportation.

false

deliveryInstructions String Optional Any additional information that is related to the shipment or consignee can be included in this field.

CONSTRUCTION ZONE HARD HAT REQUIRED

B2BAddPickupRequestShipment: Result Member – B2BAddPickupRequestShipmentResult

<s:element name="B2BAddPickupRequestShipmentResponse">

<s:complexType>

<s:sequence>

<s:element minOccurs="0" maxOccurs="1" name="B2BAddPickupRequestShipmentResult"

type="tns:ArrayOfString" />

</s:sequence>

</s:complexType>

</s:element>


B2BAddPickupRequestShipmentResult Array of String

An array of errors will be returned if there was a problem with any of the input parameters. If the shipment was added to the pickup successfully the method will not return any errors.

B2BAddPickupRequestShipment: Possible Errors

Invalid Session ID

Invalid Staging ID (Unknown or not associated with Session ID)

Consignee [Name | Address | ZIP/Postal Code | Contact Name | Contact Phone | Contact Email] is missing.

Consignee [Name | Address | Address 2 | Contact Name] is too long.

Neither the Shipper nor the Consignee is served by PITT OHIO.

Consignee ZIP/Postal Code is invalid or unknown. (Invalid includes ZIP/Postal Codes that are not served by PITT OHIO or a TRNET partner, or that are too long.)

Consignee [Contact Phone | Contact Address] format is invalid. (Invalid includes values that are too long.)

Total Weight is not greater than 0.

Number of Loose Pieces or Number of Skids is not greater than 0.

Shipment Instructions is too long.


of 30

B2BAddPickupRequestShipment: Example Request




<soap:Body>

<B2BAddPickupRequestShipment xmlns="http://pittohio.com/">


<stagingID>448436</stagingID>

<consigneeName>ABC WIDGET FACTORY</consigneeName>

<consigneeAddress>1900 WIDGET WAY</consigneeAddress>

<consigneeZip>44118</consigneeZip>

<consigneeContactName>SHAWN SMITH</consigneeContactName>

<consigneeContactPhone>330-486-1122</consigneeContactPhone>

<totalWeight>2521</totalWeight>

<loosePieces>7</loosePieces>

<skids>2</skids>

<overlength>false</overlength>

<hazmat>false</hazmat>

<deliveryInstructions>CONSTRUCTION ZONE HARD HAT REQUIRED</deliveryInstructions>

</B2BAddPickupRequestShipment>

</soap:Body>

</soap:Envelope>

B2BAddPickupRequestShipment: Example Response





<soap:Body>

<B2BAddPickupRequestShipmentResponse xmlns="http://pittohio.com/">

<B2BAddPickupRequestShipmentResult/>

</B2BAddPickupRequestShipmentResponse>

</soap:Body>

</soap:Envelope>


of 30

Method: B2BAddConsigneePickupRequestShipment

After successfully calling the B2BStartConsigneePickupRequest method, a client will pass the sessionID and pickup

StagingID along with information about an individual shipment to the B2BAddConsigneePickupRequestShipment method. The

B2BAddConsigneePickupRequestShipment requires fewer input parameters since the consignee information has already been

passed as the requester via the B2BStartConsigneePickupRequest or B2BStartPickupRequest methods.

This method validates the pickup item and returns an array of errors if any problems are found. Only one shipment maybe assigned to each pickup (StagingID) when the requestor is the consignee.

<s:element name="B2BAddConsigneePickupRequestShipment">

<s:complexType>

<s:sequence>



<s:element minOccurs="1" maxOccurs="1" name="totalWeight" type="s:int" />

<s:element minOccurs="1" maxOccurs="1" name="loosePieces" type="s:int" />

<s:element minOccurs="1" maxOccurs="1" name="skids" type="s:int" />

<s:element minOccurs="1" maxOccurs="1" name="overlength" type="s:boolean" />

<s:element minOccurs="1" maxOccurs="1" name="hazmat" type="s:boolean" />

<s:element minOccurs="0" maxOccurs="1" name="deliveryInstructions" type="s:string" />

</s:sequence>

</s:complexType>

</s:element>

B2BAddConsigneePickupRequestShipment: Input Parameters





F406FA3F-E7A0-4CE4-80C8-A8340C1961D3

stagingID Integer Required The StagingID of the pickup request

returned by B2BStartPickupRequest, B2BStartShipperPickupRequest,


method.

448436

totalWeight Integer Required This is the total weight of the shipment. 2521

loosePieces Integer Required, if skids is 0

The number of loose (non-skidded) pieces in the shipment.

7

skids Integer Required,

if loosePieces

is 0

The number of skids that are in the shipment. 2

overlength Boolean Required This boolean flag indicates whether the shipment is (true) or is not (false) overlength. PITT OHIO considers any shipment that is longer than twenty-one (21) feet to be overlength.

false

hazmat Boolean Required This boolean flag indicates whether the shipment does (true) or does not (false) contain hazardous materials as per the Department of Transportation.

false

deliveryInstructions String Optional Any additional information that is related to the shipment or consignee can be included in this field.

CONSTRUCTION ZONE HARD HAT REQUIRED


of 30

B2BAddConsigneePickupRequestShipment: Result Member – B2BAddConsigneePickupRequestShipmentResult

<s:element name="B2BAddConsigneePickupRequestShipmentResponse">

<s:complexType>

<s:sequence>

<s:element minOccurs="0" maxOccurs="1" name="B2BAddConsigneePickupRequestShipmentResult"

type="tns:ArrayOfString" />

</s:sequence>

</s:complexType>

</s:element>


B2BAddConsigneePickupRequestShipmentResult Array of String

An array of errors will be returned if there was a problem with any of the input parameters. This method will not return any errors If the shipment was added to the pickup (StagingID)

successfully.

B2BAddConsigneePickupRequestShipment: Possible Errors

Invalid Session ID

Invalid Staging ID (Unknown or not associated with Session ID)

Neither the Shipper nor the Consignee is served by PITT OHIO.

Total Weight is not greater than 0.

Number of Loose Pieces or Number of Skids is not greater than 0.

Shipment Instructions is too long.

B2BAddConsigneePickupRequestShipment: Example Request




<soap:Body>

<B2BAddConsigneePickupRequestShipment xmlns="http://pittohio.com/">



<totalWeight>2521</totalWeight>

<loosePieces>7</loosePieces>

<skids>2</skids>

<overlength>false</overlength>

<hazmat>false</hazmat>

<deliveryInstructions>CONSTRUCTION ZONE HARD HAT REQUIRED</deliveryInstructions>

</B2BAddConsigneePickupRequestShipment>

</soap:Body>

</soap:Envelope>

B2BAddPickupRequestShipment: Example Response





<soap:Body>

<B2BAddConsigneePickupRequestShipmentResponse xmlns="http://pittohio.com/">

<B2BAddConsigneePickupRequestShipmentResult/>

</B2BAddConsigneePickupRequestShipmentResponse>

</soap:Body>

</soap:Envelope>


of 30

Method: B2BSubmitPickupRequest

Once the pickup request has been completed, a client will submit the pickup request to PITT OHIO by calling the B2BSubmitPickupRequest method and passing the sessionID, pickup StagingID and a boolean variable indicating whether or

not a confirmation email should be sent. This function returns an array of errors if there are any. If the function is successful, a pickup number will be returned along with contact information for the pickup terminal. After a pickup request has been submitted, the StagingID will become invalid and should not be recycled. Reusing the StagingID

may not generate an error in the system but could have undesired results. Please contact the pickup terminal to make any modifications to a submitted pickup. All user accounts are initially setup to operate in a test environment. Please contact our E-Business team, by calling 1-800-366-7488 or emailing [email protected], once client-side programming has been completed. Our staff will review the test data to ensure that the client has adhered to this published procedure and will then approve the account for production use. No client-side programming changes will need to be made after the account has been approved.

<s:element name="B2BSubmitPickupRequest">

<s:complexType>

<s:sequence>



<s:element minOccurs="1" maxOccurs="1" name="sendEmailToRequester" type="s:boolean" />

</s:sequence>

</s:complexType>

</s:element>

B2BSubmitPickupRequest: Input Parameters





F406FA3F-E7A0-4CE4-80C8-A8340C1961D3

stagingID Integer Required The Staging ID of the pickup request returned by B2BStartPickupRequest, B2BStartShipperPickupRequest,


method.

448436

sendEmailToRequester Boolean Required Flag indicating whether PITT OHIO should send an email confirming the pickup request. The email will be sent to the address given in the requesterEmail parameter passed to

B2BStartPickupRequest,

B2BStartConsigneePickupRequest or

B2BStartThirdPartyPickupRequest, or to

the shipperEmail passed to

B2BStartShipperPickupRequest.

true

B2BSubmitPickupRequest: Result Member – B2BSubmitPickupRequestResult

<s:element name="B2BSubmitPickupRequestResponse">

<s:complexType>

<s:sequence>

<s:element minOccurs="0" maxOccurs="1" name="B2BSubmitPickupRequestResult"

type="tns:B2BSubmitPickupRequestResult" />

</s:sequence>

</s:complexType>

</s:element>


of 30

B2BSubmitPickupRequest: Type – B2BSubmitPickupRequestResult

<s:complexType name="B2BSubmitPickupRequestResult">

<s:sequence>

<s:element minOccurs="1" maxOccurs="1" name="PickupNumber" type="s:int" />

<s:element minOccurs="0" maxOccurs="1" name="PickupPBEID" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="PickupTerminal" type="s:string" />

<s:element minOccurs="0" maxOccurs="1" name="PickupTerminalPhone" type="s:string" />


</s:sequence>

</s:complexType>


PickupNumber Integer This is the reference number that has been assigned to the pickup. If you have questions or need to make changes to the pickup, please call the PITT OHIO pickup terminal and reference the pickup number. A pickup number will only be applied to shipments that originate within PITT OHIO’s direct service area. If the pickup will be made by another member of The Reliance Network (TRNet) the PickupNumber will be zero (0). The

PickupNumber will be “888” until the client’s account has been approved

for production use.

PickupPBEID String This is the identification number used exclusively by the web service. A PickupPBEID number will be assigned to all B2B pickups, including those

that will be serviced by a TRNet partner. This identifier may be useful while troubleshooting your code or if you intend to use other methods (not described in this document) to get information about a pickup request. This number has no meaning to PITT OHIO terminals or to our customer service department and should not be used to inquire about a pickup. An “X” will precede the PickupPBEID until the client’s account has been approved for

production use.

PickupTerminal String This will be the name of the PITT OHIO or TRNet terminal that will service the pickup request. The PickupTerminal will be “TEST TEST TEST” until

the client’s account has been approved for production use.

PickupTerminalPhone String This is the phone number for the PITT OHIO or TRNet terminal that will service the pickup request. The PickupTerminalPhone will be “0-000-

000-0000” until the client’s account has been approved for production use.

Errors ArrayOfString An array of errors will be returned if there was a problem with any of the input parameters.

B2BSubmitPickupRequest: Possible Errors

Session ID is invalid

Staging ID is invalid (or not associated with Session ID)

Pickup Request has no shipments

B2BSubmitPickupRequest: Example Request




<soap:Body> <B2BSubmitPickupRequest xmlns="http://pittohio.com/">



<sendEmailToRequester>true</sendEmailToRequester>

</B2BSubmitPickupRequest>

</soap:Body>

</soap:Envelope>


of 30

B2BSubmitPickupRequest: Example Response





<soap:Body>

<B2BSubmitPickupRequestResponse xmlns="http://pittohio.com/">

<B2BSubmitPickupRequestResult>

<PickupNumber>888</PickupNumber>

<PickupPBEID>X448436</PickupPBEID>

<PickupTerminal>TEST TEST TEST</PickupTerminal>

<PickupTerminalPhone>0-000-000-0000</PickupTerminalPhone>

</B2BSubmitPickupRequestResult>

</B2BSubmitPickupRequestResponse>

</soap:Body>

</soap:Envelope>

version 1 - pitt ohio express...b2b pickup request user’s guide v 1.0 page 5 of 30 method:...

Documents