Print Order Status


Order Status Submit DTD

You can get three kinds of order status:

The Order Status DTD:

<!ELEMENT XML_OrderStatus_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 (
        PurposeCode ,
        EDIInd ,
        NonEDIInd ,
        LineStatusInd? ,
        RefInfo+ ) >
        <!ELEMENT PurposeCode           (#PCDATA) >
        <!ELEMENT EDIInd                (#PCDATA) >
        <!ELEMENT NonEDIInd             (#PCDATA) >
        <!ELEMENT LineStatusInd         (#PCDATA) >
        <!ELEMENT   RefInfo (
            RefIDQual,
            RefID )+ >
            <!ELEMENT RefID             (#PCDATA) >
            <!ELEMENT RefIDQual         (#PCDATA) >
    <!ELEMENT Summary ( NbrOfSegments ) >
        <!ELEMENT NbrOfSegments         (#PCDATA) >

Order Status Submit (Order Detail, PurposeCode = ’01’)

Following is an example of a formatted Order Status (PurposeCode = '01') submit message:

<XML_OrderStatus_Submit>
    <Header>
        <UserName>INSERT_ID_HERE</UserName>
        <Password>INSERT_PASSWORD_HERE</Password>
        <TransSetIDCode>869</TransSetIDCode>
        <TransControlID>10000</TransControlID>
        <ResponseVersion>1.3</ResponseVersion>
    </Header>
    <Detail>
        <PurposeCode>01</PurposeCode>
        <EDIInd>N</EDIInd>
        <NonEDIInd>Y</NonEDIInd>
        <RefInfo>
            <RefIDQual>PO</RefIDQual>
            <RefID>222222</RefID>
        </RefInfo>
    </Detail>
    <Summary>
        <NbrOfSegments/>
    </Summary>
</XML_OrderStatus_Submit>

Order Status Submit (Invoice Detail, PurposeCode=’02’)

Following is an example of a formatted Order/Invoice Detail (PurposeCode = '02') submit message using a sales order number:

<XML_OrderStatus_Submit>
    <Header>
        <UserName>INSERT_ID_HERE</UserName>
        <Password>INSERT_PASSWORD_HERE</Password>
        <TransSetIDCode>869</TransSetIDCode>
        <TransControlID>10000</TransControlID>
        <ResponseVersion>1.3</ResponseVersion>
    </Header>
    <Detail>
        <PurposeCode>02</PurposeCode>
        <EDIInd>N</EDIInd>
        <NonEDIInd>Y</NonEDIInd>
        <RefInfo>
            <RefIDQual>ON</RefIDQual>
            <RefID>0376334</RefID>
        </RefInfo>
    </Detail>
    <Summary>
        <NbrOfSegments/>
    </Summary>
</XML_OrderStatus_Submit>

 

This is an example of a formatted Order/Invoice Detail (PurposeCode = '02') submit message using an invoice number:

<XML_OrderStatus_Submit>
    <Header>
        <UserName>INSERT_ID_HERE</UserName>
        <Password>INSERT_PASSWORD_HERE</Password>
        <TransSetIDCode>869</TransSetIDCode>
        <TransControlID>10000</TransControlID>
        <ResponseVersion>1.3</ResponseVersion>
    </Header>
    <Detail>
        <PurposeCode>02</PurposeCode>
        <EDIInd>N</EDIInd>
        <NonEDIInd>Y</NonEDIInd>
        <RefInfo>
            <RefIDQual>IN</RefIDQual>
            <RefID>Z000522</RefID>
        </RefInfo>
    </Detail>
    <Summary>
        <NbrOfSegments/>
    </Summary>
</XML_OrderStatus_Submit>

Order Status Submit (Shipment Detail, PurposeCode=’03’)

Below is an example of a formatted Ship Detail (PurposeCode = '03') submit message.  Note that both a Tech Data assigned Sales Order number (RefIDQual = 'ON') and a Tech Data assigned Invoice number (RefIDQual = 'IN') related to the sales order must be included in the Ship Detail request message.

<XML_OrderStatus_Submit>
    <Header>
        <UserName>INSERT_ID_HERE</UserName>
        <Password>INSERT_PASSWORD_HERE</Password>
        <TransSetIDCode>869</TransSetIDCode>
        <TransControlID>10000</TransControlID>
        <ResponseVersion>1.3</ResponseVersion>
    </Header>
    <Detail>
        <PurposeCode>03</PurposeCode>
        <EDIInd>N</EDIInd>
        <NonEDIInd>Y</NonEDIInd>
        <RefInfo>
            <RefIDQual>ON</RefIDQual>
            <RefID>0376334</RefID>
        </RefInfo>
        <RefInfo>
            <RefIDQual>IN</RefIDQual>
            <RefID>Z000522</RefID>
        </RefInfo>
    </Detail>
    <Summary>
        <NbrOfSegments/>
    </Summary>
</XML_OrderStatus_Submit>

Order Status Submit Data Fields

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

Element Name
Optional
Required
Description
Data
Type
Max Len
Header R      
UserName R Logon ID assigned by Tech Data A/N  
Password R Password assigned by Tech Data A/N  
TransSetIDCode R Value must be ‘869’ A/N  
TransControlID R Unique tracking identifier assigned by the customer A/N 100
ResponseVersion O Response Version to be returned.
  • If omitted, the oldest Response Version is returned
  • Use the highest available version -- 1.7
A/N 20
Detail R      
PurposeCode R The type of order status being requested. 
Value Meaning
01 PO Status List
02 Order/Invoice Detail
03 Shipment/Invoice Detail
N 2
EDIInd R Canadian Customers: Always set to N

US Customers: Specify Y to include EDI orders or N to exclude EDI orders

A 1
NonEDIInd R Ignored A 1
LineStatusInd O In a Purpose 02 request, specify a Y to get line level information A 1
RefInfo R See Note    
RefIDQual R Type of identifier that will be contained in the following <RefID> element. 
Value Meaning
ON Tech Data assigned sales order number ( PurposeCode 02 or 03 only )
PO Customer assigned purchase Order number ( PurposeCode 01 only )
IN Tech Data assigned invoice number ( PurposeCode 02 or 03 only )
A 2
RefID R
  • Sales order number
  • Invoice number
  • Purchase order number
A/N ON-7
PO-25
IN-7
Summary R      
NbrOfSegments R Obsolete (being phased out), disregard this value N 9
For PurposeCode 01, multiple occurrences of <RefInfo> are permissible.  The <RefIDQual> and <RefID> elements defined under <RefInfo> will contain the requested customer's purchase order number.  For example, Order Status data for three different customer purchase orders could be requested within one Order Status request.  

For PurposeCode 02, multiple occurrences of<RefInfo> are permissible. The <RefIDQual> and <RefID> elements defined under <RefInfo> will contain the requested Tech Data assigned sales order or invoice number. For example, Order Status data for two different Tech Data assigned sales order numbers and three different Tech Data assigned invoice numbers could be requested within one Order Status request.  Note that it is sufficient to provide either a sales order number OR or an invoice number; you don't need both.

 For PurposeCode 03, two occurrences of <RefInfo> are required.  One occurrence will contain the requested Tech Data assigned sales order number and the other occurrence will contain a Tech Data assigned invoice number.  The invoice number must be associated with the sales order.  Only one 'ON' (sales order) and 'IN' (invoice number) combination is allowed within an Order Status request.  If Order Status data is required for more than one sales order, multiple Order Status requests will need to be submitted.

Order Status Response DTD

The following DTD for the Order Status and Order/Invoice Detail response messages.  The Shipment Detail DTD can be found in the following section.

Note:
Be sure to review the Order Splitting section which describes the behavior of order splitting and how it impacts Order Status and responses.

<!ELEMENT XML_OrderStatus_Response (
    Header ,
    Detail* ,
    Summary ) >
    <!ELEMENT Header (
        TransSetIDCode ,
        TransControlID? ,
        ResponseVersion? ) >
        <!ELEMENT TransSetIDCode    (#PCDATA) >
        <!ELEMENT TransControlID    (#PCDATA) >
        <!ELEMENT ResponseVersion   (#PCDATA) >
        <!ELEMENT Detail (
            PurposeCode? ,
            RefInfo+ ,
            ErrorInfo? ,
            OrderStatus? ,
            Terms?,
            CurrencyType? ,
            ShipmentDispQual? ,
            ShipmentDisp? ,
            PackageDispQual?  ,
            PackageDisp? ,
            BillToAcctNbr? ,
            ShipToName? ,
            ShipToAddr1? ,
            ShipToAddr2? ,
            ShipToAddr3? ,
            ShipToCity? ,
            ShipToStateProv?  ,
            ShipToPostalCode? ,
            InvoiceTotal? ,
            PaymentTotal? ,
            HandlingCharge? ,
            CODCharge? ,
            NetFreightCharge? ,
            StateFee? ,
            EstimatedShipDate? ,
            LineInfo+ ,
            NbrOfOrderLines? ) >
            <!ELEMENT PurposeCode        (#PCDATA) >
            <!ELEMENT RefInfo (
                RefIDQual,
                RefID  )>
                <!ELEMENT RefIDQual      (#PCDATA) >
                <!ELEMENT RefID          (#PCDATA) >
            <!ELEMENT ErrorInfo (
                ErrorIDQual ,
                ErrorID ,
                ErrorDesc ) >
                <!ELEMENT ErrorIDQual   (#PCDATA) >
                <!ELEMENT ErrorID       (#PCDATA) >
                <!ELEMENT ErrorDesc     (#PCDATA) >
            <!ELEMENT OrderStatus       (#PCDATA) >
            <!ELEMENT Terms             (#PCDATA) >
            <!ELEMENT CurrencyType      (#PCDATA) >
            <!ELEMENT ShipmentDispQual  (#PCDATA) >
            <!ELEMENT ShipmentDisp      (#PCDATA) >
            <!ELEMENT PackageDispQual   (#PCDATA) >
            <!ELEMENT PackageDisp       (#PCDATA) >
            <!ELEMENT BillToAcctNbr     (#PCDATA) >
            <!ELEMENT ShipToName        (#PCDATA) >
            <!ELEMENT ShipToAddr1       (#PCDATA) >
            <!ELEMENT ShipToAddr2       (#PCDATA) >
            <!ELEMENT ShipToAddr3       (#PCDATA) >
            <!ELEMENT ShipToCity        (#PCDATA) >
            <!ELEMENT ShipToStateProv   (#PCDATA) >
            <!ELEMENT ShipToPostalCode  (#PCDATA) >
            <!ELEMENT ContactFuncCode   (#PCDATA) >
            <!ELEMENT ContactName       (#PCDATA) >
            <!ELEMENT InvoiceTotal      (#PCDATA) >
            <!ELEMENT PaymentTotal      (#PCDATA) >
            <!ELEMENT HandlingCharge    (#PCDATA) >
            <!ELEMENT CODCharge         (#PCDATA) >
            <!ELEMENT NetFreightCharge  (#PCDATA) >
            <!ELEMENT StateFee          (#PCDATA) >
            <!ELEMENT EstimatedShipDate (#PCDATA) >
            <!ELEMENT LineInfo (
                AssignedID ,
                ProductIDQual ,
                ProductID,
                ProductIDQual2 ,
                ProductID2,
                ProductDesc ,
                LineStatus?,
                UnitPrice ,
                ExtendedPrice ,
                WhseDesc,
                ShipViaDesc ,
                QtyOrdered ,
                QtyShipped ,
                QtyBackordered,
                QtyReturned ,
                DateShipped? ,
                ItemEstimatedShipDate?,  
                LineErrorInfo? ) >
                <!ELEMENT AssignedID     (#PCDATA) >
                <!ELEMENT ProductIDQual  (#PCDATA) >
                <!ELEMENT ProductID      (#PCDATA) >
                <!ELEMENT ProductIDQual2 (#PCDATA) >
                <!ELEMENT ProductID2     (#PCDATA) >
                <!ELEMENT ProductDesc    (#PCDATA) >
                <!ELEMENT LineStatus     (#PCDATA) >
                <!ELEMENT UnitPrice      (#PCDATA) >
                <!ELEMENT ExtendedPrice  (#PCDATA) >
                <!ELEMENT WhseDesc       (#PCDATA) >
                <!ELEMENT ShipViaDesc    (#PCDATA) >
                <!ELEMENT QtyOrdered     (#PCDATA) >
                <!ELEMENT QtyShipped     (#PCDATA) >
                <!ELEMENT QtyBackordered (#PCDATA) >
                <!ELEMENT QtyReturned    (#PCDATA) >
                <!ELEMENT DateShipped    (#PCDATA) >
                <!ELEMENT ItemEstimatedShipDate (#PCDATA) >
                <!ELEMENT   LineErrorInfo (
                    LineErrorID ,
                    LineErrorIDQual ,
                    LineErrorDesc ) >
                    <!ELEMENT LineErrorID      (#PCDATA) >
                    <!ELEMENT LineErrorIDQual  (#PCDATA) >
                    <!ELEMENT LineErrorDesc    (#PCDATA) >
                    <!ELEMENT NbrOfOrderLines  (#PCDATA) >
    <!ELEMENT Summary (  NbrOfSegments ) >
        <!ELEMENT NbrOfSegments                (#PCDATA) >

Example of a response to an Order Status request (PurposeCode = '01').

<XML_OrderStatus_Response>
    <Header>
        <TransSetIDCode>870</TransSetIDCode>
        <TransControlID>10000</TransControlID>
        <ResponseVersion>1.3</ResponseVersion>
    </Header>
    <Detail>
        <PurposeCode>01</PurposeCode>
        <RefInfo>
            <RefIDQual>PO</RefIDQual>
            <RefID>222222</RefID>
        </RefInfo>
        <RefInfo>
            <RefIDQual>ON</RefIDQual>
            <RefID>0461834</RefID>
        </RefInfo>
        <OrderStatus>ON-HOLD</OrderStatus>
        <Terms>NO TERMS</Terms>
        <ContactName>TEST API</ContactName>
        <InvoiceTotal>35.88</InvoiceTotal>
    </Detail>
    <Detail>
        <PurposeCode>01</PurposeCode>
        <RefInfo>
            <RefIDQual>PO</RefIDQual>
            <RefID>222222</RefID>
        </RefInfo>
        <RefInfo>
            <RefIDQual>ON</RefIDQual>
            <RefID>9361834</RefID>
        </RefInfo>
        <OrderStatus>CANCELED</OrderStatus>
        <Terms>NO TERMS</Terms>
        <ContactName>TEST API</ContactName>
        <InvoiceTotal>35.88</InvoiceTotal>
    </Detail>
    <Detail>
        <PurposeCode>01</PurposeCode>
        <RefInfo>
            <RefIDQual>PO</RefIDQual>
            <RefID>222222</RefID>
        </RefInfo>
        <RefInfo>
            <RefIDQual>ON</RefIDQual>
            <RefID>7606734</RefID>
        </RefInfo>
        <OrderStatus>ON-HOLD</OrderStatus>
        <Terms>NO TERMS</Terms>
        <ContactName>TEST API</ContactName>
        <InvoiceTotal>107.64</InvoiceTotal>
    </Detail>
    <Detail>
        <PurposeCode>01</PurposeCode>
        <RefInfo>
            <RefIDQual>PO</RefIDQual>
            <RefID>222222</RefID>
        </RefInfo>
        <RefInfo>
            <RefIDQual>ON</RefIDQual>
            <RefID>6606734</RefID>
        </RefInfo>
        <OrderStatus>ON-HOLD</OrderStatus>
        <Terms>NO TERMS</Terms>
        <ContactName>TEST API</ContactName>
        <InvoiceTotal>107.64</InvoiceTotal>
    </Detail>
    <Summary>
        <NbrOfSegments>26</NbrOfSegments>
    </Summary>
</XML_OrderStatus_Response>
 
Example of an Invoice Detail response to an Order Status request (PurposeCode = '02').

<XML_OrderStatus_Response>
    <Header>
        <TransSetIDCode>870</TransSetIDCode>
        <TransControlID>10000</TransControlID>
        <ResponseVersion>1.3</ResponseVersion>
    </Header>
    <Detail>
        <PurposeCode>02</PurposeCode>
        <RefInfo>
            <RefIDQual>PO</RefIDQual>
            <RefID>JOHN TEST</RefID>
        </RefInfo>
        <RefInfo>
            <RefIDQual>ON</RefIDQual>
            <RefID>5134734</RefID>
        </RefInfo>
        <RefInfo>
            <RefIDQual>QT</RefIDQual>
            <RefID>0521306</RefID>
        </RefInfo>
        <Terms>NET90 DAYS</Terms>
        <CurrencyType>USD</CurrencyType>
        <ShipmentDispQual>SC</ShipmentDispQual>
        <ShipmentDisp>Y</ShipmentDisp>
        <PackageDispQual>BS</PackageDispQual>
        <PackageDisp>Y</PackageDisp>
        <ShipToName>COOLCASES</ShipToName>
        <ShipToAddr1>2145 FREEZER ST</ShipToAddr1>
        <ShipToCity>CLEARWATER</ShipToCity>
        <ShipToStateProv>FL</ShipToStateProv>
        <ShipToPostalCode>33755</ShipToPostalCode>
        <ContactFuncCode>IC</ContactFuncCode>
        <ContactName>ICED ATHLON</ContactName>
        <LineInfo>
            <AssignedID>001</AssignedID>
            <ProductIDQual>VP</ProductIDQual>
            <ProductID>180054</ProductID>
            <ProductDesc>GSX-230 24-PIN PRINTER</ProductDesc>
            <UnitPrice>174.76</UnitPrice>
            <ExtendedPrice>174.76</ExtendedPrice>
            <WhseDesc>MIAMI, FL</WhseDesc>
            <ShipViaDesc>UPS GROUND</ShipViaDesc>
            <QtyOrdered>1</QtyOrdered>
            <QtyShipped>0</QtyShipped>
            <QtyBackordered>1</QtyBackordered>
            <QtyReturned>0</QtyReturned>
        </LineInfo>
        <NbrOfOrderLines>1</NbrOfOrderLines>
    </Detail>
    <Summary>
        <NbrOfSegments>7</NbrOfSegments>
    </Summary>
</XML_OrderStatus_Response>

Order Status Response Data Fields


Element Name
Optional
Required
Description
Data
Type
Max Len
Header        
TransSetIDCode R Value must be 870 N  
TransControlID O Unique tracking identifier assigned by the customer A/N 100
ResponseVersion O
ResponseVersion 1.3 or higher
A/N 20
Detail        
PurposeCode O The type of order status
Value Meaning
01 Purchase order status
02 Order/invoice detail
   
RefInfo R Minimum of 1 per Order Status response message, but multiple could occur    
RefIDQual R The type of identifier in the proceeding <RefID> element. 
Value Meaning
AY Floor plan number
EU Customer assigned end user purchase order number
IN Tech Data assigned invoice number
ON Tech Data assigned sales order number
PO Customer assigned purchase order number
QT Tech Data assigned quote number (for phone and fax orders)
A 2
RefID R
  • Floor plan number
  • End user purchase order number
  • Invoice number
  • Sales order number
  • Purchase order number
  • Quote number
  • A/N AY-3
    EU-25
    IN-7
    ON-7
    PO-25
    QT-25
    ErrorInfo O      
    ErrorIDQual O Value must be ‘1Q’ A/N 2
    ErrorID O Value must be ‘0’ N 1
    ErrorDesc O Error description A/N 250
    OrderStatus O (Purpose Code 1 only) 
    Status Meaning
    ON-HOLD The order has been entered into Tech Data's system, but requires attention before it can be released to a distribution center for fulfillment
    OPEN The order has been entered into Tech Data's system and no Holds are currently assigned.  The order has not yet been released to a distribution center for fulfillment
    CANCELED The order has been canceled
    WHSE RLSE The order has been released to a logistics center and has begun the fulfillment process
    HOLD RLSE The order has been released to a logistics center - fulfillment pending
    PARTIAL Some but not all the order lines of the order have been shipped by Tech Data's logistics centers
    INVOICED The order has been shipped and a bill generated
    A/N  
    Terms O Payment conditions under which the order was accepted A/N 30
    CurrencyType O Only ‘USD’ (U.S. Dollars) is used at this time A  
    ShipmentDispQual O Always ‘SC’ (Ship Complete) A  
    ShipmentDisp O
    Value Meaning
    Y If all items for the order are not available for shipment, the order is not shipped until the order can be filled completely
    N Products will be shipped as the become available
    A  
    PackageDispQual O Value must be ‘BS’ (Blind Ship)    
    PackageDisp O Whether the order will be shipped without Tech Data’s name and logo on the shipping documents .
    Value Meaning
    Y Blind shipping – Tech Data’s name and logo are not contained on the shipping documents
    N Normal Tech Data packaging
       
    BillToAcctNbr O Shipping account number of the customer on whose behalf the order was placed  Only FedEx account numbers are available at this time N 9
    ShipToName O The name of the individual or organization receiving the order A/N 25
    ShipToAddr1 O The first street address line of the individual or organization receiving the order A/N 25
    ShipToAddr2 O The second street address line of the individual or organization receiving the order A/N 25
    ShipToAddr3 O The third street address line of the individual or organization receiving the order A/N 25
    ShipToCity O City destination name A/N 12
    ShipToStateProv O U.S. state or Canadian province destination abbreviation A/N 2
    ShipToPostalCode O U.S. zip code or Canadian postal code of destination receiving order A/N 9
    ContactName O Contact person’s name assigned to order A/N 25
    InvoiceTotal O Total dollar amount of invoice.  A single order can generate multiple invoices when multiple warehouses are used to fill an order and/or when a previously backordered line is shipped.
    • ResponseVersion 1.7 or higher
    N 15(2)
    HandlingCharge O Total dollar amount of handling charges.
    • ResponseVersion 1.7 or higher
    N 15(2)
    NetFreightCharge O The cost associated with shipping the container based on the carrier, weight, destination, insurance, and freight discount (if any). N 15(2)
    StateFee O The amount of state fees charged to the order
    • ResponseVersion 1.6 or higher
    N/A N/A
    EstimatedShipDate O (PurposeCode 01) Estimated date (YYMMDD) that a backordered item will be shipped to the customer. The tag will be empty if Tech Data does not have an open PO with the Vendor.
    • ResponseVersion 1.5 or higher
    N 6
    LineInfo        
    AssignedID O (PurposeCode 02) Unique tracking identifier assigned by the customer in the OrigCustPOLineNbr tag in the corresponding line item of the order. If no OrigCustPOLineNbr was specified, the Tech Data line number is returned.
    • ResponseVersion 1.5 or higher
    A/N 100
    ProductIDQual O Value must be ‘VP’ A  
    ProductID O Tech Data item number A/N 20
    ProductIDQual2 O Value must be ‘MG’
    • ResponseVersion 1.6 or higher
    A  
    ProductID2 O Manufacturer’s item number
    • ResponseVersion 1.6 or higher
    A/N 20
    ProductDesc O Description of item A/N 50
    LineStatus O (Purpose Code 2) Status of the line item.  This is different from the Order Status which applies to the whole order. Only returned if LineStatusInd=Y is submitted in the order line
    Status Meaning
    ON-HOLD The order has been entered into Tech Data's system, but requires attention before it can be released to a distribution center for fulfillment
    OPEN The order has been entered into Tech Data's system and no Holds are currently assigned.  The order has not yet been released to a distribution center for fulfillment
    CANCELED The line item has been canceled
    RELEASED The line item has been released to a logistics center and has begun the fulfillment process
    PARTIAL Some but not all the items ordered have been shipped by Tech Data's logistics centers
    INVOICED The line item has been shipped and a bill generated
    • ResponseVersion 1.3 or higher
    A/N 20
    UnitPrice O Customer’s price for one unit of item ordered N 15(2)
    ExtendedPrice O Total price of order line (UnitPrice x QtyOrdered) N 15(2)
    WhseDesc O Tech Data Warehouse shipping this order line A/N 30
    ShipViaDesc O Carrier name and mode, i.e. ‘UPS GROUND’ or FEDEX NEXT DAY’ A/N 25
    QtyOrdered O The number of units ordered N 4
    QtyShipped O The number of units of the item that was shipped N 4
    QtyBackordered O The number of units that were not available for shipment at the time the order was filled.  This quantity is backordered to Tech Data’s vendor. N 4
    QtyReturned O The number of units previously shipped that were subsequently sent back to Tech Data through an authorized return. N 4
    DateShipped O Date on which shipment was initiated.
     In YYMMDD format.  Example: July 15, 2002 is represented as 020715
    N 6
    ItemEstimatedShipDate O (Purpose Code 02) Estimated date that a back ordered item will be shipped. The tag will be empty if Tech Data does not have an open PO with the Vendor.
    Canadian customers only: For vendor drop ship (warehouse 99) orders, contains the date that the order is estimated to be shipped to the customer.
    In YYMMDD format. Example: July 15, 2002 is represented as 020715
    • ResponseVersion 1.5 or higher
    N 6
    NbrOfOrderLines O Total number of detail lines items being reported in the response for the specified Sales Order or Invoice number. N 3
    Summary        
    NbrOfSegments R Obsolete (being phased out), disregard this value N 9

    Shipment Detail Response DTD

    The Ship Detail response DTD.  The Order Status and Order/Invoice Detail response DTD is defined in the previous section.

    Note:
      Be sure to review the Order Splitting which describes behavior of order splitting and how it impacts Order Status responses.

    <!ELEMENT XML_ShipmentStatus_Response (
        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 (
                PurposeCode ,
                RefInfo+ ,
                ErrorInfo? ,
                ContainerInfo+ ,
                NbrOfContainers ) >
                <!ELEMENT PurposeCode       (#PCDATA) >
                <!ELEMENT RefInfo (
                    RefID,
                    RefIDQual) >
                    <!ELEMENT RefID         (#PCDATA) >
                    <!ELEMENT RefIDQual     (#PCDATA) >
                    <!ELEMENT ErrorInfo (
                        ErrorIDQual,
                        ErrorID,
                        ErrorDesc ) >
                        <!ELEMENT ErrorIDQual   (#PCDATA) >
                        <!ELEMENT ErrorID       (#PCDATA) >
                        <!ELEMENT ErrorDesc     (#PCDATA) >
                    <!ELEMENT ContainerInfo (
                        CIAssignedID,
                        ContainerID,
                        ShipToName,
                        ShipToAddr1,
                        ShipToAddr2?,
                        ShipToAddr3?,
                        ShipToCity,
                        ShipToStateProv,
                        ShipToPostalCode,
                        DateShipped,
                        DateInvoiced,
                        Weight,
                        WhseDesc,
                        ShipVia,
                        ContainerValue,
                        HandlingCharge,
                        CODCharge,
                        DebitCredit,
                        NetFreightCharge,
                        TaxCharge,
                        StateFee? ,
                        TotalOrderValue,
                        ItemInfo+ ,
                        NbrOfItems) >
                        <!ELEMENT ContainerID       (#PCDATA) >
                        <!ELEMENT ShipToName        (#PCDATA) >
                        <!ELEMENT ShipToAddr1       (#PCDATA) >
                        <!ELEMENT ShipToAddr2       (#PCDATA) >
                        <!ELEMENT ShipToAddr3       (#PCDATA) >
                        <!ELEMENT ShipToCity        (#PCDATA) >
                        <!ELEMENT ShipToStateProv   (#PCDATA) >
                        <!ELEMENT ShipToPostalCode  (#PCDATA) >
                        <!ELEMENT DateShipped       (#PCDATA) >
                        <!ELEMENT DateInvoiced      (#PCDATA) >
                        <!ELEMENT Weight            (#PCDATA) >
                        <!ELEMENT WhseDesc          (#PCDATA) >
                        <!ELEMENT ShipVia           (#PCDATA) >
                        <!ELEMENT ContainerValue    (#PCDATA) >
                        <!ELEMENT HandlingCharge    (#PCDATA) >
                        <!ELEMENT CODCharge         (#PCDATA) >
                        <!ELEMENT DebitCredit       (#PCDATA) >
                        <!ELEMENT NetFreightCharge  (#PCDATA) >
                        <!ELEMENT TaxCharge         (#PCDATA) >
                        <!ELEMENT StateFee          (#PCDATA) >
                        <!ELEMENT TotalOrderValue   (#PCDATA) >
                        <!ELEMENT ItemInfo (
                            IIAssignedID,
                            AssignedID?,
                            ProductID,
                            ProductIDQual,
                            ProductID2?,
                            ProductIDQual2?,
                            ProductDesc,
                            QtyShipped,
                            SerialInd,
                            SerialInfo*) >
                            <!ELEMENT IIAssignedID      (#PCDATA) >
                            <!ELEMENT AssignedID        (#PCDATA) >
                            <!ELEMENT ProductID         (#PCDATA) >
                            <!ELEMENT ProductIDQual     (#PCDATA) >
                            <!ELEMENT ProductID2        (#PCDATA) >
                            <!ELEMENT ProductIDQual2    (#PCDATA) >
                            <!ELEMENT ProductDesc       (#PCDATA) >
                            <!ELEMENT QtyShipped        (#PCDATA) >
                            <!ELEMENT SerialInd         (#PCDATA) >
                            <!ELEMENT SerialInfo (SerialNbr) >
                                <!ELEMENT SerialNbr     (#PCDATA) >
                    <!ELEMENT NbrOfItems                (#PCDATA) >
        <!ELEMENT Summary (
             NbrOfContainers?,
             NbrOfSegments ) >
            <!ELEMENT NbrOfContainers                   (#PCDATA) >
            <!ELEMENT NbrOfSegments                     (#PCDATA) >

    Example of a response to a Ship Detail request (PurposeCode = '03').

    <XML_ShipmentStatus_Response>
        <Header>
            <TransSetIDCode>856</TransSetIDCode>
            <TransControlID>10000</TransControlID>
            <ResponseVersion>1.5</ResponseVersion>
        </Header>
        <Detail>
            <PurposeCode>03</PurposeCode>
            <RefInfo>
                <RefIDQual>PO</RefIDQual>
                <RefID>654654654</RefID>
            </RefInfo>
            <RefInfo>
                <RefIDQual>ON</RefIDQual>
                <RefID>6835434</RefID>
            </RefInfo>
            <RefInfo>
                <RefIDQual>IN</RefIDQual>
                <RefID>Z002533</RefID>
            </RefInfo>
            <ContactFuncCode>IC</ContactFuncCode>
            <ContactName>SALLY</ContactName>
            <ContainerInfo>
                <ContainerID>1Z7493280300168667</ContainerID>
                <ShipToName>DATAFLEX</ShipToName>
                <ShipToAddr1>2145 CALUMET ST N'TH</ShipToAddr1>
                <ShipToCity>CLEARWATER</ShipToCity>
                <ShipToStateProv>FL</ShipToStateProv>
                <ShipToPostalCode>33755</ShipToPostalCode>
                <DateShipped>08/14/98</DateShipped>
                <DateInvoiced>08/14/98</DateInvoiced>
                <Weight>10.000</Weight>
                <WhseDesc>FT WORTH, TX</WhseDesc>
                <ShipVia>UPS GROUND</ShipVia>
                <ContainerValue>1326.06</ContainerValue>
                <HandlingCharge>0.00</HandlingCharge>
                <CODCharge>0.00</CODCharge>
                <DebitCredit>0.00</DebitCredit>
                <NetFreightCharge>3.50</NetFreightCharge>
                <TaxCharge>0.00</TaxCharge>
                <TotalOrderValue>1326.06</TotalOrderValue>
                <ItemInfo>
                    <IIAssignedID>001</IIAssignedID>
                    <AssignedID>015</AssignedID>
                    <ProductIDQual>VP</ProductIDQual>
                    <ProductID>515160</ProductID>
                    <ProductIDQual2>MG</ProductIDQual2>
                    <ProductID2>GHT-256C</ProductID2>
                    <ProductDesc>SMART 16/4 AT PLUS</ProductDesc>
                    <QtyShipped>2</QtyShipped>
                    <SerialInd>Y</SerialInd>
                    <SerialInfo>
                        <SerialNbr>654654</SerialNbr>
                    </SerialInfo>
                    <SerialInfo>
                        <SerialNbr>987987</SerialNbr>
                    </SerialInfo>
                </ItemInfo>
                <NbrOfItems>1</NbrOfItems>
            </ContainerInfo>
        </Detail>
        <Summary>
            <NbrOfContainers>1</NbrOfContainers>
            <NbrOfSegments>79</NbrOfSegments>
        </Summary>
    </XML_ShipmentStatus_Response>  

    Shipment Status Response Data Fields

    The following table provides a detail description of each element defined in the XML_ShipmentStatus_Response.dtd
    Element Name
    Optional
    Required
    Description
    Data
    Type
    Max Len
    Header        
    UserName O Obsolete, this element will never be in the response document    
    Password O Obsolete, this element will never be in the response document    
    TransSetIDCode R Value must be ‘856’ N 3
    TransControlID O Unique tracking identifier assigned by the customer for each Availability 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. The primary function of these types of elements is for tracking purposes. A/N 100
    ResponseVersion O Designates the Response DTD version
    • ResponseVersion of 1.3 or higher
    A/N 20
    Detail        
    PurposeCode R A code which indicating the type of response requested.  The code values that can be returned in an OrderStatus (870) format is: 03 = Ship Detail    
    RefInfo O Three occurrences per Ship Detail response.    
    RefIDQual R
    Value Meaning
    PO RefID's value will contain the Purchase Order number
    ON RefID's value will contain the Tech Data Order number
    IN RefID's value will contain the Tech Data Invoice number
    A/N 2
    RefID R Tech Data assigned Sales Order or Invoice number or customer’s Purchase Order number. A/N ON-7
    PO-25
    IN-7
    ErrorInfo O      
    ErrorIDQual O Value must be ‘1Q’ A/N 2
    ErrorID O Value must be ‘0’ N 1
    ErrorDesc O Error description A/N 250
    ContainerInfo O      
    ContainerID R The carrier’s container (tracking) number A/N 18
    ShipToName R The name of the individual or organization receiving the order A/N 25
    ShipToAddr1 R The first street address line of the individual or organization receiving the order A/N 25
    ShipToAddr2 O The second street address line of the individual or organization receiving the order A/N 25
    ShipToAddr3 O The third street address line of the individual or organization receiving the order A/N 25
    ShipToCity R City destination name A/N 12
    ShipToStateProv R U.S. state or Canadian province destination abbreviation A/N 2
    ShipToPostalCode R U.S. zip code or Canadian postal code of destination receiving order A/N 9
    DateShipped R Date order line was shipped in MMDDYY format N 6
    DateInvoiced R Date order line was invoiced in MMDDYY format N 6
    Weight R Weight of order line N 8
    WhseDesc R Location name of logistics center shipping this order item A/N 30
    ShipVia R Carrier name and mode, i.e. ‘UPS GROUND’ or FEDEX NEXT DAY’    
    ContainerValue R Total dollar value of items within container N 9(2)
    HandlingCharge R Additional fee assessed to order line for special handling N 15(2)
    CODCharge R Additional fee assessed to order line for Cash On Delivery payment term N 15(2)
    DebitCredit R An amount to be added or deducted from the COD collection amount. N 15(2)
    NetFreightCharge R The cost associated with shipping the container based on the carrier, weight, destination, insurance, and freight discount (if any). N 15(2)
    TaxCharge R The tax cost associated with shipping the container.  For orders shipped from Tech Data's Canadian logistics centers, the tax will include the GST (Goods and Services Tax). N 15(2)
    StateFee O The amount of state fees charged to the order
    • ResponseVersion 1.5 or higher
    N 15(2)
    TotalOrderValue R Container value plus any of the following additional charges that may be assessed:
    • Handling charge
    • COD charge
    • Net freight charge
    • Tax charge
    • State fees
    N 15(2)
    ItemInfo O      
    IIAssignedID R Unique tracking identifier assigned by the customer to each order line A/N 100
    AssignedID O Unique tracking identifier assigned by the customer to each order line in the <OrigCustPOLineNbr> field of the Order Submit.
    • ResponseVersion 1.5 or higher
    A/N 100
    ProductIDQual R Value must be ‘VP’ A 2
    ProductID R Tech Data item number A/N 20
    ProductIDQual2 R Value must be ‘MG’
    • ResponseVersion 1.5 or higher
    A 2
    ProductID2 R Manufacturers item number
    • ResponseVersion 1.5 or higher
    A/N 20
    ProductDesc R Description of item A/N 50
    QtyShipped R The number of units of the ordered item that were shipped N 4
    SerialInd O
    Value Meaning
    Y Item is serialized, serial number will be provided
    N Item is not serialized, no serial number provided
    A 1
    SerialInfo O      
    SerialNbr R Serial number assigned to unit assigned by the item's manufacturer. A/N 20
    NbrOfItems R Total number of order lines in container. 
    Note: A container may include multiple order lines and an order line could span across multiple containers.
    N 4
    Summary        
    NbrOfContainers O Total number of containers used to ship the order line N 4
    NbrOfSegments R Obsolete (being phased out), disregard this value N 9
    ©2008 Tech Data Corporation. All Rights Reserved. Tech Data proprietary and confidential