API REST – Rafraîchir une commande de boutique en ligne

Cette page décrit l’opération qui rejoue l’import d’un document déjà téléchargé depuis une boutique
en ligne. C’est l’équivalent, à distance et par lots, du bouton « Rafraîchir depuis la boutique »
présent sur le document.

Réservée aux administrateurs. L’opération réécrit des documents de gestion commerciale à partir
d’une source extérieure.

---

Quand l’utiliser #

Un document importé d’une boutique reflète la boutique au moment de l’import. Si un réglage de la
boutique a changé depuis (la reconnaissance du client, la création des clients, une règle de frais de
port, une correspondance d’article ou de mode de paiement ajoutée), le document ne bénéficie pas rétroactivement du nouveau
réglage. Le rafraîchissement le rejoue avec les réglages actuels, sous réserve des protections ci-dessous.

Le cas le plus fréquent : des commandes rattachées au client de repli de la boutique parce que
leur client n’était pas encore reconnu. Vous complétez les correspondances (voir
Import en masse) ou vous autorisez la création des clients sur la fiche
boutique, puis vous rafraîchissez les commandes concernées : chacune retrouve son client.

Le même lot permet de renseigner le mode de paiement après avoir complété les
Correspondances de paiement sur la fiche boutique. Le mode est repris avec la correspondance
actuelle. Si celle-ci reste à compléter, le rafraîchissement se poursuit et conserve le mode déjà
présent sur le document. Les conditions de paiement ne sont pas modifiées par cette correspondance.

Ce que l’opération garantit #

• Elle met à jour le document existant, sans créer un second document.
• Elle applique les contrôles habituels des documents verrouillés et des pièces liées. Un document dont
  les lignes sont reprises par une facture, un bon de livraison ou un avoir n’est pas rafraîchi : errors
  nomme ce document, et le document demandé reste inchangé.
• Elle recalcule la région fiscale quand la boutique la transmet. Si aucune région ne s’applique
  plus avec le paramétrage actuel, le document n’en porte plus et l’avis TVA à vérifier l’indique.
• Un refus n’empêche pas le traitement des autres documents. La réponse indique le document et la raison.
• Un nouveau passage reste possible pour les documents admissibles, avec les données et les
  réglages actuels. À source et réglages identiques, il conserve le même résultat.

Avant de lancer un lot, consultez les données, l’historique et les pièces liées des documents concernés.
Le rafraîchissement peut remplacer les corrections effectuées dans Kafinea par les données de la boutique ;
excluez les documents à conserver de la liste envoyée. Un avis TVA à vérifier ou un
Écart de montant boutique reste informatif et ne bloque pas, à lui seul, la facturation.

---

Rafraîchir un lot de documents #

POST https://apps.kafinea.com/{instance}/webservice.php

La boutique d’origine et la référence de la commande sont lues sur le document : vous n’avez rien
d’autre à fournir, et un document qui ne vient pas d’une boutique est signalé comme tel.

curl -X POST https://apps.kafinea.com/YourKafinea/webservice.php \
  -d "operation=onlinestore_refresh_order" \
  -d "sessionName=YOUR_SESSION_ID" \
  -d 'ids=["5x700001","5x700002"]'

Exemple de réponse (tous les identifiants de cette page sont fictifs) :

{
  "success": true,
  "result": {
    "processed": 2,
    "refreshed": 2,
    "documents": [
      {"index": 0, "id": "5x700001", "module": "SalesOrder", "externalRef": "DEMO-701", "storeId": 900001},
      {"index": 1, "id": "5x700002", "module": "SalesOrder", "externalRef": "DEMO-702", "storeId": 900001}
    ],
    "errors": []
  }
}

index est la position du document dans le tableau envoyé : c’est ce qui permet de retrouver la
ligne à corriger quand errors n’est pas vide.

---

Références associées 🔗 #

• Import en masse (correspondances d’identifiants)
• Opérations CRUD
• Requêtes et interrogation
• La région fiscale des documents