Package de.hybris.platform.ycommercewebservices.v1.controller

Class OrderController

  • @Controller("orderControllerV1")
@RequestMapping("/{baseSiteId}/orders")
public class OrderController
extends BaseController
    Web Service Controller for the ORDERS resource. All methods check orders of the current user. Methods require basic authentication and are restricted to https channel.

    • Constructor Detail

      • OrderController

        public OrderController()

    • Method Detail

      • getOrder

        @Secured("ROLE_CUSTOMERGROUP")
@RequestMapping(value="/{code}",
                method=GET)
@ResponseBody
public OrderData getOrder​(@PathVariable
                          java.lang.String code)
        Web service for getting current user's order information by order code.
        Sample call: https://localhost:9002/rest/v1/mysite/orders/1234
        This method requires authentication.
        Method type : GET.
        Method is restricted for HTTPS channel.
        Parameters:
        code - - order code - must be given as path variable.
        Returns:
        OrderData as response body.

      • getOrderByGuid

        @Secured("ROLE_CLIENT")
@RequestMapping(value="/byGuid/{guid}",
                method=GET)
@ResponseBody
public OrderData getOrderByGuid​(@PathVariable
                                java.lang.String guid)
        Web service for getting order information by order GUID.
        Sample call: https://localhost:9002/rest/v1/mysite/orders/byGuid/ea134b389f3d04b4821f51aa55c79f0766974f5f
        Method type : GET.
        Method is restricted for HTTPS channel.
        Parameters:
        guid - - order guid - must be given as path variable.
        Returns:
        OrderData as response body.

      • getPagedOrdersForStatuses

        @Secured("ROLE_CUSTOMERGROUP")
@RequestMapping(method=GET)
@ResponseBody
public OrderHistoriesData getPagedOrdersForStatuses​(@RequestParam(required=false)
                                                    java.lang.String statuses,
                                                    @RequestParam(required=false,defaultValue="0")
                                                    int currentPage,
                                                    @RequestParam(required=false,defaultValue="20")
                                                    int pageSize,
                                                    @RequestParam(required=false)
                                                    java.lang.String sort)
        Web service for getting current user's order history data.
        Sample call: https://localhost:9002/rest/v1/mysite/orders?statuses=COMPLETED,CANCELLED&pageSize=5¤tPage=0
        This method requires authentication.
        Method type : GET.
        Method is restricted for HTTPS channel.
        Parameters:
        statuses - - filter for order statuses- optional
        currentPage - - pagination parameter- optional
        pageSize - - PaginationData parameter - optional
        sort - - sort criterion
        Returns:
        OrderData as response body.

      • expressUpdate

        @Secured("ROLE_TRUSTED_CLIENT")
@RequestMapping(value="/statusFeed",
                method=GET)
@ResponseBody
public OrderStatusUpdateElementDataList expressUpdate​(@RequestParam
                                                      java.lang.String timestamp,
                                                      @PathVariable
                                                      java.lang.String baseSiteId)
        Web service handler for order status update feed. Returns only elements from the current baseSite newer than specified timestamp. Sample Call: http://localhost:9001/rest/v1/{SITE}/orders/statusFeed
        This method requires trusted client authentication.
        Method type : GET.
        Method is restricted for HTTPS channel.
        Parameters:
        timestamp - - time in ISO-8601 format
        Returns:
        OrderStatusUpdateElementDataList

      • extractOrderStatuses

        protected java.util.Set<OrderStatus> extractOrderStatuses​(java.lang.String statuses)