CURT COMNET XML Portal

Transcription

1 CURT COMNET XML Portal Overview Leveraging COM_Net2 s XML Portal provides CURT Customers with the ability to send and receive XML data using industry standard SOAP requests. The following transactions are supported: Placing a new order Order status Functions PlaceOrder Function This is the primary capability of XML Portal, which allows for the automated direct-entry of COM orders via XML. Any inputs that are available to COM_Net2 can be included in the XML Portal placeorder request. GetSummary Function The getsummary function provides all of the XML data that is returned from the COM_Net2 request for getsummaries (Order Header) when using the report=<report_name> parameter (i.e. clicking on the Report button). Each of the summary options that is available through COM_Net2 are also available as input parameters, including summarytype, fromorder, toorder, sortdescend, etc. The summarytype is a required value (can not do getsummary across multiple summarytype values) and if a value is not provided the default is Open Orders (summarytype=1). GetDetails Function The getdetails function provides all of the XML data that is returned from the COM_Net2 request for getdetails (Order Line Item Details) when using the report=<report_name> parameter (i.e. clicking on the order number from the COM_Net2 summary page). The only required input parameter other than the mode is the ordernumber. The summarytype is assumed to be for Open Orders (summarytype=1) unless specified otherwise in the request which is the only other available input. Communicating with XML Portal

2 XML Portal is designed to receive and respond with XML data using the SOAP (Simple Object Access Protocol) methodology. Each submission to XML Portal may contain one or more requests of differing types. For each request within the submission, XML Portal will return a response section. Each of the requests in the submission may also include a userid, password and environment combination, with all of these items being required in the first request within the submission. If the latter requests do not contain userid, password and environment information, the same combination included in the most previous request will remain active. The following sections outline the required and optional input parameters for each XML Portal function. These are presented in order of increasing complexity. GetDetails Inputs user=<user name> (required if first request) psswrd=<password> (required if first request) env=<environment> (required if first request) mode=getdetails (required) summarytype=<summary Type #> (optional see notes below) ordernumber=<order #> (required) GetSummary Inputs user=<user name> (required if first request) psswrd=<password> (required if first request) env=<environment> (required if first request) mode=getsummary (required) summarytype=<summary Type #> (optional see notes below) sortdescend=<y or N> (optional defaults to N) fromorder=<order #> (optional) toorder=<order #> (optional) fromdate=<date> (optional date format for user s group) todate=<date> (optional date format for user s group) frompo=<purchase order #> (optional) topo=<purchase order #> (optional) PlaceOrder Inputs user=<user name> (required if first request) psswrd=<password> (required if first request) env=<environment> (required if first request) mode=placeorder (required) cardcompany=<card company> (optional) cardnum=<card #> (optional) cardexpiremm=<expiration month> (optional) cardexpireyy=<expiration year> (optional) cardname=<name on card> (optional)

3 ponumber=<purchase order #> (optional based on user s account) carrierid=<shipping carrier> (optional defaults to setting in XMLPortal.ini) applicationtype=<1 or 2> (optional defaults to 1 for order {2 for quote}) contact=<contact name> (optional) suspend=<0 or 1> (optional defaults to 0 for false) specialinstructions=<shipping Instr.> (optional) ordercomments=<comments> (optional) acceptbackorders (optional true or false, defaults to setting in XMLPortal.ini) acceptpartialquantity (optional true or false, defaults to setting in XMLPortal.ini) shiptonumber=<ship to number> (optional) shiptoname=<ship to name> (optional) shiptoaddress1=<ship to address1> (optional) shiptoaddress2=<ship to address2> (optional) shiptoaddress3=<ship to address3> (optional) shiptoaddress4=<ship to address4> (optional) shiptoaddress5=<ship to address5> (optional) shiptocity=<ship to city> (optional) shiptostate=<ship to state> (optional) shiptozip=<ship to zip> (optional) shiptocountry=<ship to country> (optional) contactphone=<ship to phone> (optional) shipcontact=<ship to contact> (optional) The inputs acceptbackorders and acceptpartialquantity are settings that are unique to the XML Portal placeorder functionality. Because there is no interaction other than submission and response, each placeorder request has access to these settings which determine how insufficient inventory issues are handled. acceptbackorders acceptpartialquantity Result True True* All items processed disregarding the available quantity. True False* All items processed disregarding the available quantity. False True The order quantity is altered to the inventory available at the time of submission and processing continues. The

