CartController (hybris Commerce Suite 18.11)

java.lang.Object
- de.hybris.platform.ycommercewebservices.v1.controller.BaseController
- - de.hybris.platform.ycommercewebservices.v1.controller.CartController

public class CartController
extends BaseController

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

CartController()

Constructors
Constructor and Description
`CartController()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CartData`	`addPaymentInfo(HttpServletRequest request)` Web service for creating a credit card payment subscription. Sample call: https://localhost:9002/rest/v1/mysite/cart/paymentinfo CCPaymentInfoData parameters need to be send as post body. Method uses dedicated populator - `HttpRequestPaymentInfoPopulator` - to populate the `CCPaymentInfoData` from request parameters. Method uses dedicated validator - `CCPaymentInfoValidator` - to validate request parameters. This method requires authentication and is restricted for `HTTPS` channel. Method type : `POST`.
`CartModificationData`	`addToCart(java.lang.String baseSiteId, java.lang.String code, long qty, java.lang.String storeName)` Web service handler for adding new products to the session cart. Sample target URL : http://localhost:9001/rest/v1/cart/entry. Client should provide product code and quantity (optional) as POST body. It's also possible to add product that will be pickedup in store by specifying optional storeName parameter (product must be in stock in that particular store). For Content-Type=application/x-www-form-urlencoded;charset=UTF-8 a sample body is: (urlencoded) is: entryNumber=1&qty=2.. Request Method = `POST Response contains a set-cookie header with the jsessionId associated with the cart.`
`CartData`	`applyPromotion(java.lang.String promotionCode)` Web service for enabling order promotions. Sample call: https://localhost:9002/rest/v1/mysite/cart/promotion/{promotionCode} This method requires authentication and is restricted to `HTTPS channel only. Method type : POST.`
`CartData`	`applyVoucherForCart(java.lang.String voucherCode)` Web service for applying voucher to cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/voucher/abc-9PSW-EDH2-RXKA This method requires authentication. Method type : `POST`. Method is restricted for `HTTPS` channel.
`CartData`	`authorizePayment(java.lang.String securityCode)` Web service for authorizing cart's credit cart payment. Sample call: https://localhost:9002/rest/v1/mysite/cart/authorizePayment authorization security code - ccv - must be sent as a post body. Response contains a set-cookie header with the jsessionId associated with the cart. This method requires authentication and is restricted to `HTTPS channel only. Method type : POST.`
`protected AddressData`	`createAddress(HttpServletRequest request)`
`CartModificationData`	`deleteCartEntry(long entryNumber)` Web service for deleting cart entry. Client should provide cart entry number as path variable. Sample target URL : http://localhost:9001/rest/v1/cart/entry/0 Response contains a set-cookie header with the jsessionId associated with the cart. Request Method = `DELETE`
`protected OrderEntryData`	`getCartEntryForNumber(long number)`
`CartData`	`getSessionCart()`
`CartData`	`getSessionCart(boolean restore)` Web service for getting session cart.
`DeliveryModesData`	`getSupportedDeliveryModes()` Web service for getting all supported delivery modes for the session cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/deliverymodes Response contains a set-cookie header with the jsessionId associated with the cart. This method requires authentication and is restricted to `HTTPS channel only. Method type : GET.`
`OrderData`	`oneStepCheckout(java.lang.String addressId, java.lang.String addressIsocode, java.lang.String deliveryMode, java.lang.String voucherCode, java.lang.String paymentInfoId, java.lang.String securityCode, HttpServletRequest request)` Web service for one-step checkout from current session cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/checkout This method requires authentication. Method type : `POST`. Method is restricted for `HTTPS` channel.
`CartModificationData`	`pickupEntryInStore(java.lang.String baseSiteId, long entryNumber, java.lang.String storeName)` Web service for setting store where cart entry will be picked up. Client should provide cart entry number as path variable and storeName parameter in body. Sample target URL : http://localhost:9001/rest/v1/cart/entry/{entryNumber}/store Response contains a set-cookie header with the jsessionId associated with the cart. Request Method = `PUT`
`OrderData`	`placeOrder(HttpSession session)` Web service for placing order from current session cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/placeorder.
`CartData`	`releaseVoucherFromCart(java.lang.String voucherCode)` Web service for removing voucher from cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/voucher/abc-9PSW-EDH2-RXKA This method requires authentication. Method type : `DELETE`. Method is restricted for `HTTPS` channel.
`CartData`	`removeDeliveryAddress()` Web service for removing delivery address from current cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/address/delivery Response contains a set-cookie header with the jsessionId associated with the cart. This method requires authentication. Method type : `DELETE`. Method is restricted for `HTTPS` channel.
`CartData`	`removeDeliveryMode()` Web service for removing delivery mode from current cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/deliverymode Response contains a set-cookie header with the jsessionId associated with the cart. This method requires authentication. Method type : `DELETE`. Method is restricted for `HTTPS` channel.
`CartData`	`removePromotion(java.lang.String promotionCode)` Web service for disabling order promotions. Sample call: https://localhost:9002/rest/v1/mysite/cart/promotion/{promotionCode} This method requires authentication and is restricted to `HTTPS channel only. Method type : DELETE.`
`CartRestorationData`	`restoreCart(java.lang.String guid)` Web service for restoring anonymous cart by guid. Sample call: https://localhost:9002/rest/v1/mysite/cart/restore This method requires authentication and is restricted to `HTTPS channel only. Method type : GET.`
`CartData`	`setCartDeliveryAddress(java.lang.String id)` Web service for setting cart's delivery address by address id. Address id must be given as path variable. Sample call: https://localhost:9002/rest/v1/mysite/cart/address/delivery/1234 Response contains a set-cookie header with the jsessionId associated with the cart. This method requires authentication. Method type : `PUT`. Method is restricted for `HTTPS` channel.
`CartData`	`setCartDeliveryMode(java.lang.String code)` Web service for setting cart's delivery mode by delivery mode code. Delivery mode code must be given as path variable. Sample call: https://localhost:9002/rest/v1/mysite/cart/deliverymode/expressDelivery Response contains a set-cookie header with the jsessionId associated with the cart. This method requires authentication. Method type : `PUT`. Method is restricted for `HTTPS` channel.
`CartData`	`setPaymentDetails(java.lang.String id)` Web service for assigning given payment (by payment id) to the checkout cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/paymentinfo/1234 This method requires authentication and is restricted for `HTTPS` channel. Method type : `PUT`.
`CartModificationData`	`updateCartEntry(long entryNumber, long qty)` Web service for modifying cart entry quantity. Client should provide cart entry number as path variable and new quantity as url request parameter. Sample target URL : http://localhost:9001/rest/v1/cart/entry/0?qty=2 Response contains a set-cookie header with the jsessionId associated with the cart. Request Method = `PUT`
`CartModificationData`	`updateEntryToDelivery(java.lang.String baseSiteId, long entryNumber)` Web service reseting store where entry should be picked up.
`protected void`	`validateCartForPlaceOrder()`

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
  - CartController
