WebService permettant de générer des commandes de retours ventes.
Package : api/sales
Méthode : POST
Nom : salesReturns
Actions réalisées
Afin de pouvoir générer des retours, le code retour indiqué dans le paramètre d'appel returnCode doit vérifier certains critères :
- il doit exister dans GCDRV et être actif ;
- il doit générer un nouvel en-tête de commande, l'exécution des traitements est possible mais l'exécution d'un mnémonique d'enchaînement est impossible (choisir soit l'option "Générée" ou "Générée + traitements") ;
- il ne doit pas permettre de piloter par transaction la génération des conditions de facturation (option "D" impossible pour le champ "Génération des conditions de facturation") ;
- il ne doit pas faire de demande de confirmation si un retour a déjà été réalisé (option "D" impossible pour le champ "Action à réaliser suivant si retour déjà existant").
Le non respect de l'un de ces critères bloque la génération des retours.
Pour chaque commande à retourner :
- contrôle des paramètres d'appel de l'en-tête et de la ligne : ils doivent permettre de retrouver la commande ainsi que la ligne à retourner. La quantité commandée à retourner (gratuits non compris) doit aussi être précisée.
- génération de la commande de retour suivant le même fonctionnement que la génération d'un retour à partir d'une ligne modèle.
Appel
Pour connaître les paramètres d'appel du WebService, se reporter à l'interface le référençant.
Voir également la documentation technique sur l'utilisation des WebServices REST.
Paramètres d'appel (complément d'informations)
Le paramètre forceReturns permet de forcer la génération de la commande de retour dans le cas des alertes suivantes :
- un retour est effectué sur une vente de gratuit (alerte gérée par le champ "Alerte en cas de retour effectué/vente de gratuit" dans GCDRV) ;
- la quantité de retour est supérieure à la quantité initiale (alerte gérée par le champ "Action à réaliser suivant quantité retour" dans GCDRV).
Si la valeur du paramètre vaut :
- true : ces alertes n'empêchent pas la génération de la commande de retour ;
- false (valeur par défaut) : ces alertes sont gérées comme des erreurs bloquantes pour empêcher la génération de la commande de retour.
Explications : Dans la saisie des retours (GRETV), certaines alertes sont affichées à l'écran pour avertir l'utilisateur d'un éventuel problème avant de générer le retour. Il décide ensuite si le retour doit être généré (en ignorant l'alerte) ou non. Le WebService ne peut pas fonctionner ainsi, l'alerte est émise après la génération du retour, l'utilisateur est averti mais trop tard. Afin de garder la possibilité d'avertir l'utilisateur avant la génération du retour, ces alertes sont rendues bloquantes par défaut (le paramètre forceReturns est égal à false par défaut). Ainsi, lors de la génération du retour, l'utilisateur est averti par une alerte qui bloque la génération de la commande de retour. S'il veut générer le retour malgré l'alerte, il doit relancer le WebService en passant le paramètre forceReturns à true pour ignorer l'alerte.