de.hybris.platform.ycommercewebservices.v1.controller

Class OrderController

java.lang.Object

de.hybris.platform.ycommercewebservices.v1.controller.BaseController

de.hybris.platform.ycommercewebservices.v1.controller.OrderController

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.

Field Summary

Fields inherited from class de.hybris.platform.ycommercewebservices.v1.controller.BaseController

DEFAULT_CURRENT_PAGE, DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
OrderController()

Method Summary

Modifier and Type	Method and Description
protected OrderHistoriesData	createOrderHistoriesData(SearchPageData<OrderHistoryData> result)
OrderStatusUpdateElementDataList	expressUpdate(java.lang.String timestamp, java.lang.String baseSiteId) Web service handler for order status update feed.
protected java.util.Set<OrderStatus>	extractOrderStatuses(java.lang.String statuses)
protected void	filterOrderStatusQueue(OrderStatusUpdateElementDataList orderStatusUpdateDataList, java.lang.String baseSiteId)
OrderData	getOrder(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.
OrderData	getOrderByGuid(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.
OrderHistoriesData	getPagedOrdersForStatuses(java.lang.String statuses, int currentPage, int pageSize, 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.

Methods inherited from class de.hybris.platform.ycommercewebservices.v1.controller.BaseController

handleErrorInternal, handleModelNotFoundException, sanitize

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderController

public OrderController()

Method Detail

getOrder

public OrderData getOrder(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

public OrderData getOrderByGuid(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

public OrderHistoriesData getPagedOrdersForStatuses(java.lang.String statuses,
                                                    int currentPage,
                                                    int pageSize,
                                                    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

public OrderStatusUpdateElementDataList expressUpdate(java.lang.String timestamp,
                                                      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

filterOrderStatusQueue

protected void filterOrderStatusQueue(OrderStatusUpdateElementDataList orderStatusUpdateDataList,
                                      java.lang.String baseSiteId)

extractOrderStatuses

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

createOrderHistoriesData

protected OrderHistoriesData createOrderHistoriesData(SearchPageData<OrderHistoryData> result)