《XML Tools Documentation - Nexternal.doc》由会员分享，可在线阅读，更多相关《XML Tools Documentation - Nexternal.doc（174页珍藏版）》请在三一文库上搜索。
1、Last Revised: January 11, 2016Contents1:Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22:General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33:XML Schemas . . . . . . . .
2、 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44:XML Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65:OrderQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3、 . . . . . . . . . . .96:OrderUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .437:OrderCalculate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .518:OrderCreate . . . . . . . . . . . . .
4、. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .649:CustomerQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8110:CustomerUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5、. . . . .9511:InventoryUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10512:ProductQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11113:ProductUpdate . . . . . . . . . . . . . . . . .
6、 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13414:SavedCart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15615:Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7、. . . . . . . .16316:External Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16417:Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16818:Summary of Revisions . . . . . . . . .
8、. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17019:Appendix: REST Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1721: OverviewThe XML Tools are designed to allow data synchronization and integration with third party systems housing
9、similar data. All Tools involve server-to-server communication whereby the initiating server sends a Request XML document to the appropriate URL specified in this document, then receives a Reply XML document from Nexternal, then parses that document and takes appropriate action to achieve the desire
10、d integration.Because XML transactions are always initiated by the client via the Request XML, it is not possible to have XML initiated by an event in the Online Store, such as the placement of an order. You may, however, query new orders every 10 minutes by using the OrderQuery tool on a scheduled
11、basis to export new orders to a third party system in a timely manner.Successful use of the XML Tools requires considerable expertise in XML and the Nexternal Order Management System, as well as the necessary technology assets (i.e. hardware, software, internet service, etc), which are the sole resp
12、onsibility of the client performing the integration. Nexternal Solutions responsibility is limited to maintaining the functionality and availability of the Tools in accordance with this document (subject to modification and enhancement at any time, at Nexternals sole discretion), and providing e-mai
13、l based support (strictly limited to questions relating to the functionality of the XML Tools) via the XML Help Desk at Settings/XML Tools in the Order Management System.As a prerequisite to access to the active XML Tools, clients must agree to the Memorandum of Understanding at Settings/XML Tools i
14、n the Order Management System, and pass the XML Test as detailed in this document. The XML Test is designed to validate the skills of the integrator, and thus the XML Help Desk is not available to clients who have yet to pass the test. Clients who lack the in-house expertise to pass the test should
15、seek outside assistance.Note that the initialism OMS is used throughout this document to refer to the Nexternal Order Management System.2: General InformationThe following information should be used for all XML requests: Request Protocol: https Request Method: POST (send only the XML; do not include
16、 a field name or any other form elements) Content Type: application/x-www-form-urlencoded Do not include a DOCTYPE declarationThe most recent revision of this document is always available at http:/ or http:/ XML document validation schemas (XSDs) are available at http:/ regarding allowed State/Provi
17、nce Codes and Country Codes is available at http:/ home for the XML Tools in the OMS is Settings/XML Tools. Here, you will find the XML Memorandum of Understanding; and, if the XML Test has been passed, the XML Help Desk and XML Key.For security purposes, the same access restrictions assigned to the
18、 OMS at Settings/Anti-Fraud and Security are applied to the XML Tools. Furthermore, if 15 consecutive failed attempts (where the failure is caused by invalid authentication credentials) are recorded from a given IP address within one hour, the IP is locked out from the XML Tools for the remainder of
19、 the hour.When developing and testing your XML integration, in most cases you may do so against your live account without any adverse consequences. If you prefer, you may also use the OMS on Nexternals FirstFirway demonstration site (http:/ for testing purposes, or you may request temporary use of a
20、 dummy account from your Nexternal Account Representative.Responses from Nexternal utilize HTTP Compression via Microsofts Internet Information Server (IIS). For most developers, this is inconsequential; however, if you are using Cold Fusion, you may need to include special header information to dis
21、able compression please see http:/ for more information.3: XML SchemasSchemas for all XML requests and replies are given in tabular format on the following pages. The columns included are as follows:Element XPath: Path of the XML element, excluding the top level container (which always matches the n
22、ame of the XML document). For example, full path of the OrderNoRange/OrderNoStart node in the OrderQueryRequest document is OrderQueryRequest/OrderNoRange/OrderNoStart. Attributes are denoted by the symbol.Required: (Request XML only) Denotes whether or not the element is required. A No value indica
23、tes that the element is not required in all cases, not that the element can be safely ignored. A Yes* value indicates that the element is required only if its non-required parent is present.Always: (Reply XML only) The equivalent of the Required field for Request XML.Occurs: Denotes the number of oc
24、currences of the element, or the range thereof. For child elements, this field indicates the number of occurrences per parent node.Type: Denotes the element type. The possible values are: Container: A container that contains child nodes Text Node/Attribute: Contains textual data (letters, numbers, p
25、unctuation, spaces, etc) with no specific format unless noted in the Description. If an absolute or maximum number of characters applies, that number is noted. Text Node/Attribute (Request XML only): Contains data in the same format as the Text Node/Attribute, but may also be an empty node to erase
26、an existing value. Integer Node/Attribute: Contains integer values only. Unless otherwise noted in the Description, the field allows only positive integers. Currency Node/Attribute: Contains a currency value with 2 decimal places. For example, $4.50 is represented as 4.50. Unless otherwise noted in
27、the Description, the field allows only positive values and represents a value in United States Dollars. Numeric Node/Attribute: Contains a numeric value with no fixed number of decimal places. Unless otherwise noted in the Description, the field allows only positive numbers. Percent Node/Attribute:
28、Contains a percent value with a variable number of decimal places. For example, 7.75% is represented as 7.75. Unless otherwise noted in the Description, the field allows only positive values. Date Node/Attribute: Contains a date value in the mm/dd/yyyy format (unless otherwise noted). For example, J
29、uly 4, 2005 is represented as 07/04/2005. Time Node/Attribute: Contains a time value in the hh:mm format, where hh ranges from 00 23 and mm ranges from 00 59. For example, 1:05 PM is represented as 13:05. Time values are based on the U.S. Pacific Time Zone, subject to adjustment via the Time Adjustm
30、ent field at Settings/Site Options in the OMS. URL Node: Contains a Uniform Resource Locator (URL) value. Used with image and audio files located on the internet, or a webpage to be displayed to the user during redirection. Empty Node: Contains no value. The presence or lack of an Empty Node is used
31、 to represent a Boolean value.Description: Contains a description of the field and other pertinent information.4: XML TestSuccessful completion of the XML Test is required before access to the active XML Tools is granted. The test is used to validate the skills of the integrator. The test consists o
32、f two parts: TestSubmit and TestVerify.Your script should begin by sending the TestSubmitRequest, then receive and parse the TestSubmitReply. Based on the TestSubmitReply, your script should then build and send the TestVerifyRequest and receive the TestVerifyReply. The TestVerifyRequest must be sent
33、 within 1 minute of the TestSubmitRequest for the test to be completed successfully. If successful, you will receive your active XML Key in the TestVerifyReply, and you may immediately begin using the active XML Tools. The active Key is also available upon successful completion of the test at Settin
34、gs/XML Tools in the OMS.Authentication of the TestSubmitRequest and TestVerifyRequest is via any User Name and Password valid for the OMS with an Access Level of Administrator or Editor. Additionally, the TestVerifyRequest must include the test XML Key provided by the TestSubmitReply (randomly gener
35、ated and separate from the active XML Key provided by the TestVerifyReply) as either an attribute or node as specified in the TestSubmitReply.TestSubmitRequest URL: https:/ TestVerifyRequest URL: https:/ TestSubmitRequest SchemaElement XpathRequiredOccursTypeDescriptionCredentialsYes1ContainerCreden
36、tials/AccountNameYes1Text Node (10 chars max)Clients Account Name (e.g. fairway)Credentials/UserNameYes1Text Node (50 chars max)Any valid, active User Name with Access Level Administrator or EditorCredentials/PasswordYes1Text Node (50 chars max)Users Password TestSubmitReply SchemaElement XpathAlway
37、sOccursTypeDescriptionAccountNameYes1Text Node (10 chars max)Clients Account Name (e.g. fairway)TypeYes1Text Attribute (9 chars max)Location of Key in TestVerifyRequest (Attribute or Node)TestKeyYes1Text Node (20 chars max)Test Key TestVerifyRequest SchemaElement XpathRequiredOccursTypeDescriptionCr
38、edentialsYes1ContainerCredentials KeyNo1Text Attribute (20 chars max)Use for Test Key if TestSubmitReply Type is AttributeCredentials/AccountNameYes1Text Node (10 chars max)Clients Account Name (e.g. fairway)Credentials/UserNameYes1Text Node (50 chars max)Any valid, active User Name with Access Leve
39、l Administrator or EditorCredentials/PasswordYes1Text Node (50 chars max)Users PasswordCredentials/KeyNo1Text Node (20 chars max)Use for Test Key if TestSubmitReply Type is NodeTestVerifyReply SchemaElement XpathAlwaysOccursTypeDescriptionAccountNameYes1Text Node (10 chars max)Clients Account Name (
40、e.g. fairway)ActiveKeyYes1Text Node (20 chars max)Active Key for use with XML ToolsTestSubmitRequest Example fairway Demo Dem0U$er TestSubmitReply Example ?!J*1iQKx/,FK=pW#rlTestVerifyRequest Example fairway Demo Dem0U$er TestVerifyReply Example k?h;GO9niHItxuQB 5: OrderQueryThe OrderQuery is used t
41、o query order data, thus exporting orders from the OMS so that they may be imported into an external system.You may submit a query based on Order Number Range, Order Date Range, Order Last Updated Range, Ship/Send Date Range, Preferred Ship Date Range, Preferred Delivery Date Range, Pickup Date Rang
42、e, Customer Number, Ship To State/Province or Country, Order Status, Billing Status, Order Type, Pickup Location, or Affiliate (or any of those criteria in combination). For Order Number Range, Order Date Range, Order Last Updated Range, Ship/Send Date Range, and Pickup Date Range, you may specify a
43、 Range Start, Range End, or both. Specifying only a Range Start has the meaning of greater than or equal to, while only a Range End has the meaning of less than or equal to. For example, a query based on only an Order Number Range Start of 102400 queries Orders 102400 and greater.In the case of an Order Date Range or Order Last Updated Range, you may specify a Start and/or End Date, and optionally a Time. If you do not specify a Time, a default value of 00:00 (i.e. 12:00 AM) is used. If you wish to specify the end of the day (particularly for a Range End), you must use a Time value of 23: