View order summary
Users must be able to view the order details and the tasks that can be performed on the order.
The following section describes APIs, user exits, services, and other components.
getCompleteOrderDetailsAPI is called to display the order details in the Order Summary screen. The Order Summary screen contains the following information:
- Primary details such as the order number, date, status, total, channel and the number of open alerts. If there are any holds applicable to the order, it is indicated by the hold symbol that is displayed next to the order status.
- Alerts: The
getExceptionListAPI is called to retrieve the number of open alerts that are associated with the current order. The number of open alerts is displayed as a link on the Order Summary screen. This is a link to the Alert Search screen to search alerts. If there is a single alert, the Alert Details screen is displayed.
- Order status: The order status that is generated by the application
can be different from the status that the user wants to convey to
the customers. For example, an order can be in the "Scheduled" status,
but the user may want to convey to customers that the order is in
progress. In such situations, you can implement the
YFSGetOverallStatusUEuser exit to retrieve the display status in the
- When the user clicks the total amount, the
getCompleteOrderDetailsAPI retrieves the order pricing details such as adjustments, shipping charges, taxes, and so on.
- Bill To and Ship To: The billing address and shipping address
of the customer associated with the order are displayed by the
getCompleteOrderDetailsAPI. If the order is associated with multiple shipping addresses, a message that states "Multiple addresses exist" is displayed.
- Order Lines: The
getCompleteOrderLineListAPI is called to display the list of order lines in the order.
- Notes: The
getNoteListAPI is called to retrieve all notes that are created for the order. 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
getNoteListAPI is called with the filter criteria to display filtered results.
When the user adds a note, the
changeOrderAPI is called to save the note to the order and the
getNoteListAPI is called again to display the saved notes.Notes are also logged automatically whenever a user does any of the following tasks:
- Add Lines to Order
- Cancel Order
- Change Customer Options
- Change Gift Options
- Create Order
- Customer Appeasement
- Manage Payment
- Price Match
For more information about automatic notes logging, see Automatic notes logging.
- Returns: When the user clicks the Returns tab, the
getOrderListAPI is called to retrieve the return orders. This tab is displayed only if the order is associated with a return order
- Related Tasks panel: This panel displays
the tasks that the logged-in user can do on the order. For example,
Add Lines to Order, Change Order Address.Orders can be created and modified through multiple channels or different versions of the same application. If the order is modified in an external system and is no longer supported by the current application, the support level is calculated. The
getCompleteOrderDetailsAPI returns a
SupportLevelattribute for the
ApplicationVersionattributes that are passed in the input. The
SupportLevelattribute can have one of the following values:
Minimum: If this value is returned, all the related tasks are disabled. Only the primary information of the order is displayed. In place of the order lines, a message is displayed, which indicates that the order is modified externally and cannot be viewed by using the current version of the application.
Medium: If this value is returned, few related tasks are enabled.
Full: If this value is returned, all the related tasks are enabled.
The following section describes the rules that you must configure.
The related tasks are displayed in the Order Summary screen only if the logged-in user has the required resource permissions. For more information about administering user group permissions, see Administering user group permissions.
For more information about the APIs and user exits, see the Javadoc.
Users can manage orders and respond to customer queries conveniently.