Retrieve all registers (points of sale), in all shops and locations. One shop can have many registers. A register has field "warehouseID" to indicate which store or warehouse it is located in.
To modify, add, or delete registers, please see Account Admin API and the following endpoints:
Note: Account Admin API offers a REST interface for retrieving registers — and also lets you create new registers and modify and delete existing ones. (Erply API does not have this functionality.)
|Parameter name||Description||Possible value||Required|
|type||Search by register type. Example: ECOM - E-commerce channel, SELFSER - Self-service POS, MPOS - mPos, REGPOS - Regular POS, IPADAPP - iPad app or INVAPP - invoice app.||String|
|searchName||Search by register name. Partial matches are also returned, but API searches only from the beginning of each field — not from the middle.||String|
|searchAttributeName||Name of attribute to search from. Both "searchAttributeName" and "searchAttributeValue" have to be specified. Error 1030 will be returned if value is an array.||String|
|searchAttributeValue||Attribute value to search for. Error 1030 will be returned if value is an array.||String|
|changedSince||Retrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with Erply.||Integer (Unix timestamp)|
|type||String||Indicates the type of the register|
|warehouseID||Integer||ID of the warehouse|
|warehouseName||String||Name of the warehouse|
|geoLatitude||Decimal, 6 places||Latitude (geographical location)|
|geoLongitude||Decimal, 6 places||Longitude (geographical location)|
|paymentServiceProvider||String||Card payment terminal / card swiper|
|vatrateID||Integer||Default VAT (tax) rate ID in this register.
NB! In Erply there is a whole hierarchy of tax rates, and rules for applying these tax rates. POS default tax rate is just one possible rule; tax rate may also be set at product level, location level, or product group level. Finally, certain customers may be marked as tax exempt, and there are different multi-tier tax rates.
You should use API call calculateShoppingCart to retrieve the appropriate tax rate for a specific customer and product in a specific location.
|vatrate||Decimal||Default VAT (tax) rate percentage. See above.|
|vatSumRange1||Integer||Multi-tier tax: threshold for Tier 2 tax. See a commoent about tax rates above.|
|vatrateIDrange1||Integer||Multi-tier tax: Tier 2 tax percentage.|
|vatSumRange2||Integer||Multi-tier tax: threshold for Tier 3 tax. See a commoent about tax rates above.|
|vatrateIDrange2||Integer||Multi-tier tax: Tier 3 tax percentage.|
|printSalesPersonName||0 or 1||Print salesperson's name on receipt|
|shopName||String||Shop name on customer display|
|storeCreditEnabled||0 or 1||Whether customers are allowed to use store credit in this POS.|
|lastInvoiceNo||Integer||For Windows Point Of Sale / Touch POS. Last invoice number issued by the POS application. POS application uses this field to continue correct numbering after reinstall/reload.
You may also use these numbers for your own API application (eg. a webshop), provided that you are NOT using our Windows Point Of Sale software. The correct way to use this field is to take the provided number and add 1 to it.
A separate number series is used, different from the one in Erply backend. The numbers consist of 8+ digits (a register ID prefix + number sequence 1,000,000...3,999,999).
|lastCouponNo||Integer||For Windows Point Of Sale only. Last coupon number issued by Windows Point Of Sale. The Windows application uses this field to continue correct numbering after reinstall.|
|quickButtons||Array||List of products and services that cashier can select with quick keys in this POS. The items are listed in order. Each item is either a product or a service. Item structure:
|added||Unix timestamp||Creation time.|
|lastModified||Unix timestamp||Last modification time.|
|attributes||Array||Additional attributes. Each item looks like this: