HelperStable

Create return

Opens a return against an order by defining the requested lines and quantities.

Business object

Create return

Business lifecycle

Updated state

Vue d’ensemble

Opens a return against an order by defining the requested lines and quantities.

Exemple

Create a return request for two lines of a delivered order and assign it a business tracking reference.

Parameters 6

orderRequisOrder

Platform order on which to apply the transition or from which to open the return.

itemsRequisreturn request item[]

Lines and quantities concerned by this step. They must correspond to lines on the targeted document or return.

referenceOptionnelstring

Human-readable business reference assigned to the return.

source_referenceOptionnelstring

Stable reference from your source system used for correlation or idempotency when the operation contract allows it.

metadataOptionnelmetadata

Free-form integration metadata to associate with the created resource.

return_urlOptionnelurl

Optional URL associated with the customer return journey.

Outputs 1

returnReturn

Canonical Return after applying the lifecycle step.

Behavior

The node validates the lines against the source order, creates the canonical Return, and preserves the requested quantities as the starting point of the lifecycle.

Key point The node applies a canonical business operation: it does not bypass the object's lifecycle and fails when the requested transition is incompatible with the current state.

Limits and responsibilities

Creating the Return does not necessarily authorize the goods to be sent back yet.
Requested quantities must remain consistent with source-order lines.