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:
Create an account
Ancienne version maintenue pour les applications existantes. Pour une nouvelle intégration, utilisez la création avec identité et courriel confirmé. Documentation actuelle
It is possible to create an account programmatically, by providing an email address and the account name.
Cette API conserve son URL, ses paramètres et la réponse immédiate APIKEY / SHOPID pour les intégrations existantes. Dans l’interface, la création passe par Connexion, avec confirmation du courriel et rattachement à l’identité. Une création par API ne confirme pas le courriel et ne rattache pas automatiquement le compte à une identité.
Attention: you will need to validate your email via the link that will be automatically sent to you, otherwise your account may be deleted after a certain period of inactivity.
1) Create an account
Two methods:
- From the interface : On the Registration page
- By POST request :
https://kash.click/workers/addShop.php
1.1 POST /workers/addShop.php
POST parameters
| Name | Required | Description |
|---|---|---|
email | Yes | Account email address |
accountTitle | Yes | Account title (name of the institution) |
configType | No | Default dataset ('Bar', 'Ticket-Office', 'Butchery-Delicatessen', 'Bakery', 'Brewery', 'Tobacconist', 'Cafe', 'Camping', 'Liquor-Shop', 'CBD', 'Coffee-shop', 'Coiffeur', 'Shops', 'Street-trade', 'Grocery-store', 'Florist', 'Food-truck', 'Cheese-shop', 'Beauty-institute', 'Library', 'Clothing-store', 'Market', 'Pharmacy', 'Pizzeria', 'Fish-shop', 'For-association', 'Dry-cleaning', 'Restaurant', 'Fast-food', 'Supermarket', 'Perfumery', 'Services', 'Ecommerce', 'Solana', 'ChatGPT', 'Claude', 'Prestashop', 'VivaWallet', 'SumUp', 'GoCardless', 'Sunmi', 'Yavin', 'Pennylane') |
data[companyRegistrationNum] | No | Company registration number (RCS) |
data[taxRegistrationNum] | No | VAT number |
data[adressline1] | No | Address line 1 |
data[postCode] | No | Postcode |
data[city] | No | City |
data[country] | No | Country |
data[lat] | No | lat |
data[lng] | No | lng |
data[phone] | No | Phone |
data[urlwebsite] | No | URL of your website (external) |
data[defaultAccountingChapter] | No | Default accounting chapter |
data[pdffooter] | No | Footer text for PDF invoices |
data[paymentDueDays] | No | Délai de paiement en jours (0 = comptant) |
data[recoveryFeeAmount] | No | Montant de l’indemnité pour frais de recouvrement (0 = aucune) |
data[recoveryFeeCurrency] | No | Devise de l’indemnité (code à 3 lettres) |
data[latePenaltyMode] | No | Pénalités de retard : ecb_plus_10, fr_legal_x3 ou custom |
data[latePenaltyRate] | No | Taux annuel personnalisé des pénalités (%) |
data[earlyPaymentDiscountRate] | No | Taux d’escompte pour paiement anticipé (%) (0 = aucun) |
data[earlyPaymentDiscountDays] | No | Délai d’escompte en jours (0 = à l’émission de la facture) |
data[receiptHeader] | No | Ticket header |
data[receiptFooter] | No | Ticket footer |
data[defaultVatID] | No | Default VAT rate identifier |
data[currency] | No | Currency |
data[language] | No | Language |
data[pricesAreProvidedTaxIncluded] | No | 0 = Prices are entered excluding VAT; 1 = Prices are entered including VAT |
data[paypalAddress] | No | Your PayPal email address (for collecting payments) |
data[deliv_tablePlan] | No | Table management |
data[deliv_takeAway] | No | Takeaway |
data[deliv_drivethru] | No | Drive thru |
data[deliv_deliver] | No | Delivery management |
data[deliv_bar] | No | Counter sales |
data[deliv_relayDeposit] | No | Delivery to a collection point |
data[deliv_default] | No | Default delivery method |
data[receipt_showVat] | No | Display VAT on tickets |
data[receipt_showShopName] | No | Display the shop name on the tickets |
data[receipt_showCashbox] | No | Display the cashier's name on the receipts |
data[receipt_showSeller] | No | Display the seller's name on the tickets |
data[receipt_showClient] | No | Display the customer's name on the tickets |
data[receipt_showAddress] | No | Display the store's contact details on the tickets |
data[receipt_showCompanyRegistrationNum] | No | Display the store's company number on the receipts |
data[receipt_showClientSurname] | No | Display the customer's first name on the tickets |
data[receipt_showClientAddress] | No | Display the customer's address on the tickets |
data[receipt_showClientPhone] | No | Display the customer's phone number on the tickets |
data[receipt_showGlobalVat] | No | Display the general VAT on the tickets |
data[receipt_showComment] | No | Show ticket comments |
data[receipt_showPricesBeforeTaxes] | No | Display prices excluding VAT on tickets |
data[orderRequires_deliveryChoice] | No | Choosing a delivery method is mandatory for each order. |
data[orderRequires_name] | No | The customer's name is required for each order. |
data[orderRequires_surname] | No | The customer's first name is required for each order. |
data[orderRequires_address] | No | The customer's address is required for each order. |
data[orderRequires_email] | No | Customer email address is required for each order |
data[orderRequires_phone] | No | Customer phone number is required for each order |
data[orderRequires_date] | No | Choosing a date is mandatory for each order. |
data[orderRequires_CompanyRegistrationNum] | No | The customer's company number is required for each order. |
data[orderRequires_comment] | No | Comment required for each order |
data[enable_stock] | No | Activate inventory management |
data[enable_barcodes] | No | Enable barcode handling |
data[enable_departments] | No | Activate shelf management |
data[enable_departmentsGroups] | No | Enable shelf group management |
data[enable_credits] | No | Enable asset management |
data[enable_descriptionsForItems] | No | Enable descriptions for items |
data[enable_variations] | No | Enable variation management |
data[enable_delivShop] | No | Activate deliveries with Deliv.shop |
data[enable_relayDeposit] | No | Enable pickup point management |
data[enable_descriptionForVariations] | No | Enable descriptions for items |
data[enable_dateOfConsumption] | No | Enable expiration date management |
data[enable_coupons] | No | Enable coupon management |
data[enable_weightForItems] | No | Enable item weight management |
data[enable_whiteLabel] | No | Enable white labeling (note: cannot be disabled) |
data[whiteLabelAdminUserID] | No | White label administrator user ID |
data[isWebShopEnabled] | No | Activate the webshop |
data[webShopURL] | No | Webshop URL |
data[webShopLang] | No | Webshop language |
data[webShopCol1] | No | Background color 1 |
data[webShopCol2] | No | Background color 2 |
data[webShopCol3] | No | Background color 3 |
data[webShopColT1] | No | Text color 1 |
data[webShopColT2] | No | Text color 2 |
data[webShopColT3] | No | Text color 3 |
data[prestaShopApiKey] | No | Prestashop API key |
data[prestaShopURL] | No | Your Prestashop URL |
data[saleWebhookURL] | No | Webhook URL for sales |
data[openingWebhookURL] | No | Webhook URL for cashbox closures |
data[enableYavin] | No | Enable Yavin payment collection |
data[yavinSecret] | No | Secret code |
data[yavinSerial] | No | yavinSerial |
data[enableVivaWallet] | No | Activate payment collection with Viva.com |
data[vivaWalletMerchant] | No | Viva.com Merchant ID |
data[vivaAccoundID] | No | Viva.com account ID |
data[whiteLabelManagerSet] | No | If data[whiteLabelManagerSet]='fromSecret', then it is also possible to provide the parameter $data["whiteLabelManagerSecret"] to assign an existing manager to the account; If data[whiteLabelManagerSet]='new', then it is also possible to provide the parameters $data["whiteLabelData"]["nom"],$data["whiteLabelData"]["rcs"],$data["whiteLabelData"]["vat"],$data["whiteLabelData"]["addressLine1"],$data["whiteLabelData"]["addressLine2"],$data["whiteLabelData"]["codePostal"],$data["whiteLabelData"]["ville"],$data["whiteLabelData"]["pays"],$data["whiteLabelData"]["telephone"],$data["whiteLabelData"]["email"] |
Expected JSON response (success)
{ "success":true, "result":"Here are your credentials", "APIKEY": "[your token]", "SHOPID": "[shop account ID]"}Expected JSON response (failure)
{ "success": false, "result": "Error sending email"}JavaScript example (fetch)
const email = "mon.email@example.com";const accountTitle = "My Shop";fetch("https://kash.click/workers/addShop.php", { method: "POST", headers: { "Content-Type": "application/x-www-form-urlencoded" }, body: new URLSearchParams({ email, accountTitle })}) .then(r => r.json()) .then(data => { if (data.success) { console.log("Token:", data.APIKEY); console.log("Shop:", data.SHOPID); } else { console.error("Auth error", data); } });2) With the API key you can…
- Download your sales data
- Download items, customers, departments, etc.
- Record sales
Spécification OpenAPI de cette ancienne version
Spécification OpenAPI de cette ancienne version
Les nouvelles clés délivrées par authentification ou création de boutique sont des clés gérées, sans expiration et avec toutes les autorisations. Elles apparaissent dans Configuration → Webservices → Clés API et peuvent ensuite être limitées ou révoquées. Les anciennes clés déjà utilisées restent valides.
Sign up now
This document is made available under the terms of the licence Creative Commons Attribution 4.0 International (CC BY 4.0) .