Add, edit, or delete customers
Add a new customer to your customer file
| Name | Necessary | Description |
|---|---|---|
shopID | Yes | Your institution's identifier |
key | Yes | Your API key |
data[title] | No | Title |
data[surname] | No | First name |
data[name] | No | Surname |
data[position] | No | Position (on the interface) |
data[email] | No | |
data[phone] | No | Phone |
data[addressline1] | No | Address line 1 |
data[addressline2] | No | Address line 2 |
data[adressComment] | No | Address comment |
data[postcode] | No | Postcode |
data[city] | No | City |
data[country] | No | Countries (FR, EN, BE, ...) |
data[identificationID] | No | Identity document number |
data[lat] | No | Latitude (float) |
data[lng] | No | Longitude (float) |
data[commentPrivate] | No | Private comment |
data[commentPublic] | No | Public comment |
data[registrationNumber] | No | Company Registration number |
data[VATnum] | No | VAT number |
data[barcode] | No | Barcode |
data[blacklist] | No | Blacklist |
data[clientGroupID] | No | SIRET (14 characters) |
data[phone2] | No | Phone 2 |
data[birthDate] | No | Date of birth (timestamp) |
data[activityCode] | No | Accounting code |
Edit a customer in your customer file
| Name | Necessary | Description |
|---|---|---|
shopID | Yes | Your institution's identifier |
key | Yes | Your API key |
id | Yes | Customer ID |
data[title] | No | Title |
data[surname] | No | First name |
data[name] | No | Surname |
data[position] | No | Position (on the interface) |
data[email] | No | |
data[phone] | No | Phone |
data[addressline1] | No | Address line 1 |
data[addressline2] | No | Address line 2 |
data[adressComment] | No | Address comment |
data[postcode] | No | Postcode |
data[city] | No | City |
data[country] | No | Countries (FR, EN, BE, ...) |
data[identificationID] | No | Identity document number |
data[lat] | No | Latitude (float) |
data[lng] | No | Longitude (float) |
data[commentPrivate] | No | Private comment |
data[commentPublic] | No | Public comment |
data[registrationNumber] | No | Company Registration number |
data[VATnum] | No | VAT number |
data[barcode] | No | Barcode |
data[blacklist] | No | Blacklist |
data[clientGroupID] | No | SIRET (14 characters) |
data[phone2] | No | Phone 2 |
data[birthDate] | No | Date of birth (timestamp) |
data[activityCode] | No | Accounting code |
Remove a customer from your customer file
| Name | Necessary | Description |
|---|---|---|
shopID | Yes | Your institution's identifier |
key | Yes | Your API key |
id | Yes | Customer ID |
async function editClient(){ const body = new URLSearchParams({ shopID: SHOPID, key: APIKEY, id: 123, 'data[name]': 'Dupond' }); const res = await fetch("https://kash.click/workers/editClient.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) .