```
public CartController()
```
- Method Detail
  - getSessionCart
```
public CartData getSessionCart()
```
  - getSessionCart
```
public CartData getSessionCart(boolean restore)
```
    Web service for getting session cart. If there is no cart in the current session it will be restored if possible, otherwise new one will be created.
    Sample call: http://localhost:9001/rest/v1/mysite/cart/
    Response contains a set-cookie header with the jsessionId associated with the cart.
    
    Parameters:
    
    restore - enables cart restoration (true by default)
    
    Returns:
    
    CartData as response body.
  - addToCart
```
public CartModificationData addToCart(java.lang.String baseSiteId,
                                      java.lang.String code,
                                      long qty,
                                      java.lang.String storeName)
                               throws CommerceCartModificationException,
                                      WebserviceValidationException,
                                      ProductLowStockException,
                                      StockSystemException
```
    Web service handler for adding new products to the session cart.
    Sample target URL : http://localhost:9001/rest/v1/cart/entry.
    Client should provide product code and quantity (optional) as POST body.
    It's also possible to add product that will be pickedup in store by specifying optional storeName parameter (product must be in stock in that particular store).
    For Content-Type=application/x-www-form-urlencoded;charset=UTF-8 a sample body is: (urlencoded) is: entryNumber=1&qty=2..
    Request Method = POST Response contains a set-cookie header with the jsessionId associated with the cart.
    Parameters: code - qty - storeName - Returns: CartModificationData as response body. Throws: CommerceCartModificationException WebserviceValidationException StockSystemException ProductLowStockException
  updateCartEntry public CartModificationData updateCartEntry(long entryNumber, long qty) throws CommerceCartModificationException Web service for modifying cart entry quantity. Client should provide cart entry number as path variable and new quantity as url request parameter. Sample target URL : http://localhost:9001/rest/v1/cart/entry/0?qty=2 Response contains a set-cookie header with the jsessionId associated with the cart. Request Method = PUT Parameters: entryNumber - qty - Returns: CartModificationData as response body. Throws: CommerceCartModificationException deleteCartEntry public CartModificationData deleteCartEntry(long entryNumber) throws CommerceCartModificationException Web service for deleting cart entry. Client should provide cart entry number as path variable. Sample target URL : http://localhost:9001/rest/v1/cart/entry/0 Response contains a set-cookie header with the jsessionId associated with the cart. Request Method = DELETE Parameters: entryNumber - Returns: CartModificationData as response body. Throws: CommerceCartModificationException pickupEntryInStore public CartModificationData pickupEntryInStore(java.lang.String baseSiteId, long entryNumber, java.lang.String storeName) throws CommerceCartModificationException, LowStockException, StockSystemException, WebserviceValidationException Web service for setting store where cart entry will be picked up. Client should provide cart entry number as path variable and storeName parameter in body. Sample target URL : http://localhost:9001/rest/v1/cart/entry/{entryNumber}/store Response contains a set-cookie header with the jsessionId associated with the cart. Request Method = PUT Parameters: entryNumber - identifier of entry which should be updated storeName - name of store where items will be picked Returns: CartModificationData as response body. Throws: CommerceCartModificationException WebserviceValidationException StockSystemException LowStockException updateEntryToDelivery public CartModificationData updateEntryToDelivery(java.lang.String baseSiteId, long entryNumber) throws CommerceCartModificationException, LowStockException, StockSystemException Web service reseting store where entry should be picked up. Entry will be delivered by selected delivery method Client should provide cart entry number as path variable. Sample target URL : http://localhost:9001/rest/v1/cart/entry/{entryNumber}/store Request Method = DELETE Parameters: entryNumber - identifier of entry which should be updated Returns: CartModificationData as response body. Throws: CommerceCartModificationException StockSystemException LowStockException setCartDeliveryAddress public CartData setCartDeliveryAddress(java.lang.String id) throws UnsupportedDeliveryAddressException, NoCheckoutCartException Web service for setting cart's delivery address by address id. Address id must be given as path variable. Sample call: https://localhost:9002/rest/v1/mysite/cart/address/delivery/1234 Response contains a set-cookie header with the jsessionId associated with the cart. This method requires authentication. Method type : PUT. Method is restricted for HTTPS channel. Returns: true if carts delivery address was changed. Throws: UnsupportedDeliveryAddressException NoCheckoutCartException removeDeliveryAddress public CartData removeDeliveryAddress() Web service for removing delivery address from current cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/address/delivery Response contains a set-cookie header with the jsessionId associated with the cart. This method requires authentication. Method type : DELETE. Method is restricted for HTTPS channel. Returns: true if carts delivery address was removed. setCartDeliveryMode public CartData setCartDeliveryMode(java.lang.String code) throws UnsupportedDeliveryModeException Web service for setting cart's delivery mode by delivery mode code. Delivery mode code must be given as path variable. Sample call: https://localhost:9002/rest/v1/mysite/cart/deliverymode/expressDelivery Response contains a set-cookie header with the jsessionId associated with the cart. This method requires authentication. Method type : PUT. Method is restricted for HTTPS channel. Returns: true if carts delivery mode was changed. Throws: UnsupportedDeliveryModeException removeDeliveryMode public CartData removeDeliveryMode() Web service for removing delivery mode from current cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/deliverymode Response contains a set-cookie header with the jsessionId associated with the cart. This method requires authentication. Method type : DELETE. Method is restricted for HTTPS channel. Returns: true if cart's delivery mode was removed. placeOrder public OrderData placeOrder(HttpSession session) throws InvalidCartException, NoCheckoutCartException, WebserviceValidationException Web service for placing order from current session cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/placeorder. This method requires authentication. Method type : POST. Method is restricted for HTTPS channel. Returns: OrderData as response body Throws: InvalidCartException NoCheckoutCartException WebserviceValidationException validateCartForPlaceOrder protected void validateCartForPlaceOrder() throws NoCheckoutCartException, InvalidCartException, WebserviceValidationException Throws: NoCheckoutCartException InvalidCartException WebserviceValidationException addPaymentInfo public CartData addPaymentInfo(HttpServletRequest request) throws WebserviceValidationException, InvalidPaymentInfoException, NoCheckoutCartException Web service for creating a credit card payment subscription. Sample call: https://localhost:9002/rest/v1/mysite/cart/paymentinfo CCPaymentInfoData parameters need to be send as post body. Method uses dedicated populator - HttpRequestPaymentInfoPopulator - to populate the CCPaymentInfoData from request parameters. Method uses dedicated validator - CCPaymentInfoValidator - to validate request parameters. This method requires authentication and is restricted for HTTPS channel. Method type : POST. Parameters: request - incoming HttpServletRequest. As there are many potential query parameters to handle they are not mapped using annotations. Returns: CartData as response body Throws: WebserviceValidationException InvalidPaymentInfoException NoCheckoutCartException setPaymentDetails public CartData setPaymentDetails(java.lang.String id) throws InvalidPaymentInfoException Web service for assigning given payment (by payment id) to the checkout cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/paymentinfo/1234 This method requires authentication and is restricted for HTTPS channel. Method type : PUT. Returns: true if paymentInfo was assigned to the session cart. Throws: InvalidPaymentInfoException getSupportedDeliveryModes public DeliveryModesData getSupportedDeliveryModes() Web service for getting all supported delivery modes for the session cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/deliverymodes Response contains a set-cookie header with the jsessionId associated with the cart. This method requires authentication and is restricted to HTTPS channel only. Method type : GET. Returns: List of DeliveryModeData as response body. authorizePayment public CartData authorizePayment(java.lang.String securityCode) throws PaymentAuthorizationException Web service for authorizing cart's credit cart payment. Sample call: https://localhost:9002/rest/v1/mysite/cart/authorizePayment authorization security code - ccv - must be sent as a post body. Response contains a set-cookie header with the jsessionId associated with the cart. This method requires authentication and is restricted to HTTPS channel only. Method type : POST. Returns: true if the payment was authorized Throws: PaymentAuthorizationException restoreCart public CartRestorationData restoreCart(java.lang.String guid) throws CommerceCartRestorationException Web service for restoring anonymous cart by guid. Sample call: https://localhost:9002/rest/v1/mysite/cart/restore This method requires authentication and is restricted to HTTPS channel only. Method type : GET. Parameters: guid - Returns: CartRestorationData Throws: CommerceCartRestorationException applyPromotion public CartData applyPromotion(java.lang.String promotionCode) throws CommercePromotionRestrictionException Web service for enabling order promotions. Sample call: https://localhost:9002/rest/v1/mysite/cart/promotion/{promotionCode} This method requires authentication and is restricted to HTTPS channel only. Method type : POST. Parameters: promotionCode - promotion code Returns: CartData Throws: CommercePromotionRestrictionException removePromotion public CartData removePromotion(java.lang.String promotionCode) throws CommercePromotionRestrictionException, NoCheckoutCartException Web service for disabling order promotions. Sample call: https://localhost:9002/rest/v1/mysite/cart/promotion/{promotionCode} This method requires authentication and is restricted to HTTPS channel only. Method type : DELETE. Parameters: promotionCode - promotion code Returns: CartData Throws: CommercePromotionRestrictionException NoCheckoutCartException applyVoucherForCart public CartData applyVoucherForCart(java.lang.String voucherCode) throws NoCheckoutCartException, VoucherOperationException Web service for applying voucher to cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/voucher/abc-9PSW-EDH2-RXKA This method requires authentication. Method type : POST. Method is restricted for HTTPS channel. Returns: cart data with applied voucher. Throws: NoCheckoutCartException VoucherOperationException releaseVoucherFromCart public CartData releaseVoucherFromCart(java.lang.String voucherCode) throws NoCheckoutCartException, VoucherOperationException Web service for removing voucher from cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/voucher/abc-9PSW-EDH2-RXKA This method requires authentication. Method type : DELETE. Method is restricted for HTTPS channel. Returns: updated cart data. Throws: NoCheckoutCartException VoucherOperationException oneStepCheckout public OrderData oneStepCheckout(java.lang.String addressId, java.lang.String addressIsocode, java.lang.String deliveryMode, java.lang.String voucherCode, java.lang.String paymentInfoId, java.lang.String securityCode, HttpServletRequest request) throws NoCheckoutCartException, UnsupportedDeliveryAddressException, UnsupportedDeliveryModeException, InvalidPaymentInfoException, PaymentAuthorizationException, InvalidCartException, WebserviceValidationException, VoucherOperationException Web service for one-step checkout from current session cart. Sample call: https://localhost:9002/rest/v1/mysite/cart/checkout This method requires authentication. Method type : POST. Method is restricted for HTTPS channel. Parameters: addressId - id of created address addressIsocode - country isocode, parameter is also used as a flag to decide if new address should be created deliveryMode - delivery mode voucherCode - voucher code paymentInfoId - id of created payment info securityCode - security code for payment validation request - incoming HttpServletRequest. As there are many potential query parameters to handle they are not mapped using annotations. Returns: OrderData Throws: NoCheckoutCartException UnsupportedDeliveryAddressException UnsupportedDeliveryModeException InvalidPaymentInfoException PaymentAuthorizationException InvalidCartException WebserviceValidationException VoucherOperationException getCartEntryForNumber protected OrderEntryData getCartEntryForNumber(long number) createAddress protected AddressData createAddress(HttpServletRequest request)

Class CartController

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

CartController

Method Detail

getSessionCart

getSessionCart

addToCart

updateCartEntry

deleteCartEntry

pickupEntryInStore

updateEntryToDelivery

setCartDeliveryAddress

removeDeliveryAddress

setCartDeliveryMode

removeDeliveryMode

placeOrder

validateCartForPlaceOrder

addPaymentInfo

setPaymentDetails

getSupportedDeliveryModes

authorizePayment

restoreCart

applyPromotion

removePromotion

applyVoucherForCart

releaseVoucherFromCart

oneStepCheckout

getCartEntryForNumber

createAddress