PrintOpenOrderLines

OpenOrderLines Submit DTD

To obtain a list of open order line items, submit an OpenOrderLines submit document via an HTTPS post.

The following DTD defines the OpenOrderLines Submit message:

   <!ELEMENT XML_OpenOrderLines_Submit (
        Header,
        Detail ) >

        <!ELEMENT Header (
        UserName,
        Password,   
        ResponseVersion? ) >

        <!ELEMENT UserName (#PCDATA) >
        <!ELEMENT Password (#PCDATA) >
        <!ELEMENT ResponseVersion (#PCDATA) >

        <!ELEMENT Detail (
        BackOrdered?,
        StartDate,
        EndDate
        ) >

        <!ELEMENT BackOrdered (#PCDATA) >
        <!ELEMENT StartDate (#PCDATA) >
        <!ELEMENT EndDate (#PCDATA) >


Following is an example of a OpenOrderLines submit message with the element contents shown in bold:
<XML_OpenOrderLines_Submit>
    <Header>
        <UserName>user</UserName>
        <Password>password</Password>
        <ResponseVersion>1.0</ResponseVersion>
    </Header>
    <Detail>
        <BackOrdered></BackOrdered>
        <StartDate>12090145454</StartDate>
        <EndDate>121001</EndDate>
    </Detail>
</XML_OpenOrderLines_Submit>

OpenOrderLines Submit Data Fields

The following table provides a detail description of each element defined in the XML_OpenOrderLines_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
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 R      
BackOrdered O Set Y for backordered, N for in-progress, or leave blank for all open order lines. A 1
StartDate R Start date in YYMMDD format. Start date is set to current date when not present. Example: July 15, 2013 is represented as 130715. N 6
EndDate R End date in YYMMDD format. Start date is set to current date when not present. Example: July 15, 2013 is represented as 130715. N 6
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.

OpenOrderLines Response DTD

The following DTD defines the OpenOrderLines Response message:
   

<!ELEMENT XML_OpenOrderLines_Response (
    Header ,
    Detail* ) >
    <!ELEMENT Header (
        ResponseVersion? ) >

    <!ELEMENT ResponseVersion (#PCDATA) >
    <!ELEMENT Detail (
        OrderNumber? ,
        OrderDate? ,
        CustPONumber?,
        EndUserPONumber? ,
        ErrorInfo? ,
        LineInfo* ,
        NbrOfOrderLines? ) >

    <!ELEMENT OrderNumber (#PCDATA) >
    <!ELEMENT OrderDate (#PCDATA) >
    <!ELEMENT CustPONumber (#PCDATA) >
    <!ELEMENT EndUserPONumber (#PCDATA) >
    <!ELEMENT ErrorInfo (
            ErrorIDQual ,
            ErrorID ,
            ErrorDesc ) >
    <!ELEMENT ErrorIDQual (#PCDATA) >
    <!ELEMENT ErrorID (#PCDATA) >
    <!ELEMENT ErrorDesc (#PCDATA) >
    <!ELEMENT LineInfo (
            ItemNumber ,
            ManufacturerPartNumber ,
            OrderQuantity ,
            InProgressQuantity ,
            BackorderQuantity,
            QuantityStatus ,
            ManufacturerName ,
            ItemDesc ,
            UnitPrice ,
            WarehouseDesc ,
            ShippingMethodDesc ,
            EstShipDate ,
            Backordered ,
            LineErrorInfo? ) >
    <!ELEMENT ItemNumber (#PCDATA) >
    <!ELEMENT ManufacturerPartNumber (#PCDATA) >
    <!ELEMENT OrderQuantity (#PCDATA) >
    <!ELEMENT InProgressQuantity (#PCDATA) >
    <!ELEMENT BackorderQuantity (#PCDATA) >
    <!ELEMENT QuantityStatus (#PCDATA) >
    <!ELEMENT ManufacturerName (#PCDATA) >
    <!ELEMENT ItemDesc (#PCDATA) >
    <!ELEMENT UnitPrice (#PCDATA) >
    <!ELEMENT WarehouseDesc (#PCDATA) >
    <!ELEMENT ShippingMethodDesc (#PCDATA) >
    <!ELEMENT EstShipDate (#PCDATA) >
    <!ELEMENT Backordered (#PCDATA) >
    <!ELEMENT LineErrorInfo (
                LineErrorID ,
                LineErrorIDQual ,
                LineErrorDesc ) >
    <!ELEMENT LineErrorID (#PCDATA) >
    <!ELEMENT LineErrorIDQual (#PCDATA) >
    <!ELEMENT LineErrorDesc (#PCDATA) >
    <!ELEMENT NbrOfOrderLines (#PCDATA) >


A sample XML OpenOrderLines Response message will look like the following.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE XML_OpenOrderLines_Response SYSTEM "XML_OpenOrderLines_Response.dtd"[]>
<XML_OpenOrderLines_Response>
    <Header>
        <ResponseVersion>1.0</ResponseVersion>
    </Header>
    <Detail>
        <OrderNumber>6001250029</OrderNumber>
        <OrderDate>09/20/2012</OrderDate>
        <CustPONumber>REQ#10127MH GL#62090000</CustPONumber>
        <EndUserPONumber>REQ#10127MH GL#62090000</EndUserPONumber>
        <LineInfo>
            <ItemNumber>10190240</ItemNumber>
            <ManufacturerPartNumber>33-330-085</ManufacturerPartNumber>
            <Quantity>1</Quantity>
            <ManufacturerName>ERGOTRON</ManufacturerName>
            <ItemDesc>NEOFLEX DUAL LCD LIFT STAND</ItemDesc>
            <UnitPrice>77.18</UnitPrice>
            <ExtendedPrice>77.18</ExtendedPrice>
            <WarehouseDesc>SUWANEE, GA</WarehouseDesc>
            <ShippingMethodDesc>FEDX GRND</ShippingMethodDesc>
            <EstShipDate>09/20/2012</EstShipDate>
            <Backordered>N</Backordered>
        </LineInfo>
    </Detail>
    <Detail>
        <OrderNumber>6001132826</OrderNumber>
        <OrderDate>09/19/2012</OrderDate>
        <CustPONumber>GL#63046000/10312143 REQ#10125DO</CustPONumber>
        <EndUserPONumber>GL#63046000/10312143 REQ#10125DO</EndUserPONumber>
        <LineInfo>
            <ItemNumber>10537173</ItemNumber>
            <ManufacturerPartNumber>LC42SV50U</ManufacturerPartNumber>
            <Quantity>1</Quantity>
            <ManufacturerName>SHARP</ManufacturerName>
            <ItemDesc>LC42SV50U 42IN LCD CCFL 60HZ TV</ItemDesc>
            <UnitPrice>407.22</UnitPrice>
            <ExtendedPrice>407.22</ExtendedPrice>
            <WarehouseDesc>Fontana, CA</WarehouseDesc>
            <ShippingMethodDesc>CUST PICK UP</ShippingMethodDesc>
            <EstShipDate>09/20/2012</EstShipDate>
            <Backordered>N</Backordered>
        </LineInfo>
    </Detail>
</XML_OpenOrderLines_Response>

OpenOrderLines Response Data Fields

The following table provides a detailed description of each element defined in the XML_OpenOrderLines_Response.dtd

Element Name
Optional
Required
Description
Data
Type
Max Len
Header R      
ResponseVersion O Designates the Response DTD version A/N 20
Detail R      
OrderNumber O Tech Data assigned sales order number A/N 10
OrderDate O Date that the order was placed A/N 10
CustPONumber O Customer assigned purchase order number A/N 35
EndUserPONumber O Customer assigned end user purchase order number A/N 35
ErrorInfo O      
ErrorIDQual O Value must be ‘1Q’ A/N 2
ErrorID O Value must be ‘0’ N 1
ErrorDesc   Error description A/N 250
LineInfo O      
ItemNumber O Tech Data item number A/N 18
ManufacturerPartNumber O Manufacturer’s item number A/N 20
OrderQuantity O The number of units ordered N 4
InProgressQuantity O The number of units ordered that are in the process of being fulfilled N 4
BackorderQuantity O The number of units ordered that are presently on back-order N 4
QuantityStatus O Status of the units ordered quantity.  This is different from the Order Status.
Status Meaning
In Process The units ordered quantity is in the process of being fulfilled
Back Ordered The units ordered quantity is presently on back-order
A 12
ManufacturerName O Name of the manufacturer A/N 30
ItemDesc O Description of item A/N 50
UnitPrice O Customer’s price for one unit of item ordered N 15(2)
WarehouseDesc O Tech Data Warehouse shipping this order line A/N 30
ShippingMethodDesc O Carrier name and mode, i.e. ‘UPS GROUND’ or FEDEX NEXT DAY’ A/N 25
EstShipDate O Estimated date that the item will be shipped A/N 10
Backordered O Yes/No flag identifying whether the item is Back-ordered A 1
LineErrorInfo O      
LineErrorID O Disregard this value    
LineErrorIDQual O Disregard this value    
LineErrorDesc O Disregard this value    
NbrOfOrderLines O Disregard this value    
©2015 Tech Data Corporation. All Rights Reserved. Tech Data proprietary and confidential