Legacy platform

View return line summary

The user must be able to view the summary of a return order line and do the related tasks.

Solution

The following section describes APIs, user exits, services, and other components.

A user can search a return order and view the return order lines. When the user selects a return order line to view its details, the Return Line Summary screen is displayed.

When the Return Line Summary screen loads, the getCompleteOrderLineDetails API is called to retrieve the primary details such as quantity, unit price, return to address, store to which the product should be returned, delivery method, and so on. The store to which the product should be returned is dependent on the return sourcing rules.
Note: Store details are not displayed for return order lines that are marked with the return method as "Customer Can Keep".
Additional information is displayed in the tabbed panels as described in the following list:
  • Components: If the current return order line is a bundle parent, the getOrderLineList API is called with the appropriate inputs to retrieve the components.
  • Related Lines: If the current return order line has related products, the getOrderLineList API is called to retrieve the list of related return order lines and handle the display of the attributes and pagination.

    To prevent unnecessary API calls, the Components and Related Lines tabs are loaded only after the user clicks the tab to view the details.

  • Line Notes: This tab displays the list of notes that are associated with the current return order line. The getParticipantNoteList API retrieves the list of notes.

    When the user adds a note, the changeOrder API is called to save the note to the order line and the getParticipantNoteList API is called again to display the saved notes.

  • Fulfillment: This tab displays the shipment details for the current return order line in repeating panels. The logic that is used to display the shipment tracking details for an order is reused.

There are two specific tasks that are related to a return order line. When a customer wants to know the status of the returned products, the user can click the "Where is my return?" link. The getCompleteOrderLineList API is called to display the Shipment Tracking screen. The user can view the status of the shipment for the return line.

When the customer wants to know about the refund for the products that are returned, the user can click the "Where is my refund?" link. The Payment Inquiry screen is displayed. The user can see the payment status, the order total, charges or refunds, credit towards exchanges, and so on. The getPaymentInquiryDetails API is called to display the Payment Inquiry screen.

The user can go back to the Return Summary screen by clicking the "Go to Return Summary" button. The getCompleteOrderLineList API is called again to display the Return Summary screen.

Implementation

The following section describes the rules that you must configure.
  • You must configure the standard unit of measure display rules for a product. To define the unit of measure for quantity, see Defining unit of measure.

  • You must configure the open box options appropriately to display the open box products in the return order. For more information about configuring these options, see the Configuring supplied and add-on solutions.
  • For more information about APIs, see the Javadoc.

End-user impact

The user can view detailed information about a return order line to inform the customer and take appropriate actions.