4 False False actual number of items ordered will be returned. Any item with insufficient inventory is not included in the order and skipped all together. *When the acceptbackorders flag is set to true the acceptpartialquantity flag is ignored. Ship to addresses are required only if there is an attempt to override any of the ship to fields and the user is permitted to override address in their profile. The required fields are based on these criteria as well as the address format assigned that customer. Below is a table of the required fields based on the user s address format. FIELD Address Format <>3 Address Format 3 shiptoname TRUE TRUE shiptoaddress1 TRUE TRUE shiptoaddress2 FALSE FALSE shiptoaddress3 FALSE FALSE shiptoaddress4 FALSE FALSE shiptoaddress5 FALSE FALSE shiptocity TRUE FALSE shiptostate TRUE FALSE shiptozip TRUE FALSE shiptocountry TRUE FALSE contactphone FALSE FALSE shipcontact FALSE FALSE A section under the heading Items contains the following information for each item that is included in the order request: itemnumber=<item #> (required) quantity=<quantity> (optional defaults to 1) comment=<line comment> (optional) requestdate=<date> (optional)

5 SOAP Examples GetDetails Example Input <?xml version='1.0' encoding='utf-8'?> <SOAP-ENV:Envelope xmlns:soap-env=" xmlns:xsi=" xmlns:xsd=" <SOAP-ENV:Body> <ns1:xmlportal xmlns:ns1=" SOAP-ENV:encodingStyle=" <request xmlns:ns2=" xsi:type="ns2:array" xmlns:ns3=" ns2:arraytype="ns3:map[1]"> <item xsi:type="ns3:map"> <key xsi:type="xsd:string">user</key> <value xsi:type="xsd:string">demo</value> <key xsi:type="xsd:string">psswd</key> <value xsi:type="xsd:string">demo</value> <key xsi:type="xsd:string">env</key> <value xsi:type="xsd:string">envgzen</value> <key xsi:type="xsd:string">mode</key> <value xsi:type="xsd:string">getdetails</value> <key xsi:type="xsd:string">summarytype</key> <value xsi:type="xsd:string">1</value> <key xsi:type="xsd:string">ordernumber</key> <value xsi:type="xsd:string"> </value> </request> </ns1:xmlportal> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

6 GetSummary Example Input <?xml version='1.0' encoding='utf-8'?> <SOAP-ENV:Envelope xmlns:soap-env=" xmlns:xsi=" xmlns:xsd=" <SOAP-ENV:Body> <ns1:xmlportal xmlns:ns1=" SOAP-ENV:encodingStyle=" <request xmlns:ns2=" xsi:type="ns2:array" xmlns:ns3=" ns2:arraytype="ns3:map[1]"> <item xsi:type="ns3:map"> <key xsi:type="xsd:string">user</key> <value xsi:type="xsd:string">demo</value> <key xsi:type="xsd:string">psswd</key> <value xsi:type="xsd:string">demo</value> <key xsi:type="xsd:string">env</key> <value xsi:type="xsd:string">envgzen</value> <key xsi:type="xsd:string">mode</key> <value xsi:type="xsd:string">getsummary</value> <key xsi:type="xsd:string">summarytype</key> <value xsi:type="xsd:string">1</value> <key xsi:type="xsd:string">sortdescend</key> <value xsi:type="xsd:string">y</value> <key xsi:type="xsd:string">fromorder</key> <value xsi:type="xsd:string"> </value> <key xsi:type="xsd:string">toorder</key> <value xsi:type="xsd:string"> </value> </request> </ns1:xmlportal> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

