Shipment summary

As a store associate, you can view all information about a shipment on a single screen and conduct relevant tasks.

Solution

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

You come across the Shipment summary screen in Pick, Pack, and Ship flows. You can also view the Shipment summary screen by searching shipments by using the global search option or any of the portlets on the home page. If the search results in a single shipment, you are taken to the Shipment summary screen.

Based on the delivery method and status of a shipment, appropriate details and related tasks are displayed on the Shipment summary screen. This is applicable to transfer order shipments as well. The getShipmentDetails API is called to retrieve the details of a shipment on the Shipment summary screen.

For all shipments, the shipment number and status of the shipment are displayed. To view or hide additional information, you can toggle between Show information and Hide information links.

For Pickup in store shipments, the pickup date, customer contact details, billing address, and like items, are displayed. For Ship from store shipments, the shipment number, carrier, expected ship date, customer contact details, shipping address, billing address, and like items, are displayed.

Note: For Ship from store orders in Ready for packing and Packing in progress statuses, the expected ship date is displayed. However, when the shipment is packed and shipped, the shipping date is displayed instead.

Depending on the fulfillment type and status of the shipment, the next relevant task that can be done is displayed. For example, if the status of the shipment is Ready for backroom pick, the Pick order button is displayed. As a store associate, you can click Pick order and proceed with a backroom pick task. At the end of the task, you return to the Shipment summary screen.
Further, the adjacent More menu displays the next tasks relevant to the current shipment and its status. For example, a shipment in the Backroom pick in progress status has Continue picking and Assigning staging location as the related tasks.

Note: The relevant tasks are enabled for a shipment, based on the status. However, as a store associate, if you do not have the appropriate resource permissions, the relevant tasks are not displayed.

The Products tab displays the count of products in a shipment. You can view the products in the shipment, along with the product quantity, picked or packed quantity, and shorted quantity for each product. For a variation item, the attributes are also displayed. The getShipmentLineList API is called to display the products.

If you have a shortage of products, for Pickup in store shipments, the shorted quantity and the picked quantity is displayed. If you do not have a shortage, only the product quantity and picked quantity is displayed. Once the shipment is in Shipped status, only the product quantity is displayed.
If you have a shortage of products, for Ship from store shipments, the shorted quantity is displayed. The picked quantity is displayed for statuses until Ready for packing. From Packing in progress status until Packed status, the packed quantity is displayed. Once the shipment is in Shipped status, only the product quantity is displayed.

Note: Staging location information is displayed based on the status of the shipment. If the shipment is already shipped or picked up by a customer, the staging location is not displayed.

The Packages tab displays the count of packages for Ship from store shipments. As a store associate, you can view the packages for the shipments. If you have multiple packages for a shipment, they are displayed in separate panels under the Packages tab. The count of packages associated with the shipment is also displayed in the tab. You can click the Packages tab to view the packages for the shipment. The getShipmentContainerList API is called to fetch the packages.

For each package, a package number, count of products in the package and the weight are displayed. The products, and if applicable the tracking number, in the package are also displayed. Alongside each package, a More option is displayed. You can perform the following actions from the More menu:

Re-print carrier label: This option is enabled only when the packing labels are already printed and tracking number is generated. When you click the link, the StoreLabelReprint_94 service is called, which in turn calls the reprintCarrierLabel API to reprint the labels.
Re-print pack slip: This option is enabled if the packing labels are already printed and tracking number is generated. When you click the link, the StorePackSlip_173 service is called. This related task is disabled until the shipment status is labelled as Packed.
Unpack package: When you click this link, unpack reasons are displayed, if configured. The getCommonCodeList API is called with the CodeType as YCD_UNPACK_REASON to populate the reasons. When you select a reason and click Apply, the unpackShipment API is called to remove the package and unpack all the products that belong to the package.

Device-specific details

Due to space constraints on a mobile screen, the order number is truncated with an ellipsis and an additional link is provided. A pop-over shows the order number and shipment status.
Due to space constraints on a mobile screen, a horizontal scroll bar might appear for the Additional information panel of the shipment.

Implementation

The following information describes the rules that must be configured for the feature:

For the Shipment summary screen to load, the resource permissions applicable to any of the tasks such as Pick, Pack, Pickup, Ship, Global shipment search, or My task in progress is sufficient.

As a store associate, you must have the following resource permissions to perform picking tasks:
- Backroom pick for pickup in store
- Backroom pick for ship from store
- Pick all
- Print tickets for picking orders
- Manually update quantity while picking
You must have the following resource permissions to perform packing tasks:
- Pack order
- Unpack products
- Print pack slip
- Pack all
- Manually update quantity while packing
You must have the following resource permissions for customer pickup tasks:
- Customer pickup for pickup in store
- Pickup all
- Print customer pickup acknowledgment
You must also have the View tasks in progress resource permission to view tasks that are currently being performed.