View Categories

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

3 minutes

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.

Opération Méthode Description
onlinestore_refresh_order POST Rejouer l’import d’un lot de documents depuis leur boutique

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 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.

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.

Ce que l’opération garantit #

  • Elle met à jour le document existant, elle n’en crée pas un second : la référence de la
    commande sur la boutique reste sa clef.
  • Elle refuse de toucher un document avancé dans Kafinea (finalisé, transformé). Le document est
    alors nommé dans les erreurs de la réponse, avec la raison.
  • Un document en erreur n’empêche pas les autres : chaque document est traité pour lui-même, et
    vous pouvez rejouer celui qui a échoué seul.
  • Elle est rejouable : rafraîchir deux fois de suite donne le même résultat.

Rafraîchir un lot de documents #

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

Paramètre Type Requis Description
operation string oui onlinestore_refresh_order
sessionName string oui Identifiant de session obtenu à l’authentification
ids string oui Tableau JSON d’identifiants Webservice de documents, 100 au maximum

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=["5x98832","5x98831"]'

Réponse :

{
  "success": true,
  "result": {
    "processed": 2,
    "refreshed": 2,
    "documents": [
      {"index": 0, "id": "5x98832", "module": "SalesOrder", "externalRef": "50981", "storeId": 44053},
      {"index": 1, "id": "5x98831", "module": "SalesOrder", "externalRef": "50980", "storeId": 44053}
    ],
    "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 🔗 #