View order line summary

A customer can inquire about a particular product in an order. In such scenarios, the user must be able to view the order line details, answer customer queries, and do related tasks.

Solution

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

A user can search for an order and view the Order Summary screen. The user can select an order line in the Order Lines tab to view the details. The following order line details are displayed in the Line Summary screen:
  • When the Line Summary screen loads, the getCompleteOrderLineDetails API is called to retrieve the primary details such as line number, unit price, list price, quantity, ship node, status, shipping address, pricing details, and so on. The 'level of service' for the current order line is retrieved and cached locally.
  • The order line status that is generated by the application can be different from the status that you want to convey to the customers. For example, an order line can be in the "Scheduled" status, but the users may want to convey to the customer that the order is in progress. In such situations, you can implement the YFSGetOverallStatusUE user exit to return the OverallStatus attribute. The getCompleteOrderLineDetails API can call the user exit in turn to retrieve the display status in the OverallStatus attribute for the Order Line Summary screen.
  • Additional information is displayed in the tabbed panels as described in the following list:
    • Important Events: This tab displays important events that are related to the current order line. The events are displayed in repeating panels. The getCompleteOrderLineDetails API retrieves appropriate notifications along with the date when the event occurred for the current order line, in the following scenarios:
      • The user cancels a product or changes the quantity.
      • The user creates a return order for the product.
      • The user does a price match for the product.
      • The user overrides the price of the product.
      • The user places a stop delivery request for the product.
    • Components: If the current order line is a bundle parent, the getCompleteOrderLineList API is called to retrieve the components.
      • When the user selects a component order line, the getCompleteOrderLineDetails API is called to display the component line summary.
      • When the user clicks "Open Parent Details" link on the Order Line Summary screen of the component, the getCompleteOrderLineDetails API is called to display the Order Line Summary screen for the parent product.
    • Related Lines: If the current order line has related products, the getCompleteOrderLineList API is called to retrieve the list of related order lines.

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

    • Notes: The getNoteList API is called to retrieve all notes that are created for the order line. Users can filter notes by using the filter options that include Note Type, Contact Type, and so on. When the user applies the filter to find the required notes, the getNoteList API is called with the filter criteria to display the results.

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

      For more information about automatic notes logging, see Automatic notes logging.

    • Fulfillment: This tab displays the shipment details for the current order line in repeating panels.

Implementation

The following section describes the rules that you must configure.

The related tasks are displayed in the Order Line Summary screen only if the logged-in user has the required resource permissions. For more information about assigning resource permissions to a user group, see the Administering user group permissions.

For more information about the APIs and user exits, see the Javadoc.

End-user impact

The user can view detailed order line level information to address customer's queries.