The Paladin eCommerce application programming interface (API) allows eCommerce platforms to integrate with Paladin to support online sales for our clients. The API provides ways (REST API calls) to access a store’s inventory data in Paladin and create invoices and update stock on hand (SOH) when an online sale is made.

When the integration is complete, Paladin Support enables the integration to access a store’s data in Paladin. 

Note: The online store (eCommerce platform) must write and test the integration using the Paladin eCommerce API repository on GitHub

How the eCommerce API works

The Paladin eCommerce API (Called the PaladinEcomAPI in GitHub) is a RESTful web service API and provides three key functions:

  • Get inventory data (Inventory API): This API retrieves inventory data by part number or will return all inventory items that are designated as online store items in Paladin. Online store items must have the Ext Sync checkbox selected. In Paladin, this checkbox is located in the Inventory module > General tab on the top right of the Item Information pane for each item. Refer to Options to enable external sync for eCommerce integration for inventory preparation.

Ext Sync checkbox
Figure 1: Ext Sync checkbox

The following inventory data is returned by the API when the request is made:

    • Description 3
    • Department
    • Class 1
    • Subclass 1
    • Part Number
    • Alt Part Number
    • Mfg Part Number
    • Description1
    • Description2
    • Weight
    • Core Charge
    • Stock On Hand
    • Qty On Order
    • Taxable
    • Retail Price
  • Create an invoice for an online sale and update stock on hand (Invoice API): When an online sale is made, this API creates an invoice in Paladin and updates stock on hand. To use this API, you must send the following data: 
    • Part Number, Description, Sold Price, and Quantity for each item sold
    • Invoice total
    • Optional: Customer rewards ID (If found in Paladin, the sale will be associated with that customer). 
  • Provide secure communication (Token API): The Paladin eCommerce integration utilizes OAuth 2.0 to authorize access to the client’s Paladin database. OAuth 2.0 is an industry standard for granting access to remote APIs across the web. 

Cost

Paladin

  • There is no cost to try out the API. 
  • If you create an integration, and want to connect to your Paladin data:
    •  Setup fee of $249
    • Monthly fee of $59

Refer to Paladin store: ECMPDCAPI*

eCommerce platform (online store)

  • Client is responsible for the cost of developing the integration using the eCommerce API.

If you have questions or suggestions about this information, contact support@paladinpos.com.

*Content is subject to change. For the most recent version, visit the Help Portal.
Printed on: 7/29/25