PrintAvailability
 


Availability Submit DTD

The following DTD defines the Availability Submit document:

 <!ELEMENT XML_Availability_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 (
        LineInfo+ ) >
        <!ELEMENT LineInfo (
                  AssignedID ,
                  RefIDQual ,
                  RefID ) >

        <!ELEMENT AssignedID        (#PCDATA) >
        <!ELEMENT RefIDQual         (#PCDATA) >
        <!ELEMENT RefID             (#PCDATA) >

    <!ELEMENT Summary (
        NbrOfSegments ) >
        <!ELEMENT NbrOfSegments     (#PCDATA) >

Following is an example of an Availability submit document:

<XML_Availability_Submit>
    <Header>
      <UserName>INSERT_ID_HERE</UserName>
      <Password>INSERT_PASSWORD_HERE</Password>
      <TransSetIDCode>846SEND</TransSetIDCode>
      <TransControlID>10000</TransControlID>
      <ResponseVersion>1.4</ ResponseVersion>
    </Header>
    <Detail>
      <LineInfo>
        <AssignedID>001</AssignedID>
        <RefIDQual>VP</RefIDQual>
        <RefID>10226038</RefID>
      </LineInfo>
      <LineInfo>
        <AssignedID>002</AssignedID>
        <RefIDQual>VP</RefIDQual>
        <RefID>10044868</RefID>
      </LineInfo>
    </Detail>
    <Summary>
      <NbrOfSegments/>
    </Summary>
</XML_Availability_Submit>

Availability Submit Data Fields

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

Element Name
Optional
Required
Description
Data
Type
Max Len
Header R      
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 ‘846SEND’ A/N 7
TransControlID R Unique tracking identifier assigned by the customer for each Availability request document 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 documents with reduced data content and functionality
A/N 20
Detail R      
LineInfo   Minimum of 1 per Availability request document, but multiple are allowed    
AssignedID R Unique tracking identifier assigned by the customer for each detail line (item) requested within the Availability document  A/N 100
RefIDQual R Two character code identifying the part number type that was contained in the Availability request document.  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 an availability request is being submitted A/N 20
Summary R      
NbrOfSegments R Obsolete , no value is required    
The actual maximum length is not documented.  Include on each XML document submitted the UserName and Password values assigned by your Master/Admin user.
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.

Availability Response DTD

The following DTD defines the Availability Response document:

<!ELEMENT XML_Availability_Response (
     Header ,
     Detail ,
     Summary ) >
 
    <!ELEMENT   Header (
                TransSetIDCode,
                TransControlID?,
                ResponseVersion? ) >
               
        <!ELEMENT TransSetIDCode            (#PCDATA) >
        <!ELEMENT TransControlID            (#PCDATA) >
        <!ELEMENT ResponseVersion           (#PCDATA) >
 
    <!ELEMENT Detail (
              LineInfo+ ) >

        <!ELEMENT    LineInfo (
                     AssignedID? ,
                     RefIDQual1? ,
                     RefID1? ,
                     RefIDQual2? ,
                     RefID2? ,
                     RefIDQual4? ,
                     RefID4? ,
                     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 ProductWeight         (#PCDATA) >
            <!ELEMENT ItemStatus            (#PCDATA) >
 
            <!ELEMENT   WhseInfo (
                        IDCode ,
                        WhseCode? ,
                        Qty,
                        TotalOnOrderQty?,
                        OnOrderQty?,
                        OnOrderETADate? ) >
 
                <!ELEMENT IDCode            (#PCDATA) >
                <!ELEMENT WhseCode          (#PCDATA) >
                <!ELEMENT Qty               (#PCDATA) >
                <!ELEMENT TotalOnOrderQty   (#PCDATA) >
                <!ELEMENT OnOrderQty        (#PCDATA) >
                <!ELEMENT OnOrderETADate    (#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 Availability response document containing no errors sent from the XML system with the element data shown in bold:

  <XML_Availability_Response>
     <Header>
          <TransSetIDCode>846REC</TransSetIDCode>
          <TransControlID>10000</TransControlID>
          <ResponseVersion>1.4</ResponseVersion>
     </Header>
     <Detail>
          <LineInfo>
              <AssignedID>001</AssignedID>
              <RefIDQual1>VP</RefIDQual1>
              <RefID1>000000000010226038</RefID1>
              <RefIDQual2>MG</RefIDQual2>
              <RefID2>76330001</RefID2>
              <ProductWeight>17.000</ProductWeight>
              <ItemStatus>ACTIVE</ItemStatus>
              <WhseInfo>
                  <IDCode>SUWANEE, GA</IDCode>
                  <WhseCode>A021</WhseCode>
                  <Qty>4483</Qty>
                  <TotalOnOrderQty>2087</TotalOnOrderQty>
                  <OnOrderQty>87</OnOrderQty>
                  <OnOrderETADate>11/10/03</OnOrderETADate>
              </WhseInfo>
              <WhseInfo>
                  <IDCode>RESERVE</IDCode>
                  <WhseCode>A061</WhseCode>
                  <Qty>987</Qty>
                  </WhseInfo>
          </LineInfo>
          <LineInfo>
              <AssignedID>002</AssignedID>
              <RefIDQual1>VP</RefIDQual1>
              <RefID1>000000000010044868</RefID1>
              <WhseInfo>
                  <IDCode>SUWANEE, GA</IDCode>
                  <WhseCode>A021</WhseCode>
                  <Qty>-9999</Qty>
              </WhseInfo>            
              <WhseInfo>
                   <IDCode>SWEDESBORO, NJ</IDCode>
                   <WhseCode>A031</WhseCode>
                   <Qty>110</Qty>
              </WhseInfo>
          </LineInfo>
     </Detail>
     <Summary>
          <NbrOfSegments></NbrOfSegments>
     </Summary>
</XML_Availability_Response>

The Availability submit data structure should be formatted according to the standards defined previously in this document.  If an error or errors are encountered, the Availability Response will contain one or more <ErrorInfo> elements.  An Availability Response can contain elements for both valid and invalid item numbers since it is permissible for a customer to include more than one item in an Availability request.

The following is an example of an Availability Response document:

<XML_Availability_Response>
    <Header>
        <TransSetIDCode>846REC</TransSetIDCode>
        <TransControlID>10000</TransControlID>
    <ResponseVersion>1.4</ResponseVersion>
    </Header>
    <Detail>
        <LineInfo>
             <AssignedID>001</AssignedID>
             <RefIDQual1>VP</RefIDQual1>
             <RefID1>210126</RefID1>
             <RefIDQual2>MG</RefIDQual2>
             <RefID2>AB1207U</RefID2>
             <ProductWeight>7.000</ProductWeight>
             <ItemStatus>ACTIVE</ItemStatus>
             <WhseInfo>
                 <IDCode>SUWANEE, GA</IDCode>
                 <WhseCode>A1</WhseCode>
                 <Qty>589</Qty>
            </WhseInfo>
            <WhseInfo>
                <IDCode>FT WORTH, TX</IDCode>
                <WhseCode>A5</WhseCode>
                <Qty>93</Qty>
            </WhseInfo>
            <WhseInfo>
                <IDCode>FONTANA, CA</IDCode>
                <WhseCode>A6</WhseCode>
                <Qty>190</Qty>
            </WhseInfo>
        </LineInfo>
        <LineInfo>
            <AssignedID>002</AssignedID>
            <RefIDQual1>VP</RefIDQual1>
            <RefID1>450081</RefID1>
            <ErrorInfo>
                <RefIDQual3>1Q</RefIDQual3>
                <RefID3>0</RefID3>
                <ErrorDesc>Inventory Header Select - Yielded Unexpected Results</ErrorDesc>
            </ErrorInfo>
        </LineInfo>
    </Detail>
    <Summary>  
        <NbrOfSegments>19</NbrOfSegments>
    </Summary>
</XML_Availability_Response>

Availability Response Data Fields

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

Element Name
Optional
Required
Description
Data
Type
Max Len
Header R      
TransSetIDCode R Value will be ‘846REC’ A/N 6
TransControlID R Unique tracking identifier assigned by the customer for each Availability request document submitted. The content of the element sent by the customer within the XML document is returned as is to the customer within the Response document.  The primary function of these types of elements is for tracking purposes. A/N 100
ResponseVersion O Designates the Response DTD version
• ResponseVersion 1.3 or higher
A/N 20
Detail R      
LineInfo R Minimum of 1 per Availability response document, but multiple could occur.    
AssignedID R Unique tracking identifier assigned by the customer for each detail line (item) requested within the Availability document. The content of the element sent by the customer within the XML document is returned as is to the customer within the Response document.  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 Availability request document.  It identifies the part number type that is contained in the following <RefID1> 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 being inquired A/N 20
RefIDQual2 O Two character code identifying the part number type that was contained in the Availability request document.  It identifies the part number type that is contained in the following <RefID2> 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 being inquired A/N 20
RefIDQual4 O Two character code identifying the part number type that was contained in the Availability request document.  It identifies the part number type that is contained in the following <RefID4> 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)
• ResponseVersion 1.3 or higher
N/A 2
RefID4 O Alternate part number for which an availability request is being submitted.
• ResponseVersion 1.3 or higher
N/A 20
ProductWeight O Weight of the requested item.
• ResponseVersion 1.3 or higher
N 9
ItemStatus O Tech Data status of the requested item. Possible values include:
  • NEW
  • ACTIVE
  • PHASEDOUT
  • ALLOCATED
  • COMPONENTS
• ResponseVersion 1.3 or higher
A/N 14
WhseInfo        
IDCode R Warehouse name, e.g. SUWANEE, GA; SWEDESBORO, NJ; etc.  For a complete list of Tech Data’s logistic centers, refer to Warehouse Codes in the Order submit section A/N 16
WhseCode O Tech Data warehouse identifier.  For a complete list of Tech Data’s logistic centers, refer to Warehouse Codes in the Order submit section.
• ResponseVersion 1.4 or higher
A/N 4
Qty R Quantity of item in the warehouse.  N 15
TotalOnOrderQty O The total number on order for the warehouse.
• ResponseVersion 1.3 or higher
N 12
OnOrderQty O The earliest Expected-To-Arrive quantity for the warehouse. Is a sub-set of TotalOnOrderQty.
• ResponseVersion 1.3 or higher
N 10
OnOrderETADate O The earliest Expected-To-Arrive date for the warehouse. (format mm/dd/yy)
• ResponseVersion 1.3 or higher
A/N 8
ErrorInfo        
RefIDQual3 O Will contain ‘1Q’ A/N 2
RefID3 O Will contain ‘0’ N 1
ErrorDesc O Error description A/N 250
Summary R Obsolete, disregard this value    
NbrOfSegments R Obsolete, disregard this value N 9
©2015 Tech Data Corporation. All Rights Reserved. Tech Data proprietary and confidential