Print ShipVia

ShipVia Submit DTD

To obtain a list of eligible ship vias for a product, warehouse and postal code, you must create a ‘submit data structure’ formatted according to the supplied Document Type Definition. The submit data structure is then sent to Tech Data via an HTTPS POST. The returned document will contain a list of validated domestic ship vias that can be used to ship the designated item from the desired warehouse to the specified ship-to location.

Note:
 If you wish to ship internationally, you should contact your Tech Data sales representative.

The following DTD defines the ShipVia Submit message:

<!ELEMENT XML_ShipVia_Submit (
      Header ,
      Detail ,
      Summary ) >
    <!ELEMENT   Header (
                UserName,
                Password,
                TransSetIDCode ,
                TransControlID ,
                ResponseVersion? ) >
        <!ELEMENT UserName          (#PCDATA) >
        <!ELEMENT Password          (#PCDATA) >
        <!ELEMENT TransSetIDCode    (#PCDATA) >
        <!ELEMENT TransControlID    (#PCDATA) >
        <!ELEMENT ResponseVersion   (#PCDATA) >
    <!ELEMENT Detail (
              PostalCode ,
              LineInfo+ ) >
        <!ELEMENT PostalCode        (#PCDATA) >
        <!ELEMENT LineInfo (
                  AssignedID ,
                  RefIDQual ,
                  RefID ,
                  WhseCode ) >
            <!ELEMENT AssignedID    (#PCDATA) >
            <!ELEMENT RefIDQual     (#PCDATA) >
            <!ELEMENT RefID         (#PCDATA) >
            <!ELEMENT WhseCode      (#PCDATA) >
    <!ELEMENT Summary (
        NbrOfSegments ) >
        <!ELEMENT NbrOfSegments     (#PCDATA) >

Following is an example of a ShipVia submit message with the element contents shown in bold:

<XML_ShipVia_Submit>
      <Header>
            <UserName>INSERT_ID_HERE</UserName>
            <Password>INSERT_PASSWORD_HERE</Password>
            <TransSetIDCode>853SEND</TransSetIDCode>
            <TransControlID>10000</TransControlID>
            <ResponseVersion >1.4</ResponseVersion>
      </Header>
      <Detail>
            <PostalCode>34681</PostalCode>
            <LineInfo>
                  <AssignedID>001</AssignedID>
                  <RefIDQual>VP</RefIDQual>
                  <RefID>180054</RefID>
                  <WhseCode>A1</WhseCode>
            </LineInfo>
            <LineInfo>
                  <AssignedID>002</AssignedID>
                  <RefIDQual>VP</RefIDQual>
                  <RefID>884554</RefID>
                  <WhseCode>A3</WhseCode>
            </LineInfo>
      </Detail>
      <Summary>
            <NbrOfSegments/>
      </Summary>
</XML_ShipVia_Submit>

ShipVia Submit Data Fields

The following table provides a detail description of each element defined in the XML_ShipVia_Submit.dtd.

Element Name
Optional
Required
Description
Data
Type
Max Len
Header        
UserName R EC logon ID assigned by Tech Data A/N Note 1
Password R Password assigned by Tech Data A/N Note 1
TransSetIDCode R Value must be 853Send A/N 7
TransControlID R Unique tracking identifier assigned by the customer for each ShipVia message submitted A/N 100
ResponseVersion O Designates the Response DTD version that will be returned.
  • If omitted, the oldest supported Response DTD version is returned
  • In order to receive the latest functionality, you should specify the “highest” available (newest) Response DTD version number
  • Using older version numbers will generate legacy Response messages with reduced data content and functionality
 A/N 20
Detail        
PostalCode  R Destination postal code to which the Ship Via request is being submitted. PostalCode is a required element and should not be blank. A/N 9
LineInfo   Minimum of 1 per ShipVia request message, but multiple are allowed    
AssignedID O Unique tracking identifier assigned by the customer for each detail line (item) requested within the ShipVia request  message.  A/N 100
RefIDQual R Two character code identifying the part number type that was contained in the ShipVia request message.  It identifies the part number type that is contained in the proceeding <RefID> element. 
Value Meaning
VP Tech Data item number
BP Buyer Part (customer’s) item number. See Note 2 at the end of this  table.
MG Manufacturer’s item number
UP UPC (Universal Product Code)
A 2
RefID R The part number for which a Ship Via request is being submitted. A/N 20
WhseCode R Tech Data warehouse identifier for the request. For a complete list of Tech Data’s logistic centers, refer to the Warehouse Codes heading found in the Order submit section of this document. WhseCode is a required element and should not be blank. A/N 2
Summary        
NbrOfSegments R Obsolete (being phased out), disregard this value N 9
Note 1
The actual maximum length is not documented.  Include on each XML message submitted the UserName and Password values assigned by your Master/Admin user.
Note 2
If Buyer Part numbers are to be submitted, contact your Tech Data Sales team to have your Buyer Part number to Tech Data Item number cross-reference established on our system.

ShipVia Response DTD

The following DTD defines the Ship Via Response message:

<!ELEMENT XML_ShipVia_Response (
      Header ,
      Detail ,
      Summary ) >
    <!ELEMENT   Header (
                  TransSetIDCode ,
                  TransControlID? ,
                  ResponseVersion? ) >
        <!ELEMENT TransSetIDCode    (#PCDATA) >
        <!ELEMENT TransControlID    (#PCDATA) >
        <!ELEMENT ResponseVersion   (#PCDATA) >
    <!ELEMENT Detail (
              PostalCode? ,
              LineInfo+ ) >
        <!ELEMENT PostalCode        (#PCDATA) >
        <!ELEMENT   LineInfo (
                  AssignedID? ,
                  RefIDQual1? ,
                  RefID1? ,
                  RefIDQual2? ,
                  RefID2? ,
                  RefIDQual4? ,
                  RefID4? ,
                  ProductDesc? ,
                  ProductWeight? ,
                  ItemStatus? ,
                  WhseInfo* ,
                  ErrorInfo* ) >
            <!ELEMENT AssignedID    (#PCDATA) >
            <!ELEMENT RefIDQual1    (#PCDATA) >
            <!ELEMENT RefID1        (#PCDATA) >
            <!ELEMENT RefIDQual2    (#PCDATA) >
            <!ELEMENT RefID2        (#PCDATA) >
            <!ELEMENT RefIDQual4    (#PCDATA) >
            <!ELEMENT RefID4        (#PCDATA) >
            <!ELEMENT ProductDesc   (#PCDATA) >
            <!ELEMENT ProductWeight (#PCDATA) >
            <!ELEMENT ItemStatus    (#PCDATA) >
            <!ELEMENT   WhseInfo (
                        WhseCode ,
                        WhseDesc ,
                        ShipViaInfo+ ) >
                <!ELEMENT WhseCode (#PCDATA) >
                <!ELEMENT WhseDesc (#PCDATA) >
                <!ELEMENT ShipViaInfo (
                        ShipViaCode  ,
                        ShipViaDesc ,
                        ShipmentTypeCode ,
                        ShipmentTypeDesc   ) >
                    <!ELEMENT ShipViaCode       (#PCDATA) >
                    <!ELEMENT ShipViaDesc       (#PCDATA) >
                    <!ELEMENT ShipmentTypeCode  (#PCDATA) >
                    <!ELEMENT ShipmentTypeDesc  (#PCDATA) >
            <!ELEMENT   ErrorInfo (
                        RefIDQual3? ,
                        RefID3? ,
                        ErrorDesc? ) >
                <!ELEMENT RefIDQual3            (#PCDATA) >
                <!ELEMENT RefID3                (#PCDATA) >
                <!ELEMENT ErrorDesc             (#PCDATA) >
    <!ELEMENT   Summary ( NbrOfSegments ) >
        <!ELEMENT NbrOfSegments                 (#PCDATA) >

Following is an example of a formatted Ship Via response document containing no errors sent from the XML system with the element data shown in bold:

<XML_ShipVia_Response>
  <Header>
            <TransSetIDCode>853REC</TransSetIDCode>
            <TransControlID>10001</TransControlID>
            <ResponseVersion>1.3</ResponseVersion>
     </Header>
     <Detail>
          <PostalCode>33611</PostalCode>
          <LineInfo>
                   <AssignedID>002</AssignedID>
                  <RefIDQual1>VP</RefIDQual1>
                  <RefID1>884554</RefID1>
                  <RefIDQual2>MG</RefIDQual2>
                  <RefID2>PA1207U-T2C</RefID2>
                  <ProductWeight>17.000</ProductWeight>
                  <ItemStatus>ACTIVE</ItemStatus>
                  <WhseInfo>
                        <WhseCode>A1</WhseCode>
                        <WhseDesc>MIAMI, FL</WhseDesc>
                        <ShipViaInfo>
                            <ShipViaCode>FFPU</ShipViaCode>
                            <ShipViaDesc>FREIGHT FORWARDER CPU</ShipViaDesc>
                            <ShipmentTypeCode>CUST</ShipmentTypeCode>
                            <ShipmentTypeDesc>CUSTOMER</ShipmentTypeDesc>
                        </ShipViaInfo>
                  </WhseInfo>
           </LineInfo>
           <LineInfo>
                  <AssignedID>003</AssignedID>
                  <RefIDQual1>VP</RefIDQual1>
                  <RefID1>884554</RefID1>
                  <RefIDQual2>MG</RefIDQual2>
                  <RefID2>PA1207U-T2C</RefID2>
                  <ProductWeight>17.000</ProductWeight>
                  <ItemStatus>ACTIVE</ItemStatus>
                  <WhseInfo>
                        <WhseCode>A1</WhseCode>
                        <WhseDesc>MIAMI, FL</WhseDesc>
                        <ShipViaInfo>
                            <ShipViaCode>FFPU</ShipViaCode>
                            <ShipViaDesc>FREIGHT FORWARDER CPU</ShipViaDesc>
                            <ShipmentTypeCode>CUST</ShipmentTypeCode>
                            <ShipmentTypeDesc>CUSTOMER</ShipmentTypeDesc>
                        </ShipViaInfo>
                  </WhseInfo>
           </LineInfo>
      </Detail>
      <Summary>
          <NbrOfSegments>111</NbrOfSegments>
      </Summary>
</XML_ShipVia_Response>

ShipVia Response Data Fields

The following table provides a detail description of each element defined in the XML_ShipVia_Response.dtd

Element Name
Optional
Required
Description
Data
Type
Max Len
Header        
TransSetIDCode R Value must be ‘853REC’ A/N 6
TransControlID R Unique tracking identifier assigned by the customer for each Ship Via request message submitted. The content of the element sent by the customer within the XML message is returned as is to the customer within the Response message for tracking purposes. A/N 100
ResponseVersion O Designates the Response DTD version A/N 20
Detail        
PostalCode

R

 Postal code associated with the Ship Via information    
LineInfo

R

 Minimum of 1 per Ship Via response message, but multiple could occur    
AssignedID O Unique tracking identifier assigned by the customer for each detail line (item) requested within the Ship Via message. The content of the element sent by the customer within the XML message is returned as is to the customer within the Response message.  The primary function of these types of elements is for tracking purposes.  A/N 100
RefIDQual1 R Two character code identifying the part number type that was contained in the Ship Via request message.  It identifies the part number type that is contained in the proceeding <RefID> element. 
Value Meaning
VP Tech Data item number
BP Buyer Part (customer’s) item number
MG Manufacturer’s item number
UP UPC (Universal Product Code)
A 2
RefID1 R The part number for which the Ship Via request is being submitted A/N 20
RefIDQual2 O Two character code identifying the part number type that was contained in the Ship Via request message.  It identifies the part number type that is contained in the proceeding <RefID> element. 
Value Meaning
VP Tech Data item number
BP Buyer Part (customer’s) item number
MG Manufacturer’s item number
UP UPC (Universal Product Code)
A 2
RefID2 O Alternate part number for which the Ship Via request is being submitted A/N 20
RefIDQual4 O Two character code identifying the part number type that was contained in the Ship Via request message.  It identifies the part number type that is contained in the proceeding <RefID> element. 
Value Meaning
VP Tech Data item number
BP Buyer Part (customer’s) item number
MG Manufacturer’s item number
UP UPC (Universal Product Code)
A 2
RefID4 O Alternate part number for which the Ship Via request is being submitted A/N 20
ProductDesc R Description of requested item A/N 50
ProductWeight O Weight of the requested item N 9
ItemStatus O Tech Data status of the requested item. Possible values include:
  • NEW
  • ACTIVE
  • PHASED OUT
  • ALLOC
  • COMPON
  • DIS-TD
  • DIS-VN
  • SP-ORD
 A 6
WhseInfo        
WhseCode R Tech Data warehouse identifier.  For a complete list of Tech Data’s logistic centers, refer to the Warehouse Codes heading found in the Order submit section of this document. A/N 2
WhseDesc R Warehouse location name, i.e. MIAMI, FL, NORCROSS, GA, etc.  For a complete list of Tech Data’s logistic centers, refer to the Warehouse Codes heading found in the Order submit section of this document. A/N 16
ShipViaInfo        
ShipViaCode O Tech Data ship via code A/N 4
ShipViaDesc O Ship Via description A/N 25
ShipmentTypeCode O Shipment Type code
• ResponseVersion of 1.4 or higher
 A/N 4
ShipmentTypeDesc O Shipment Type description
• ResponseVersion of 1.4 or higher
 A/N 25
ErrorInfo        
RefIDQual3 O Value must be ‘1Q’ A/N 2
RefID3 O Value must be ‘0’ N 1
ErrorDesc O Error description A/N 250
Summary        
NbrOfSegments R Obsolete (being phased out), disregard this value N 9
©2007 Tech Data Corporation. All Rights Reserved. Tech Data proprietary and confidential