Module: API Detail Screen 

Path: Processing > Import/Export > API Detail

Topic: API Detail

Version(s): Version 5.0 and up

Editions: All Editions 

---

What Is API Detail

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.

---

Making The Connection

Where Will I See This Within OLX?

You will see API orders created in OrderLogix or if there is an error that needs addressed you will see that in Managed Order Exceptions.

What Reports Can Be Pulled?

1. Order Submission Status Report

What Imports/Exports Relate to API Detail

1. OrderLogix Real-Time Order Submission API

---

Trouble Shooting

1. exception = true
   

1. OrderLogix Order Import V4 (Flat File and API) Exception List

---

Setup

The page is accessed by navigating to Processing > Import/Export >API Detail.

---

Tool Bar

Utilizing the buttons on the tool bar  you can: 

Go back to the previous screen 

Add new 

Print 

---

Filter

You can use the filter options to narrow down the displayed selections.

1. API Method
   
2. Server
   
3. IP Addres
   
4. Web Order #
   
5. User
   
6. HasException
   
7. CustomerID
   
8. OrderID
   
9. CreateDate
   
10. Client

Add additional filters by click the Add button 

Apply the filtered selections by clicking Apply Filter 

Remove the filtered selections by clicking Remove Filter 

To show inactive accounts in the displayed records check Show Inactive 

You can set the number of records to be displayed 

 

---

Review Record

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 window. 

1. API Method
   
1. ReceiveOrder
2. Client
   
1. client associated to the order
3. Server
   
1. OrderLogix server the IP Address below connected to when attempting to import
4. IP Address
   
1. location import was attempted from
5. Start Time
   
1. when import began attempt to import into system
6. End Time
   
1. when import completed attempt to import into system
7. Has Exception
   
1. unchecked - false, order imported without error
   
2. checked - true, order did not import successfully and needs to be reviewed via Manage Order Exceptions, or via the vendor
   
8. Web Order #
   
1. the imported Order ID
9. Customer ID
   
1. the OrderLogix assigned Customer ID
10. Order ID
    
1. the OrderLogix assigned Order ID
11. Request
    
1. This is the XML that was submitted to the API (with the Credit Card number removed for security purposes).
   
2. The XML is displayed in an easy-to-read format that lets you clearly identify what is being sent in each field.
   
3. The XML can be copied for re-submission or to be sent in correspondence.
   
1. 
   
12. Response
    
1. This is generated by OrderLogix and will contain the result of the submission as well as any details about an exception, if there is one.
   
1. 
2. for more information on how to resolve your specific error, please review OrderLogix Order Import V4 (Flat File and API) Exception List
2. Below the exception details, there is an Import Summary and Item List Grids, which are both helpful to resolve an exception due to a calculation error. 
   
1. The import summary provides a snapshot of several key order settings.
   
1. For more information about the different Calculation and Rounding methods supported by the OrderLogix Order Import API, see our articles on these
   
1. Tax Rounding Methods For Imported Orders Round Up, Down, And Bankers
   
2. Tax Calculation Methods
3. How to Calculate Tax on an Imported Order
4. 
   
5. 
   
   
2. The Item List Grids offer visual insight into possible calculation differences between what was provided and how OrderLogix is calculating
   
1. Initial Item List From File - 
   
1. first list
   
2. provided in the file
   
3. 
   
2.  Items After Unit Price Allocation because of Difference in calculated [insert field throwing error]
   
1. middle grid
   
2. will appear when the order total provided does not match the calculated amount (regardless of exception message given).
   
3. 
   
3. Item List At Time of Import
   
1. last list
   
2. what OrderLogix has calculated
   
3. 
   

* To cancel any of the current changes you have made click the Cancel button .

      This will close the window without saving any changes.

* To print the current window, click the Print button .

---

Copyright 2019
Revised 9.10.2025