1. Orders service – Returns

Returns actions, commands and pipelines

Version:

The following table describes the returns actions, commands and pipelines:

Action/Command/PipelineDescription
RequestRma

RequestRmaCommand

RequestRmaPipeline		Initiates a request for a return merchandise authorization (RMA).

Parameters:

  • orderId: the identifier of the order that contains the returned item
  • LineId: the identifier of the order line item being returned
  • Reason: the reason the shopper has entered, for the return
  • Quanity: quantity of the line items being returned
ValidateRmaRequestCommand

ValidateRmaRequestPipeline		Validates the return request.
ReturnedItemReceived

ReturnedItemReceivedCommand

ReturnedItemReceivedPipeline		Initiates the acknowledgement that the returned items have been received, and that the processing of the refund can proceed.

Parameters:

  • rmaId: the identifier of the RMA record for the returned item(s)
  • refundPaymentId: the identifier of the refund payment record
Note

StartOrderReturn is not used.

If you have suggestions for improving this article, let us know!