Enregistrer des ventes dans le logiciel

Envoyez une commande complète : articles, client, mode de paiement, livraison, etc.

Informations complémentaires

Créer un nouveau client dans la même requête

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]=FR
client[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]

Méthode de livraison

Le champ deliveryMethod peut avoir des valeurs allant de 0 à 6 :

itemsList[] — Structure

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
• Vente libre en rayon : -[idRayon]_[prix]_[titre] — crée une ligne libre rattachée au rayon
• Vente libre : Free_[prix]_[titre] — crée une ligne libre

Exemples JavaScript

Vente simple

async function recordSaleWithExistingClient(){
  const body = new URLSearchParams({
    shopID: SHOPID,
    key: 'REMPLACER_PAR_VOTRE_CLE_API_GENEREE',
    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/webapp.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);
}

Client existant

async function recordSaleWithExistingClient(){
  const body = new URLSearchParams({
    shopID: SHOPID,
    key: 'REMPLACER_PAR_VOTRE_CLE_API_GENEREE',
    payment: -1,
    idClient: 123
  });
  body.append("itemsList[]", "12_2_Pizza 4 fromages_14.50_3_8");
  body.append("itemsList[]", "-5_9.99_Vente libre");

  const res = await fetch("https://kash.click/workers/webapp.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);
}

Nouveau client

async function recordSaleWithNewClient(){
  const body = new URLSearchParams({
    shopID: SHOPID,
    key: 'REMPLACER_PAR_VOTRE_CLE_API_GENEREE',
    payment: -1
  });
  body.append("client[nom]", "Durand");
  body.append("client[prenom]", "Zoé");
  body.append("client[email]", "zoe.durand@example.com");
  body.append("client[telephone]", "+33 6 12 34 56 78");
  body.append("client[adresseligne1]", "10 rue des Écoles");
  body.append("client[adresseligne2]", "Bât. B");
  body.append("client[commentaireadresse]", "Sonner 2 fois");
  body.append("client[codepostal]", "75005");
  body.append("client[ville]", "Paris");
  body.append("client[pays]", "FR");
  body.append("client[numtva]", "FRXX999999999");
  body.append("client[rcs]", "RCS Paris 123 456 789");
  body.append("client[codeBarre]", "CUST-0001");
  body.append("client[telephone2]", "+33 1 23 45 67 89");
  body.append("client[lat]", "48.848");
  body.append("client[lng]", "2.347");
  body.append("itemsList[]", "Free_19_Item");
  body.append("itemsList[]", "Free_5.4_OtherItem");

  const res = await fetch("https://kash.click/workers/webapp.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);
}

Réponse JSON attendue

Commande validée, non payée

{
  "success": true,
  "orderID":17724460,
  "paymentLink":"A link the client can use to pay the order",
  "invoice":"URL of the PDF invoice"
}

Commande non validée, non payée

{
  "success": true,
  "orderID":17724461,
  "paymentLink":"A link the client can use to pay the order",
  "quote":"URL of the PDF qduote"
}

Commande validée, payée

{
  "success": true,
  "orderID":17724461,
  "invoice":"URL of the PDF qduote"
}

Echec

{
  "success": false,
  "result": "Error message"
}