7 PlaceOrder Example Input <?xml version='1.0' encoding='utf-8'?> <SOAP-ENV:Envelope xmlns:soap-env=" xmlns:xsi=" xmlns:xsd=" <SOAP-ENV:Body> <ns1:xmlportal xmlns:ns1=" SOAP-ENV:encodingStyle=" <request xmlns:ns2=" xsi:type="ns2:array" xmlns:ns3=" ns2:arraytype="ns3:map[1]"> <item xsi:type="ns3:map"> <key xsi:type="xsd:string">user</key> <value xsi:type="xsd:string">demo</value> <key xsi:type="xsd:string">psswd</key> <value xsi:type="xsd:string">demo</value> <key xsi:type="xsd:string">env</key> <value xsi:type="xsd:string">envgzen</value> <key xsi:type="xsd:string">mode</key> <value xsi:type="xsd:string">placeorder</value> <key xsi:type="xsd:string">applicationtype</key> <value xsi:type="xsd:string">1</value> <key xsi:type="xsd:string">suspend</key> <value xsi:type="xsd:string">0</value> <key xsi:type="xsd:string">ponumber</key> <value xsi:type="xsd:string">123456</value> <key xsi:type="xsd:string">carrierid</key> <value xsi:type="xsd:string">airborne </value>

8 (more on next page) <key xsi:type="xsd:string">items</key> <value xsi:type="ns2:array" ns2:arraytype="ns3:map[2]"> <item xsi:type="ns3:map"> <key xsi:type="xsd:string">itemnumber</key> <value xsi:type="xsd:string">abc</value> <key xsi:type="xsd:string">quantity</key> <value xsi:type="xsd:string">3</value> <key xsi:type="xsd:string">requestdate</key> <value xsi:type="xsd:string">08/15/2002</value> <item xsi:type="ns3:map"> <key xsi:type="xsd:string">itemnumber</key> <value xsi:type="xsd:string">911</value> <key xsi:type="xsd:string">quantity</key> <value xsi:type="xsd:string">9</value> <key xsi:type="xsd:string">comments</key> <value xsi:type="xsd:string">911 comments</value> <key xsi:type="xsd:string">acceptbackorders</key> <value xsi:type="xsd:string">false</value> <key xsi:type="xsd:string">acceptpartialquantity</key> <value xsi:type="xsd:string">true</value> </value> </request> </ns1:xmlportal> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

9 Understanding XML Portal Response Data For each request included in an XML Portal submission, COM_Net2 will provide the appropriate response data or error information detailing why the request was unsuccessful. When multiple requests are embedded in a single submission, the response data will be in the same order as the requests were included in the input data. For each XML Portal function, a corresponding.xml file is included to filter the data that is returned in the response. These files are located in the COM_Net2 directory, with the naming convention XMLPortal-<function name>.xml where <function name> is either getsummary, getdetails or placeorder. These files are specially formatted xml data files that control what information is returned for each of the different request types. Detailing Response Data This section includes details about important data fields for each of the XML Portal functions and are also the fields included in the distributed XMLPortal-<function name>.xml files. GetDetails Response Data The getdetails request contains relevant information in several locations of the response data. Information related to the order resides in the OutputParm section, item specific information can be found in the Records/LineItems/htRecordx section where x is the line item indicator and shipping information can be found within Records/Shipments/htRecordx where x is the shipment identifier. Some of the relevant fields used by COM_Net2 directly are documented below: OutputParm Section shiptoaddressx ordertotal currencydescription ponumber shipinstructions specialinstructions Various lines of the shipto address. Also see shiptoname, shiptocity, shiptostate, shiptozip and shiptocountry. The total amount of this order. Currency identifier for all values in this response. Purchase order number for this order. Shipping instructions for this order. Order comments for this order. Records/LineItems/htRecordx Section itemnumber Product item number. description linespecialinstruct requestdate Product description. Line item comments. Request date for this line item.

