HelperStable

Create return

Ouvre un retour contre une commande en définissant les lignes et quantités demandées.

Objet métier
Create return
Lifecycle métier
État actualisé

Vue d’ensemble

Ouvre un retour contre une commande en définissant les lignes et quantités demandées.

Exemple

Créer une demande de retour pour deux lignes d’une commande livrée et lui attribuer une référence de suivi métier.

Paramètres 6

orderRequisOrder
Commande plateforme sur laquelle appliquer la transition ou depuis laquelle ouvrir le retour.
itemsRequisreturn request item[]
Lignes et quantités concernées par cette étape. Elles doivent correspondre aux lignes du document ou du retour ciblé.
referenceOptionnelstring
Référence métier lisible attribuée au retour.
source_referenceOptionnelstring
Référence stable de votre système source utilisée pour corrélation ou idempotence lorsque le contrat le permet.
metadataOptionnelmetadata
Metadata d’intégration libre à associer à la ressource créée.
return_urlOptionnelstring
URL facultative associée au parcours client de retour.

Sorties 1

returnReturn
Retour canonique après application de l’étape lifecycle.

Comportement

Le node valide les lignes contre la commande source, crée le retour canonique et conserve les quantités demandées comme point de départ du lifecycle.

À retenir Le node applique une opération métier canonique : il ne contourne pas le lifecycle de l’objet et échoue si la transition demandée n’est pas compatible avec son état courant.

Limites et responsabilités

  • Créer le retour n’autorise pas encore nécessairement les marchandises à être renvoyées.
  • Les quantités demandées doivent rester compatibles avec les lignes de la commande source.