de.hybris.platform.consignmenttrackingfacades

Interface ConsignmentTrackingFacade

All Known Implementing Classes:

DefaultConsignmentTrackingFacade

public interface ConsignmentTrackingFacade

The facade interface of ConsignmentTracking

Method Summary

Modifier and Type	Method and Description
java.util.Optional<ConsignmentData>	getConsignmentByCode(java.lang.String orderCode, java.lang.String consignmentCode) find consignment by its code, if events is null, send a request to carrier to retrieve
java.util.List<ConsignmentData>	getConsignmentsByOrder(java.lang.String orderCode) get all consignments under the order
java.lang.String	getTrackingUrlForConsignmentCode(java.lang.String orderCode, java.lang.String consignmentCode) get tracking provider service url

Method Detail

getConsignmentByCode

java.util.Optional<ConsignmentData> getConsignmentByCode(java.lang.String orderCode,
                                                         java.lang.String consignmentCode)

find consignment by its code, if events is null, send a request to carrier to retrieve

Parameters:

orderCode - the code of this consignment's order

consignmentCode - the consignment's code

Returns:

Option of the consignment if it exists and empty optional otherwise

getTrackingUrlForConsignmentCode

java.lang.String getTrackingUrlForConsignmentCode(java.lang.String orderCode,
                                                  java.lang.String consignmentCode)

get tracking provider service url

Parameters:

orderCode - the code of this consignment's order

consignmentCode - the code of specific consignment

Returns:

the url of tracking provider service for retrieving tracking events

getConsignmentsByOrder

java.util.List<ConsignmentData> getConsignmentsByOrder(java.lang.String orderCode)

get all consignments under the order

Parameters:

orderCode - the order code

Returns:

the all consignment for the order