10 promisedate quantity quantityship quantitybo price extendedprice Promise date for this line item. Quantity ordered for this line item. Current shipped quantity for this line item. Current back ordered quantity for this line item. Line item price. Total price for line item ((quantity * price) any manual discout) Records/Shipments/htRecordx Section shipmentnumber Shipment identifier. probillno trackingurl1 shipdate Tracking number. URL containing tracking information. Ship date for this shipment line item. shipstatus Ship status for this shipment line item. GetSummary Response Data The getsummary request contains relevant information primarily in the Records/htRecordx section where x is the line item indicator with the currencydescription for all values located in the OutputParm section. All of the fields used by COM_Net2 directly are documented below: OutputParm Section currencydescription Records/htRecordx Section ordernumber ponumber enterdate contact ordertotal orderstatus Currency identifier for all values in this response. Order number identifier. Purchase order number for this order. Date this order was entered. Contact name for this order. Order total. This order s current status (only available on open and back orders). PlaceOrder Response Data The placeorder request returns the ordernumber and currencydescription in the OutputParm section and all other data in the Records/htRecordx section where x is the line item indicator. All of the fields used by COM_Net2 directly are documented below:

11 OutputParm Section ordernumber currencydescription Records/htRecordx Section pdb.itemno pdbkey display.unitofmesaure display.description itemcomments requestdate quantity display.price display.extprice Order number assigned by COM_Net2 to this order. Currency identifier for all values in this response. This is the item number as stored in the Product database. The item number returned from Mapics for this item. (This could be pdb.itemno or pdb.orditmno) The COM_Net2 configured unit of measure for this item. The COM_Net2 configured description for this item. This item s comments. This item s request date. Order quantity for this item. The COM_Net2 configured price for this item. The extended price for this line item.

12 Full Sample Result Data The following samples are shown in standard XML format for ease of viewing and include ALL of the fields available via the XML Portal (not just the fields which are included in the distributed XMLPortal-<function name>.xml files). Several lengthy blank fields were truncated for display purposes. GetDetails Sample Full Output <getdetails> <InputParm> <user>demo</user> <env>envgzen</env> <mode>getdetails</mode> <summarytype>2</summarytype> <ordernumber> </ordernumber> </InputParm> <OutputParm> <shiptoaddress>hughston Clinic 1000 E. 133rd Street Suite 100 Columbus GA United States of America</shipToAddress> <user.shiptoaddress4 /> <orderstatus>complete</orderstatus> <user.shiptoaddress3 /> <user.shiptoaddress2>suite 100</user.shipToAddress2> <messagenumber> </messagenumber> <user.shiptoaddress1>1000 E. 133rd Street</user.shipToAddress1> <user.shipvia2>airborne</user.shipvia2> <printshipto>hughston Clinic 1000 E. 133rd Street Suite 100 Columbus GA United States of America</printShipTo> <user.shiptocountry>usa</user.shiptocountry> <specialinstructions /> <expectdate> </expectdate> <shiptonumber> </shiptonumber> <boqty>0</boqty> <contact /> <description /> <user.shipvia>best way</user.shipvia> <user.taxsuffix /> <ordernumber> </ordernumber> <userline /> <ponumber>eee</ponumber> <user.specialinstructions /> <cardnumber /> <shipdate> </shipDate> <user.shiptoname>hughston Clinic</user.shipToName> <shiptostate>ga</shiptostate> <lastkeydt /> <cardname /> <shipinstructions>best way</shipinstructions> <user.shiptozip>30025</user.shiptozip> <enterdate> </enterdate> <user.shiptocity>columbus</user.shiptocity> <taxsuffix />

13 <invoicenumber /> <user.contactphone /> <requestdate> </requestdate> <user.contact /> <diagnostictext /> (more on next page)

