Package de.hybris.platform.ycommercewebservices.v2.controller

Class OrdersController

  • @Controller
@RequestMapping("/{baseSiteId}")
public class OrdersController
extends BaseCommerceController
    Web Service Controller for the ORDERS resource. Most methods check orders of the user. Methods require authentication and are restricted to https channel.

    • Constructor Detail

      • OrdersController

        public OrdersController()

    • Method Detail

      • getOrder

        @Secured("ROLE_TRUSTED_CLIENT")
@RequestMapping(value="/orders/{code}",
                method=GET)
@Cacheable(value="orderCache",
           key="T(de.hybris.platform.commercewebservicescommons.cache.CommerceCacheKeyGenerator).generateKey(false,true,\'getOrder\',#code,#fields)")
@ResponseBody
public OrderWsDTO getOrder​(@PathVariable
                           java.lang.String code,
                           @RequestParam(defaultValue="DEFAULT")
                           java.lang.String fields)

      • getUserOrders

        @Secured({"ROLE_CUSTOMERGROUP","ROLE_CLIENT","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/users/{userId}/orders/{code}",
                method=GET)
@Cacheable(value="orderCache",
           key="T(de.hybris.platform.commercewebservicescommons.cache.CommerceCacheKeyGenerator).generateKey(true,true,\'getOrderForUserByCode\',#code,#fields)")
@ResponseBody
public OrderWsDTO getUserOrders​(@PathVariable
                                java.lang.String code,
                                @RequestParam(defaultValue="DEFAULT")
                                java.lang.String fields)

      • getUserOrderHistory

        @Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/users/{userId}/orders",
                method=GET)
@ResponseBody
public OrderHistoryListWsDTO getUserOrderHistory​(@RequestParam(required=false)
                                                 java.lang.String statuses,
                                                 @RequestParam(defaultValue="0")
                                                 int currentPage,
                                                 @RequestParam(defaultValue="20")
                                                 int pageSize,
                                                 @RequestParam(required=false)
                                                 java.lang.String sort,
                                                 @RequestParam(defaultValue="DEFAULT")
                                                 java.lang.String fields,
                                                 javax.servlet.http.HttpServletResponse response)

      • countUserOrders

        @Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/users/{userId}/orders",
                method=HEAD)
@ResponseBody
public void countUserOrders​(@RequestParam(required=false)
                            java.lang.String statuses,
                            javax.servlet.http.HttpServletResponse response)

      • doCancelOrder

        @Secured({"ROLE_CUSTOMERGROUP","ROLE_TRUSTED_CLIENT","ROLE_CUSTOMERMANAGERGROUP"})
@RequestMapping(value="/users/{userId}/orders/{code}/cancellation",
                method=POST)
@ResponseStatus(OK)
public void doCancelOrder​(@PathVariable
                          java.lang.String code,
                          @RequestBody
                          CancellationRequestEntryInputListWsDTO cancellationRequestEntryInputList)

      • validateUserForOrder

        protected void validateUserForOrder​(java.lang.String code)
        Validates if the current user has access to the order
        Parameters:
        code - the order code
        Throws:
        NotFoundException - if current user has no access to the order