Powered by Olark

InventoryAPI by Erply is a powerful backend for web shops, and more.

  • Use as a backbone for any web shop
  • Plug into your existing software
  • Connect inventory with POS and accounts

Erply Inventory API

List of pos related API functions

This is a list of all pos related API functions. Click on function name and you'll find all required and optional input parameters and response fields.

  • getProducts() - Retrieve your product database.

    In addition to product card fields, you can have API to return:
    • inventory quantities (set getStockInfo = 1);
    • costs and purchase prices (set getFIFOCost = 1);
    • price list prices in a particular store (set getPriceListPrices = 1);
    • recipes for assembly and bundle products (set getRecipes = 1);
    • package options (set getPackageInfo = 1);
    • replacement products (set getReplacementProducts = 1);
    • related products (set getRelatedProducts = 1);
    • product parameters (set getParameters = 1);
    • product files (manuals, specifications) (set getRelatedFiles = 1);
    • beverage containers (set getContainerInfo = 1);
    • detailed list of variations for a matrix product (set getMatrixVariations = 1).
    To add or edit a product, use saveProduct. To retrieve inventory quantities ONLY, or to synchronize that data, use getProductStock. To retrieve only price list prices, use getProductPrices.

    Services are also considered a special kind of products — non-stock products.
  • getProductPictures() - Retrieve product pictures.

    For each picture, ERPLY provides 4 URLs for 4 different image sizes. These URLs must not be hotlinked — you need to download the images to your application and serve them from there.

    Access to images is currently limited and the images are not accessible by default. If you need to access the files, please contact ERPLY customer support.

    The same information is also available through API call getProducts (field images), so if you need to query product information anyway, getProducts can also provide you the list of images for each product.
  • getProductPrices() - Retrieve a product's net sales price in a certain location, or net sales price for a specific customer — according to any price lists that apply.

    You can query prices for a single product (by supplying parameter productID) or multiple products at a time (by supplying parameter productIDs).

    If you do not want a price for a specific customer or location, but just need to know which price lists contain a specific item, see getProductPricesInPriceLists.
  • getSalesDocuments() - Retrieve sales documents (invoices, waybills, credit invoices, quotes or orders), according to the supplied filtering parameters.

    If you have specified document ID or invoice number, or if the search criteria match a single sales document, or if you have set getRowsForAllInvoices = 1, API returns all documents together with their rows. Otherwise only document headers will be returned.

    To create a new sales document (invoice, order or quote), see saveSalesDocument.

    If you are looking for a way to pull all sales data for external processing, see getSalesReport. getSalesReport can output either detailed data or aggregate it as needed: it can provide totals by products, by product groups, by dates, by locations, etc.
  • pollNewInvoices() - DEPRECATED. Ask system if there are any invoices that need verification by fiscal printer.
  • saveSalesDocument() - Create a new sales document (invoice, sales order, etc.) or update an existing one.

    Sales documents in Erply have a header with general information (customer, date etc.) and one or more lines that list the items, quantities and prices.

    Every sales document in Erply needs to be confirmed. When confirmed, a sales invoice, for example, 1) receives a number, 2) generates sales revenue and VAT / tax obligation and 3) removes sold items from inventory. A confirmed sales order places a reservation on ordered items. A confirmed document may not be fully editable any more, or you might need special user rights for some kinds of changes.

    Possible sales document types are listed below. Most common ones that you'll probably need, are:
    • INVWAYBILL (this is an ordinary sales invoice),
    • CASHINVOICE (basically the same, but the printout is formatted as a POS receipt),
    • ORDER (a sales order).
    List of sales documents can be retrieved with getSalesDocuments. If you are making a sale, but you first need to know up-to-date prices and correct tax (VAT) rates for the items customer has selected, and get invoice total, see calculateShoppingCart. To apply a payment to the sale, use savePayment.
  • sendByEmail() NEW - A request for sending a document or report by email. This API call is synchronous (returns when email is sent) and can take a few seconds to complete. Sending will be handled by the server. Email subject, sender's address, message content and attachment format (HTML/PDF) will be decided serverside and are configurable from ERPLY settings.
  • sendInvoiceVerification() - Sends a verification code for an invoice, provided by fiscal printer.
Ask your question and we will contact you
Erply is a service of Erply Ltd © 2010 Erply.
9th floor 107 Cheapside London
Company No. 07043823