14 <user.shiptostate>ga</user.shiptostate> <rc> </rc> <contactphone /> <shiptoaddress5 /> <shiptoname>hughston Clinic</shipToName> <shiptoaddress4 /> <lastkeyshp>end OF FILE</lastKeySHP> <shiptoaddress3 /> <errorelementinopt> </errorelementinopt> <shiptoaddress2>suite 100</shipToAddress2> <shiptoaddress1>1000 E. 133rd Street</shipToAddress1> <itemnumber /> <user.ponumber>eee</user.ponumber> <cardexpireyy /> <shiptocity>columbus</shiptocity> <ordertotal> </ordertotal> <cardexpiremm /> <shiptozip>30025</shiptozip> <trackingurl1 /> <shiptocountry>usa</shiptocountry> <waybill /> <cardcompany /> <shipcarrierid>airborne</shipcarrierid> <user.shiptoaddress5 /> </OutputParm> <Records> <LineItems> <Record> <quantityship>1.000</quantityship> <itemnumber>abc</itemnumber> <configureproduct /> <currency /> <linestatus /> <linespecialinstruct /> <pdbkey /> <hostlinenumber>100</hostlinenumber> <quantity>1.000</quantity> <quantitybo /> <unitofmeasure>ea</unitofmeasure> <notes /> <extendedprice> </extendedprice> <productsummary /> <snumber /> <price> </price> <requestdate> </requestdate> <description>abc PART</description> <promisedate> </promisedate> <orderwarehouse>1</orderwarehouse> <manufacturer /> <restockdate> </restockdate> </Record> </LineItems> <Shipments> <Record> <unitofmeasure>lb</unitofmeasure> <backordereditems>0</backordereditems> <userfieldswitcha /> <userfieldcodec /> <userfieldcodeb /> <userfieldcodea /> (more on next page)

15 <picklistnumber> </picklistnumber> <shipmentnumber> </shipmentnumber> <shipdeliverydate> </shipdeliverydate> <packinglistno> </packinglistno> <probillno /> <shipmentid> </shipmentid> <shipleadtime>01</shipleadtime> <shiptime>102916</shiptime> <userfielddate2> </userfielddate2> <userfielddate1> </userfielddate1> <shiptotype /> <weightqualifier /> <shipdate> </shipdate> <shiptostate>ga</shiptostate> <shipinstructions>best way</shipinstructions> <taxsuffix>notax</taxsuffix> <invoicenumber>000150</invoicenumber> <warehouse>1</warehouse> <truckno /> <shipstatus>50</shipstatus> <warehousedescription>main PLANT (NBR 1)</warehouseDescription> <shiptoaddress5 /> <shiptoaddress4 /> <shiptoname>hughston Clinic</shipToName> <userfieldtext /> <shiptoaddress3 /> <invoicesequence> </invoicesequence> <shiptoaddress2>suite 100</shipToAddress2> <shiptoaddress1>1000 E. 133rd Street</shipToAddress1> <trailerno /> <shipmentheadernumber> </shipmentheadernumber> <shiptocity>columbus</shiptocity> <shipweightoverride>0.0</shipweightoverride> <shiptozip>30025</shiptozip> <trackingurl1 /> <shiptocountry>united States of America</shipToCountry> <shipweight>5.0</shipweight> <billofladingno> </billofladingno> <shipcarrierid>airborne</shipcarrierid> </Record> </Shipments> </Records> </getdetails>

16 GetSummary Example Full Output <getsummary> <InputParm> <toorder> </toorder> <user>demo</user> <env>envgzen</env> <mode>getsummary</mode> <sortdescend>n</sortdescend> <fromorder> </fromorder> <summarytype>1</summarytype> </InputParm> <OutputParm> <lastkeysm>end OF FILE</lastKeySM> <currencydescription>us DOLLARS</currencyDescription> <diagnostictext> </diagnostictext> <messagenumber> </messagenumber> <rc> </rc> <errorelementinopt> </errorelementinopt> </OutputParm> <Records> <htrecord0> <ordernumber> </ordernumber> <orderstatus>open</orderstatus> <trackingurl1 /> <ordertotal> </ordertotal> <enterdate> </enterdate> <boqty>0</boqty> <ponumber>123456</ponumber> <contact>cmn-</contact> <invoicenumber> </invoicenumber> <itemnumber /> <shipdate> </shipdate> <waybill /> <description /> <expectdate> </expectdate> </htrecord0> <htrecord1> <ordernumber> </ordernumber> <orderstatus>open</orderstatus> <trackingurl1 /> <ordertotal> </ordertotal> <enterdate> </enterdate> <boqty>0</boqty> <ponumber>1111</ponumber> <contact>cmn-</contact> <invoicenumber> </invoicenumber> <itemnumber /> <shipdate> </shipdate> <waybill /> <description /> <expectdate> </expectdate> </htrecord1> </Records> </getsummary>

