Package com.broadleafcommerce.shipping.web.endpoint

Class LabelEndpoint

java.lang.Object

com.broadleafcommerce.shipping.web.endpoint.LabelEndpoint

@FrameworkRestController
@FrameworkMapping("/label")
@DataRouteByKey("shipping")
public class LabelEndpoint
extends Object

Constructor Summary

Constructors

Constructor	Description
LabelEndpoint(ShippingLabelProviderService shippingLabelProviderService)

Method Summary

Modifier and Type	Method	Description
protected ShippingLabelProvider	getLabelProvider(String fulfillmentOptionName)
ShipmentStatus	labelStatus(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, com.broadleafcommerce.order.client.domain.OrderFulfillment orderFulfillment)
ShippingLabelDownload	purchaseLabel(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, com.broadleafcommerce.order.client.domain.OrderFulfillment orderFulfillment)
ShippingLabelDownload	reprintLabel(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, com.broadleafcommerce.order.client.domain.OrderFulfillment orderFulfillment)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LabelEndpoint

public LabelEndpoint(ShippingLabelProviderService shippingLabelProviderService)

Method Detail

labelStatus

@Policy(permissionRoots="SHIPPING_LABEL",
        operationTypes=READ)
@FrameworkPostMapping("/status")
public ShipmentStatus labelStatus(@ContextOperation
                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                  @RequestBody
                                  com.broadleafcommerce.order.client.domain.OrderFulfillment orderFulfillment)

purchaseLabel

@Policy(permissionRoots="SHIPPING_LABEL",
        operationTypes=CREATE)
@FrameworkPostMapping("/purchase")
public ShippingLabelDownload purchaseLabel(@ContextOperation(CREATE)
                                           com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                           @RequestBody
                                           com.broadleafcommerce.order.client.domain.OrderFulfillment orderFulfillment)
                                    throws LabelException

Throws:

LabelException

reprintLabel

@Policy(permissionRoots="SHIPPING_LABEL",
        operationTypes=READ)
@FrameworkPostMapping("/reprint")
public ShippingLabelDownload reprintLabel(@ContextOperation
                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                                          @RequestBody
                                          com.broadleafcommerce.order.client.domain.OrderFulfillment orderFulfillment)
                                   throws LabelException

Throws:

LabelException

getLabelProvider

protected ShippingLabelProvider getLabelProvider(String fulfillmentOptionName)
                                          throws LabelException

Throws:

LabelException