Help Center

This help will guide you through the setup and usage of our point of sale cash register software.

Search by keyword in the help section:

List your store account options

Get your store account setup.

POST https://kash.click/workers/getShopInfos.php

Returns your store account options as a JSON file

POST parameters

Name	Necessary	Description
`shopID`	Yes	Your institution's identifier
`key`	Yes	Your API key

Data returned

The data is returned in the form of a JSON structure.

Name	Description
`email`	Email address of the establishment
`shopName`	Store Name
`companyRegistrationNum`	Company registration number (RCS)
`taxRegistrationNum`	VAT number
`adressline1`	Address line 1
`postCode`	Postcode
`city`	City
`country`	Country
`lat`	lat
`lng`	lng
`phone`	Phone
`urlwebsite`	URL of your website (external)
`defaultAccountingChapter`	Default accounting chapter
`pdffooter`	Footer text for PDF invoices
`receiptHeader`	Ticket header
`receiptFooter`	Ticket footer
`defaultVatID`	Default VAT rate identifier
`currency`	Currency
`language`	Language
`pricesAreProvidedTaxIncluded`	0 = Prices are entered including VAT; 1 = Prices are entered excluding VAT
`paypalAddress`	Your PayPal email address (for collecting payments)
`deliv_tablePlan`	Table/seats management
`deliv_takeAway`	Takeaway
`deliv_drivethru`	Drive thru
`deliv_deliver`	Delivery management
`deliv_bar`	Counter sales
`deliv_relayDeposit`	Delivery to a collection point
`deliv_default`	Default delivery method
`receipt_showVat`	Display VAT on tickets
`receipt_showShopName`	Display the shop name on the tickets
`receipt_showCashbox`	Display the cashier's name on the receipts
`receipt_showSeller`	Display the seller's name on the tickets
`receipt_showClient`	Display the customer's name on the tickets
`receipt_showAddress`	Display the store's contact details on the tickets
`receipt_showCompanyRegistrationNum`	Display the store's company number on the receipts
`receipt_showClientSurname`	Display the customer's first name on the tickets
`receipt_showClientAddress`	Display the customer's address on the tickets
`receipt_showClientPhone`	Display the customer's phone number on the tickets
`receipt_showGlobalVat`	Display the general VAT on the tickets
`receipt_showComment`	Show ticket comments
`receipt_showPricesBeforeTaxes`	Display prices excluding VAT on tickets
`orderRequires_deliveryChoice`	Choosing a delivery method is mandatory for each order.
`orderRequires_name`	The customer's name is required for each order.
`orderRequires_surname`	The customer's first name is required for each order.
`orderRequires_address`	The customer's address is required for each order.
`orderRequires_email`	Customer email address is required for each order
`orderRequires_phone`	Customer phone number is required for each order
`orderRequires_date`	Choosing a date is mandatory for each order.
`orderRequires_CompanyRegistrationNum`	The customer's company number is required for each order.
`orderRequires_comment`	Comment required for each order
`enable_stock`	Activate inventory management
`enable_barcodes`	Enable barcode handling
`enable_departments`	Activate shelf management
`enable_departmentsGroups`	Enable shelf group management
`enable_credits`	Enable asset management
`enable_descriptionsForItems`	Enable descriptions for items
`enable_variations`	Enable variation management
`enable_delivShop`	Activate deliveries with Deliv.shop
`enable_relayDeposit`	Enable pickup point management
`enable_descriptionForVariations`	Enable descriptions for items
`enable_dateOfConsumption`	Enable expiration date management
`enable_coupons`	Enable coupon management
`enable_weightForItems`	Enable item weight management
`enable_whiteLabel`	Enable white labeling (note: cannot be disabled)
`whiteLabelAdminUserID`	White label administrator user ID
`isWebShopEnabled`	Activate the webshop
`webShopURL`	Webshop URL
`webShopLang`	Webshop language
`webShopCol1`	Background color 1
`webShopCol2`	Background color 2
`webShopCol3`	Background color 3
`webShopColT1`	Text color 1
`webShopColT2`	Text color 2
`webShopColT3`	Text color 3
`prestaShopApiKey`	Prestashop API key
`prestaShopURL`	Your Prestashop URL
`enableYavin`	Enable Yavin payment collection
`yavinSecret`	Secret code
`yavinSerial`	yavinSerial
`enableVivaWallet`	Activate payment collection with Viva.com
`vivaWalletMerchant`	Viva.com Merchant ID
`vivaAccoundID`	Viva.com account ID

JavaScript example

async function setShopOptions(){ const body = new URLSearchParams({  shopID: SHOPID,  key: APIKEY }); const res = await fetch("https://kash.click/workers/getShopInfos.php", {  method: "POST",  headers: { "Content-Type": "application/x-www-form-urlencoded" },  body }); let payload; try{ payload = await res.json(); }catch{ payload = await res.text(); } console.log(payload);}

This document is made available under the terms of the licence Creative Commons Attribution 4.0 International (CC BY 4.0) .

Free cash register

Learn More

Follow Us

List your store account options

POST https://kash.click/workers/getShopInfos.php

POST parameters

Data returned

JavaScript example