Package com.broadleafcommerce.orderoperation.web.endpoint

Class ReturnOperationEndpoint

java.lang.Object

com.broadleafcommerce.orderoperation.web.endpoint.ReturnOperationEndpoint

@FrameworkRestController
@FrameworkMapping("/return-operations")
public class ReturnOperationEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
ReturnOperationEndpoint(ReturnOperationService returnOperationService)

Method Summary

Modifier and Type	Method	Description
List<com.broadleafcommerce.order.client.domain.ReturnAuthorization>	cancelReturn(javax.servlet.http.HttpServletRequest request, String orderId, CancelReturnRequest cancelReturnRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.order.client.domain.ReturnAuthorization	confirmReturn(javax.servlet.http.HttpServletRequest request, String orderId, ConfirmReturnRequest confirmReturnRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.order.client.domain.ReturnAuthorization	createReturn(javax.servlet.http.HttpServletRequest request, String orderId, ReturnRequest returnRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.order.client.domain.ReturnAuthorization	estimateReturn(javax.servlet.http.HttpServletRequest request, String orderId, ReturnRequest returnRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from class java.lang.Object

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

Field Detail

BASE_URI

public static final String BASE_URI

See Also:

Constant Field Values

Constructor Detail

ReturnOperationEndpoint

public ReturnOperationEndpoint(ReturnOperationService returnOperationService)

Method Detail

createReturn

@Policy(permissionRoots={"CUSTOMER_RETURN","RETURN_AUTHORIZATION"},
        identityTypes={OWNER,ADMIN})
@FrameworkPostMapping(value="/{orderId}/create-return",
                      consumes="application/json")
public com.broadleafcommerce.order.client.domain.ReturnAuthorization createReturn(javax.servlet.http.HttpServletRequest request,
                                                                                  @PathVariable("orderId")
                                                                                  String orderId,
                                                                                  @RequestBody
                                                                                  ReturnRequest returnRequest,
                                                                                  @ContextOperation(CREATE)
                                                                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

confirmReturn

@Policy(permissionRoots="RETURN_AUTHORIZATION")
@FrameworkPostMapping(value="/{orderId}/confirm-return",
                      consumes="application/json")
public com.broadleafcommerce.order.client.domain.ReturnAuthorization confirmReturn(javax.servlet.http.HttpServletRequest request,
                                                                                   @PathVariable("orderId")
                                                                                   String orderId,
                                                                                   @RequestBody
                                                                                   ConfirmReturnRequest confirmReturnRequest,
                                                                                   @ContextOperation(UPDATE)
                                                                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

cancelReturn

@Policy(permissionRoots="RETURN_AUTHORIZATION")
@FrameworkPostMapping(value="/{orderId}/cancel-return",
                      consumes="application/json")
public List<com.broadleafcommerce.order.client.domain.ReturnAuthorization> cancelReturn(javax.servlet.http.HttpServletRequest request,
                                                                                        @PathVariable("orderId")
                                                                                        String orderId,
                                                                                        @RequestBody
                                                                                        CancelReturnRequest cancelReturnRequest,
                                                                                        @ContextOperation(UPDATE)
                                                                                        com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

estimateReturn

@Policy(permissionRoots={"CUSTOMER_RETURN","RETURN_AUTHORIZATION"},
        identityTypes={OWNER,ADMIN})
@FrameworkPostMapping(value="/{orderId}/estimate-return",
                      consumes="application/json")
public com.broadleafcommerce.order.client.domain.ReturnAuthorization estimateReturn(javax.servlet.http.HttpServletRequest request,
                                                                                    @PathVariable("orderId")
                                                                                    String orderId,
                                                                                    @RequestBody
                                                                                    ReturnRequest returnRequest,
                                                                                    @ContextOperation(CREATE)
                                                                                    com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)