Module : API Detail Screen 

Topic : Page Overview 

Version(s): Version 5.0 and up  

Editions : All Editions 

Overview :

The API Detail Screen is a page that allows OrderLogix users to view details about orders submitted to the Order Import API. These details can be used for troubleshooting issues and/or exception management.

The page is accessed by navigating in the menu bar to Processing-->Import/Export-->API Detail.

The main page will provide you with a list of all Order Import submissions to the API. In the list you will see details about each submission such as server, IP Address, User, Web Order #, whether there was an Exception, Customer/Order ID, Create Date, and Client. You’ll notice that this list includes the ability filter like many other pages in OrderLogix, allowing you to look up a specific web order number, or display only submissions with exceptions. 

To view additional information about a particular submission, click the edit pencil icon in the list beside the submission record. This opens the API Log Detail pop out window. The top portion of this window displays details such as Server, Date and Time, whether there was an Exception, Customer and Order ID, IP Address, and Web Order #.

The middle section of the page displays the API Request. This is the XML that was submitted to the API(with the Credit Card number removed for security purposes). The XML is displayed in an easy to read format that lets you clearly identify what is being sent in each field. the XML can be copied for re-submission or to be sent in correspondence.

• The import summary provides a snapshot of several key order settings. (For more information about the different Calculation and Rounding methods supported by the OrderLogix Order Import API, see our articles on these here:  https://support.orderlogix.com/portal/en/kb/articles/tax-calculation-methods  and here: https://support.orderlogix.com/portal/en/kb/articles/tax-rounding-methods-for-imported-orders-round-up-down-and-bankers .

• The Item List Grids offer visual insight into calculation differences between what was provided in the file (first list) and what OrderLogix has calculated (last list). This example is for an order that received the exception  WARNING: ORDER_STATE_SALES_TAX (Column 97) has the value "$0.00". State tax must match this order's calculated amount "$0.06".  When comparing the grids, I can see that the imported list includes a tax rate of 5.5% but no tax amount was provided. This is the reason for the exception being received. The middle grid will appear when the order total provided does not match the calculated amount (regardless of exception message given).