APIs: Overview

13. joulukuuta 2022

APIs are the programmatic way to "talk to Erply", and let you:

  1. Fetch the data you see in Erply back office — eg. the list of products or customers.
  2. Or, add and modify data — eg. create a new sales order.
  3. Or, issue commands — eg. subtract reward points from customer's balance.
  4. Or, make queries — eg. ask the current effective price, including discounts and promotions, for a particular product in a particular store and for a specific customer.

Erply API

If you are new to Erply API development, then most likely what you need is "Erply API". It is an all-around, general-purpose API that supports Erply's standard features.

Erply API has a separate documentation site. You can start with usage instructions and the list of available calls.

Other APIs and Endpoints

We are also continuously introducing new purpose-built REST APIs — each one for a particular area of functionality. These APIs expose data in a more approachable format and have additional features.

These APIs consume and produce JSON.

For initial authentication, use a username and password. This will give you a session key to use with subsequent requests.

Account Administration API

Manage registers (points of sale), users and employees.

Authentication API

Build interactive user authentication, two-factor authentication, password resets.

Note: if you just need a session key to make calls from your integration, see verifyUser instead.

Configuration API for Apps (CAFA)

Store app configuration.


Upload and fetch pictures and files.


Manage customer information.

Inventory API

Fetch product quantities on hand, reserved quantities and cost changes. Add products to purchase orders and transfer orders.


Extend Erply records with additional data.

PIM (Product Information Management) API

Manage products and assortments.

Point of Sale API

Day opening and closing, cash in and out, gift cards.

Reports API

Fetch reports.

Sales Documents API

Create and retrieve sales documents. Fetch printouts.

WMS (Warehouse Management System) API

Fine-grained warehouse management.

Use Cases

A common need is to synchronize data from Erply to another system.

Here is a high-level overview how to build a web shop integration.

Erply supports push notifications via web hooks, but note that the information returned via web hooks might be limited.

What Our Customers Have Built

  • Complex e-Commerce solutions. Product listings, advanced search, related media (images, user guides, manuals, drivers and software). Ordering and billing. Customer login, lists of previous orders and their statuses, customized price lists.
  • Point-of-sale applications. Product quicklists, special pricelists, receipt printing, PDF invoice by e-mail.
  • Inventory management. Stocktaking over multiple warehouses, using portable barcode readers / data collecting devices.
  • Customer feedback. Ask customer feedback about a product or service. Customer can push a button on the shop counter to express satisfaction with the service.
  • Sales and product promotion. Online real-time sales reports; use LCD screens to promote new products and special offers.
  • Reporting and analysis. Display daily sales figures or comparison between salespersons at the office on LCD screen. Get online information from all sales locations.
  • Integration with e-commerce platforms like Magento, Joomla, PrestaShop, Shopify etc.