17 PlaceOrder Sample Full Output <placeorder> <InputParm> <carrierid>airborne </carrierid> <user>demo</user> <applicationtype>1</applicationtype> <mode>placeorder</mode> <suspend>0</suspend> <ponumber>123456</ponumber> <env>envgzen</env> <acceptbackorders>false</acceptbackorders> <acceptpartialquantity>true</acceptpartialquantity> </InputParm> <OutputParm> <ordernumber> </ordernumber> <currencydescription>us DOLLARS </currencydescription> </OutputParm> <Records> <htrecord0> <display.price> </display.price> <alternatestocknum> </alternatestocknum> <orderwarehousealt> </orderwarehousealt> <pdb.keywords></pdb.keywords> <pdb.lastupdt>2002/04/22 16:21:23</pdb.lastupdt> <descriptionalt> </descriptionalt> <productimageurl> </productimageurl> <unitofmeasure>ea </unitofmeasure> <itemnumberalt> </itemnumberalt> <pdb.cattext>this year's custom glasses provide 100% UV protection as well as improved wind blocking for downhill riding.</pdb.cattext> <requestdate> </requestdate> <pdb.addinfourl></pdb.addinfourl> <messagenumber> UPS </messageNumber> <productspecurl> </productspecurl> <configurableproductflag>n</configurableproductflag> <pdbkey>gl10 </pdbkey> <pdb.picparturl></pdb.picparturl> <pdb.itemno>gl10</pdb.itemno> <pdb.defaultqty>1</pdb.defaultqty> <description>bicycle GLASSES </description> <pdbkeyalt> </pdbkeyalt> <quantity>10</quantity> <restockdatealt> </restockdatealt> <configurableproductflagalt> </configurableproductflagalt> <productspecurlalt> </productspecurlalt> <price> </price> <substitutealt> </substitutealt> <inventoryavailablealt> </inventoryavailablealt> <diagnostictext> </diagnostictext> <notes> </notes> <rc> </rc> <inventoryavailable> </inventoryavailable> <itemnumber>gl10 </itemnumber> <multipleunitsflag> </multipleunitsflag> <display.description>bicycle Glasses NEW</display.description> (more on next page)

18 <requestdatealt> </requestdatealt> <pdb.price>99.99</pdb.price> <unitofmeasurealt> </unitofmeasurealt> <gstflag> </gstflag> <substitute>0</substitute> <gstflagalt> </gstflagalt> <display.image>\gl-10.jpg</display.image> <productimageurlalt> </productimageurlalt> <netpricealt> </netpricealt> <errorelementinopt> </errorelementinopt> <pdb.lastupu>lexeladmin</pdb.lastupu> <marketing> </marketing> <manufactureralt> </manufactureralt> <advprodconfurl> </advprodconfurl> <restockdate> </restockdate> <notesalt> </notesalt> <orderwarehouse>1 </orderwarehouse> <pdb.itemum></pdb.itemum> <multipleunitsflagalt> </multipleunitsflagalt> <commissionlevel> </commissionlevel> <commissionlevelalt> </commissionlevelalt> <typeitem>4</typeitem> <pdb.canorder>1</pdb.canorder> <pdb.extprice>999.9</pdb.extprice> <extpricealt> </extpricealt> <display.unitofmeasure></display.unitofmeasure> <pdb.itmpicurl>\gl-10.jpg</pdb.itmpicurl> <currency> </currency> <marketingalt> </marketingalt> <currencyalt> </currencyalt> <customeritemnumberflagalt> </customeritemnumberflagalt> <pdb.itmdesc>bicycle Glasses NEW</pdb.itmDesc> <extprice> </extprice> <pdb.thumburl>\gl-10.jpg</pdb.thumburl> <display.extprice> </display.extprice> <manufacture> </manufacture> <customeritemnumberflag> </customeritemnumberflag> <pdb.orditmno><pdb.orditmno> </htrecord0> </Records> </placeorder>