This help will guide you through the setup and usage of our point of sale cash register software.
Rechercher par mot clé dans l'aide :
Vous pouvez modifier une commande tant qu'elle n'est pas validée.
Une fois validée, il est uniquement possible d'enregistrer le ou les paiements de la commande via le champ "payment".
Envoyez une commande complète : articles, client, mode de paiement, livraison, etc.
| Naam | Type | Verplicht | Beschrijving |
|---|---|---|---|
shopID | string | Ja | Votre identifiant de boutique (SHOPID) |
key | string | Ja | Votre Token (APIKEY) |
orderID | int | Ja | L'identifiant de la commande à modifier |
idUser | int | Neen | Identifiant d'utilisateur. Si non précisé, le logiciel crée un compte utilisateur avec le login "webservice" s'il n'existe pas déjà, et l'utilise. |
payment | int | Ja | -2 = Non payée, non validée ; -1 = Non payée, validée ; un identifiant de mode de paiement pour indiquer un paiement (peut être un identifiant d'un mode de remboursement) |
paymentAmount | int | Neen | Le montant payé, si "payment" indique un mode de paiement (si absent, le paiement est considéré comptant) |
idClient | int | Neen | Identifiant du client existant pour l'affecter à la commande |
client | array | Neen | Compte client à créer pour l'affecter à la commande* |
idtable | int | Neen | Identifiant de la table pour l'affecter à la commande |
idcaisse | int | Neen | Identifiant de la caisse pour l'affecter à la commande |
numcouverts | int | Neen | Nombre de couverts servis à la table |
publicComment | string | Neen | Commentaire adossé à la commande (public) |
privateComment | string | Neen | Commentaire adossé à la commande (privé) |
pagerNum | int | Neen | Numéro de bippeur |
deliveryMethod | int | Neen | Bezorgmethode* |
itemsList | array | Ja | Numéro de bippeur |
Si le client n'existe pas, vous pouvez le créer avec les champs suivants (à envoyer directement en POST) :
client[nom]=[nom]client[prenom]=[Prénom]client[email]=[Email]client[telephone]=[nom]client[adresseligne1]=[Adresse ligne 1]client[adresseligne2]=[Adresse ligne 2]client[commentaireadresse]=[nom]client[codepostal]=[Code postal]client[ville]=[Ville]client[pays]=FRclient[numtva]=[Numéro TVA]client[rcs]=[Numéro RC]client[codeBarre]=[Code barre]client[telephone2]=[Téléphone secondaire]client[lat]=[latitude]client[lng]=[longitude] Le champ deliveryMethod peut avoir des valeurs allant de 0 à 6 :
| Waarde | Signification |
|---|---|
| 0 | À emporter |
| 1 | À livrer |
| 2 | Sur place |
| 3 | Service au volant |
| 4 | Vente au comptoir |
| 5 | Point relai |
| 6 | À expédier |
Le champ itemsList est un tableau de chaines de caractères, chaque élément pouvant être de l'un des types suivants:
[idArticle] — ajoute un article (quantité 1)[idArticle]_[quantite] — préciser la quantité[idArticle]_[quantite]_[titre personnalisé]_[prix personnalisé] — forcer le titre et le prix[idArticle]_[quantite]_[titre]_[prix]_[idDéclinaison1]_[idDéclinaison2]_[idDéclinaison3]_[idDéclinaison4]_[idDéclinaison5] — ajouter jusqu'à 5 déclinaisons-[idRayon]_[prix]_[titre] — crée une ligne libre rattachée au rayonFree_[prix]_[titre] — crée une ligne libreasync function recordSaleWithExistingClient(){ const body = new URLSearchParams({ shopID: SHOPID, key: APIKEY, orderID: 123456, payment: -1 }); body.append("itemsList[]", "Free_12.99_Item"); body.append("itemsList[]", "Free_9.99_Other item"); const res = await fetch("https://kash.click/workers/editOrder.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);} async function recordSaleWithExistingClient(){ const body = new URLSearchParams({ shopID: SHOPID, key: APIKEY, payment: -2, orderID: 123456, idClient: 123 }); const res = await fetch("https://kash.click/workers/editOrder.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);} async function recordSaleWithNewClient(){ const body = new URLSearchParams({ shopID: SHOPID, key: APIKEY, orderID: 123456, payment: 123456 }); const res = await fetch("https://kash.click/workers/editOrder.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);}{ "success": true, "orderID":17724460, "paymentLink":"A link the client can use to pay the order", "invoice":"URL of the PDF invoice"} { "success": true, "orderID":17724461, "paymentLink":"A link the client can use to pay the order", "quote":"URL of the PDF qduote"} { "success": true, "orderID":17724461, "invoice":"URL of the PDF qduote"} { "success": false, "result": "Error message"}
Ce document est mis à disposition selon les termes de la licence Creative Commons Attribution 4.0 International (CC BY 4.0) .