OLX Web Services API

OLX Web Services API

The OrderLogix Web Services API provides real-time API access to an OLX system for external systems to read, change and append data without needing to use the OLX Graphical User Interface (GUI). OrderLogix provides an Application Programming Interface (API) that allows third party systems to securely interact with the OrderLogix system and carry out various tasks to manage orders, customers and continuity subscriptions. These functions can be used and made available outside of the core OLX system, for use by third party systems

The specific functions of the Web Services API are outlined below:

Receive Order - accepts data for a single order and inserts it into the OLX database.

Receive CS Note - accepts data for a Customer Service note for a given customer and inserts it into the OLX database.

Customer Lookup - retrieves all of the identifiable information about a customer including Address. Can be used to begin the authentication/activation of a user account linked to the OrderLogix system.

Activate Customer Account - retrieves all of the identifiable information about a customer. Then will allow the username and password to be set for the given customer.

Registered Customer Lookup - retrieves all of the information about a customer. This includes Customer Addresses, Payment Methods on file, Orders and Continuity subscriptions.

Update Order Billing Address - updates the billing address of a given order.

Update Order Shipping Address - updates the shipping address of a given order.

Update Order Payment Method - updates the Payment Method of a given order.

Update Autoshipment Next Ship Date - updates the Next Ship Date for a given continuity subscription for a customer.

Cancel Autoshipment - cancels a given continuity subscription for a customer.

Update Subscription Item - updates the item template details for a given continuity subscription for a customer. 

Add Payment Profile - adds a new Payment Method to be used in the system and attached to Autoship subscriptions. 

Update Payment Profile - updates the Payment Method of a given Payment Profile. 

Delete Payment Profile - delete a stored payment profile.

Add Address Profile - adds an Address Profile to the system. 

Update Address Profile - updates the Address Method of a given Address Profile. 

Delete Address Profile - deletes a stored address profile.

The attached documentation is an outline of the how to use this module including security considerations, process flow and details for the specification of the API.

    • Related Articles

    • OrderLogix Real-Time Order Submission API

      Module : Order Import V4 Topic : Real-Time Order Submission Version(s) : Version 5.0 and up Editions : Standard, Commerce, Call Center A list of API Exceptions can be found HERE Overview OrderLogix provides real-time API access to the system for ...

    • OLX Order Import/Export V4 Spec

      The OLX Order Import/Export V4 is compatible with OrderLogix version 4.0 & up. It is the newer, more detailed 145 column order import used to bring outside orders into the OrderLogix application. This is accomplished by creating a CSV (a file with ...

    • OLX Telemarketing Import Spec

      The OLX Telemarketing Import Spec is a 121 column order import used to bring outside calls and orders into the OrderLogix application. This is accomplished by creating a CSV (a file with information fields, each separated by a single comma) with all ...

    • OLX Telemarketing Import Spec

      The OLX Telemarketing Import Spec is a 121 column order import used to bring outside calls and orders into the OrderLogix application. This is accomplished by creating a CSV (a file with information fields, each separated by a single comma) with all ...

    • OLX Item Offer Import Spec

      Spec The OLX Item Offer Import is a three-function import that can create both new items and product offers, while attaching (or not attaching) them to scripts in the OrderLogix application. This is accomplished by creating a CSV (a file with ...