CartHandler

java.lang.Object
- AbstractClassicResourceHandler
- - com.ibm.commerce.rest.classic.core.AbstractConfigBasedClassicHandler
  - - com.ibm.commerce.rest.order.handler.CartHandler

```
@Encoded
public class CartHandler
extends AbstractConfigBasedClassicHandler
```
This class provides RESTful services to add, update, delete, and get items in the shopping cart and checkout. It provides services to get usable shipping and payment information by calling the Order noun to perform the services.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CART_CHANGE_MAPPING_KEY` The Constant CART_MAPPING_KEY.
`static java.lang.String`	`CART_MAPPING_KEY` The Constant CART_MAPPING_KEY.
`static java.lang.String`	`COPYRIGHT` IBM Copyright notice field.
`static java.lang.String`	`FORMAT_GROUP_NAME` The constant FORMAT_GROUP_NAME
`static java.lang.String`	`RESOURCE_NAME` Resource name for cart.
`static java.lang.String`	`USABLE_PAYMENT_INFO_MAPPING_KEY` Mapping key for usable payment info.
`static java.lang.String`	`USABLE_SHIPPING_INFO_MAPPING_KEY` Mapping key for usable shipping info.

Constructor Summary

Constructors
Constructor and Description

CartHandler()

Constructors
Constructor and Description
`CartHandler()`

Method Summary

Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`addConfigurationToCart(java.lang.String storeId, java.lang.String responseFormat)` Adds a configuration of a dynamic kit to the cart.
`javax.ws.rs.core.Response`	`addOrderItem(java.lang.String storeId, java.lang.String responseFormat)` This method adds one or multiple items to the shopping cart.
`javax.ws.rs.core.Response`	`addPreConfigurationToCart(java.lang.String storeId, java.lang.String responseFormat)` Adds a pre-configuration of a dynamic kit to the cart.
`javax.ws.rs.core.Response`	`applyCheckoutProfile(java.lang.String storeId, java.lang.String responseFormat)` Apply quick checkout profile to current shopping cart.
`javax.ws.rs.core.Response`	`calculateOrder(java.lang.String storeId, java.lang.String responseFormat)` This method calculates the cost of the order
`javax.ws.rs.core.Response`	`calculateOrder(java.lang.String storeId, java.lang.String orderId, java.lang.String responseFormat)` This method calculates the cost of the order
`javax.ws.rs.core.Response`	`cancelOrder(java.lang.String storeId, java.lang.String orderId, java.lang.String responseFormat, java.lang.String forcedCancel)` This method cancels the order specified
`javax.ws.rs.core.Response`	`cancelOrderInCart(java.lang.String storeId, java.lang.String responseFormat)` Delete all items in the shopping cart.
`javax.ws.rs.core.Response`	`checkOut(java.lang.String storeId, java.lang.String responseFormat)` This method submits the shopping cart for checkout.
`javax.ws.rs.core.Response`	`copyOrder(java.lang.String storeId, java.lang.String responseFormat)` This method copies a specified order
`javax.ws.rs.core.Response`	`createOrder(java.lang.String storeId, java.lang.String responseFormat, java.lang.String description)` This method creates a order using a description that is provided
`javax.ws.rs.core.Response`	`deleteOrderItem(java.lang.String storeId, java.lang.String responseFormat)` This method deletes the specified order item from the order.
`javax.ws.rs.core.Response`	`getAllowableShippingModes(java.lang.String storeId, java.lang.String langId, java.lang.String responseFormat)` Deprecated. Adding query parameter "locale"
`javax.ws.rs.core.Response`	`getAllowableShippingModes(java.lang.String storeId, java.lang.String locale, java.lang.String langId, java.lang.String responseFormat)` Get allowable shipping information for the store
`javax.ws.rs.core.Response`	`getBuyerPurchaseOrderDataBean(java.lang.String storeId, java.lang.String buyerPurchaseOrderId, java.lang.String responseFormat, java.lang.String profileName)` Gets buyer purchase order information for order id.
`javax.ws.rs.core.Response`	`getCart(java.lang.String storeId, java.lang.String responseFormat, int pageNumber, int pageSize)` This method gets order details in the shopping cart.
`java.lang.String`	`getFormattingGroupName()` This method returns the format group name to locate JSP template.
`OrderHelper`	`getHelper()` This method returns the Cart helper used to cart contents.
`javax.ws.rs.core.Response`	`getPAttributeDataBean(java.lang.String storeId, java.lang.String initKey_referenceNumber, java.lang.String responseFormat, java.lang.String profileName)` Gets payment attribute order information for terms & conditions Id.
`javax.ws.rs.core.Response`	`getPaymentPolicyListDataBean(java.lang.String storeId, java.lang.String responseFormat, java.lang.String profileName)` Gets payment policy list information for store.
`java.lang.String`	`getResourceName()`
`javax.ws.rs.core.Response`	`getUsableBillingAddressListTCDataBean(java.lang.String storeId, java.lang.String orderId, java.lang.String responseFormat, java.lang.String profileName, java.lang.String paymentTCId)` Gets usable billing address information for order id.
`javax.ws.rs.core.Response`	`getUsablePaymentInfo(java.lang.String storeId, java.lang.String responseFormat, int pageNumber, int pageSize)` Get usable payment information for the cart.
`javax.ws.rs.core.Response`	`getUsableShipChargesByShipMode(java.lang.String storeId, java.lang.String orderId, java.lang.String responseFormat, java.lang.String profileName)` Gets usable ship charge information for order id.
`javax.ws.rs.core.Response`	`getUsableShippingInfo(java.lang.String storeId, java.lang.String responseFormat, int pageNumber, int pageSize)` Get usable shipping information for the cart.
`javax.ws.rs.core.Response`	`lockCart(java.lang.String storeId, java.lang.String cartId, java.lang.String responseFormat)` This method locks the cart specified by CSR.
`javax.ws.rs.core.Response`	`lockCartOnBehalf(java.lang.String storeId, java.lang.String cartId, java.lang.String responseFormat)` This method locks the cart specified when the buyer administrator/CSR has established a session to act on behalf of a user.
`javax.ws.rs.core.Response`	`moveOrderItem(java.lang.String storeId, java.lang.String responseFormat)` Moves order items from one order to another.
`void`	`postProcess(java.util.Map<java.lang.String,java.lang.Object> responseMap)` Method to provide post process in out of box JSON/XML entity providers after each DataObject has been converted to a Map and before constructing the REST response.
`javax.ws.rs.core.Response`	`preCheckout(java.lang.String storeId, java.lang.String responseFormat)` This method prepares the shopping cart for checkout.
`javax.ws.rs.core.Response`	`scheduleOrder(java.lang.String storeId, java.lang.String responseFormat)` Creates a scheduled order which is related to a scheduled job.
`javax.ws.rs.core.Response`	`setPendingOrder(java.lang.String storeId, java.lang.String orderId, java.lang.String responseFormat)` This method sets the order specified to be current working order
`javax.ws.rs.core.Response`	`udpateOrderItem(java.lang.String storeId, java.lang.String responseFormat)` Deprecated. Replaced by `updateOrderItem(String, String)`
`javax.ws.rs.core.Response`	`unlockCart(java.lang.String storeId, java.lang.String cartId, java.lang.String responseFormat)` This method unlocks the cart specified by CSR.
`javax.ws.rs.core.Response`	`unlockCartOnBehalf(java.lang.String storeId, java.lang.String cartId, java.lang.String responseFormat)` This method unlocks the cart specified when the buyer administrator/CSR has established a session to act on behalf of a user.
`javax.ws.rs.core.Response`	`updateConfigurationInCart(java.lang.String storeId, java.lang.String responseFormat)` Update a dynamic kit configuration in the cart.
`javax.ws.rs.core.Response`	`updateOrderItem(java.lang.String storeId, java.lang.String responseFormat)` This method update existing item(s) in the shopping cart.
`javax.ws.rs.core.Response`	`updateRewardOption(java.lang.String storeId, java.lang.String responseFormat)` Updates the reward choice selection.

Methods inherited from class com.ibm.commerce.rest.classic.core.AbstractConfigBasedClassicHandler
composeResponseFromMappingProfile, createControllerCommand, execute, executeConfigBasedBean, executeConfigBasedBeanWithContext, executeConfigBasedCommand, executeConfigBasedCommandWithContext, loadBeanClass, loadControllerCommandClass

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM Copyright notice field.
    
    See Also:
    
    Constant Field Values
  - RESOURCE_NAME
```
public static final java.lang.String RESOURCE_NAME
```
    Resource name for cart.
    
    See Also:
    
    Constant Field Values
  - CART_MAPPING_KEY
```
public static final java.lang.String CART_MAPPING_KEY
```
    The Constant CART_MAPPING_KEY.
    
    See Also:
    
    Constant Field Values
  - CART_CHANGE_MAPPING_KEY
```
public static final java.lang.String CART_CHANGE_MAPPING_KEY
```
    The Constant CART_MAPPING_KEY.
    
    See Also:
    
    Constant Field Values
  - USABLE_SHIPPING_INFO_MAPPING_KEY
```
public static final java.lang.String USABLE_SHIPPING_INFO_MAPPING_KEY
```
    Mapping key for usable shipping info.
    
    See Also:
    
    Constant Field Values
  - USABLE_PAYMENT_INFO_MAPPING_KEY
```
public static final java.lang.String USABLE_PAYMENT_INFO_MAPPING_KEY
```
    Mapping key for usable payment info.
    
    See Also:
    
    Constant Field Values
  - FORMAT_GROUP_NAME
```
public static final java.lang.String FORMAT_GROUP_NAME
```
    The constant FORMAT_GROUP_NAME
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CartHandler
```
public CartHandler()
```
- Method Detail
  - getResourceName
```
public java.lang.String getResourceName()
```
  - getFormattingGroupName
```
public java.lang.String getFormattingGroupName()
```
    This method returns the format group name to locate JSP template.
    
    Returns:
    
    formatting group name
  - getHelper
```
public OrderHelper getHelper()
```
    This method returns the Cart helper used to cart contents.
    
    Returns:
    
    the helper
  - getCart
```
public javax.ws.rs.core.Response getCart(java.lang.String storeId,
                                java.lang.String responseFormat,
                                int pageNumber,
                                int pageSize)
```
    This method gets order details in the shopping cart.
    
    Parameters:
    
    storeId - the store Id of the request.
    
    responseFormat - the response format (xml or json).
    
    pageNumber - the page number
    
    pageSize - the page size
    
    Returns:
    
    a collection of Order nouns in the specified format.
  - scheduleOrder
```
public javax.ws.rs.core.Response scheduleOrder(java.lang.String storeId,
                                      java.lang.String responseFormat)
```
    Creates a scheduled order which is related to a scheduled job.
    
    Parameters:
    
    storeId - The store identifier
    
    responseFormat - The response format
    
    Returns:
    
    The response object containing the order identifier.
  - setPendingOrder
```
public javax.ws.rs.core.Response setPendingOrder(java.lang.String storeId,
                                        java.lang.String orderId,
                                        java.lang.String responseFormat)
                                          throws java.lang.Exception
```
    This method sets the order specified to be current working order
    
    Parameters:
    
    storeId - The store ID
    
    orderId - The order Id
    
    responseFormat - The resonseFormat
    
    Returns:
    
    The response
    
    Throws:
    
    java.lang.Exception
  - cancelOrder
```
public javax.ws.rs.core.Response cancelOrder(java.lang.String storeId,
                                    java.lang.String orderId,
                                    java.lang.String responseFormat,
                                    java.lang.String forcedCancel)
                                      throws java.lang.Exception
```
    This method cancels the order specified
    
    Parameters:
    
    storeId - The store ID
    
    orderId - The order Id
    
    responseFormat - The response format
    
    forcedCancel - This parameter is used by payment rule to perform a refund. If there are some deposit transactions for the order, the order cannot be canceled except when the parameter is made forcedCancel=true. The default value is false.
    
    Returns:
    
    The response
    
    Throws:
    
    java.lang.Exception
  - createOrder
```
public javax.ws.rs.core.Response createOrder(java.lang.String storeId,
                                    java.lang.String responseFormat,
                                    java.lang.String description)
                                      throws java.lang.Exception
```
    This method creates a order using a description that is provided
    
    Parameters:
    
    storeId - The store ID
    
    responseFormat - The response format
    
    description - The description
    
    Returns:
    
    The response contains the orderId for the order created
    
    Throws:
    
    java.lang.Exception
  - copyOrder
```
public javax.ws.rs.core.Response copyOrder(java.lang.String storeId,
                                  java.lang.String responseFormat)
```
    This method copies a specified order
    
    Parameters:
    
    storeId - The store ID
    
    responseFormat - The response format
    
    Returns:
    
    The response
  - deleteOrderItem
```
public javax.ws.rs.core.Response deleteOrderItem(java.lang.String storeId,
                                        java.lang.String responseFormat)
```
    This method deletes the specified order item from the order.
    
    Parameters:
    
    storeId - The store identifier.
    
    responseFormat - The response format.
    
    Returns:
    
    The response.
  - calculateOrder
```
public javax.ws.rs.core.Response calculateOrder(java.lang.String storeId,
                                       java.lang.String responseFormat)
```
    This method calculates the cost of the order
    
    Parameters:
    
    storeId - The store identifier
    
    responseFormat - The response format
    
    Returns:
    
    The response
  - calculateOrder
```
public javax.ws.rs.core.Response calculateOrder(java.lang.String storeId,
                                       java.lang.String orderId,
                                       java.lang.String responseFormat)
```
    This method calculates the cost of the order
    
    Parameters:
    
    storeId - The store identifier
    
    orderId - The order identifier or abbreviation
    
    responseFormat - The response format
    
    Returns:
    
    The response
  - getUsableShippingInfo
```
public javax.ws.rs.core.Response getUsableShippingInfo(java.lang.String storeId,
                                              java.lang.String responseFormat,
                                              int pageNumber,
                                              int pageSize)
```
    Get usable shipping information for the cart. If order id is specified, use the specified order id, otherwise find the order it through shopping cart.
    
    Parameters:
    
    storeId - the store id
    
    responseFormat - the response format
    
    pageNumber - the page number
    
    pageSize - the page size
    
    Returns:
    
    the usable shipping info
  - getUsableShipChargesByShipMode
```
public javax.ws.rs.core.Response getUsableShipChargesByShipMode(java.lang.String storeId,
                                                       java.lang.String orderId,
                                                       java.lang.String responseFormat,
                                                       java.lang.String profileName)
                                                         throws RestException
```
    Gets usable ship charge information for order id.
    
    Parameters:
    
    storeId - the store id
    
    orderId - the order id
    
    responseFormat - the format of the response
    
    profileName - the profile name
    
    Returns:
    
    the usable ship charge information
    
    Throws:
    
    RestException
  - getBuyerPurchaseOrderDataBean
```
public javax.ws.rs.core.Response getBuyerPurchaseOrderDataBean(java.lang.String storeId,
                                                      java.lang.String buyerPurchaseOrderId,
                                                      java.lang.String responseFormat,
                                                      java.lang.String profileName)
                                                        throws RestException
```
    Gets buyer purchase order information for order id.
    
    Parameters:
    
    storeId - the store id
    
    buyerPurchaseOrderId - the buyer purchase order id
    
    responseFormat - the format of the response
    
    profileName - the profile name
    
    Returns:
    
    the buyer purchase order information
    
    Throws:
    
    RestException
  - getUsableBillingAddressListTCDataBean
```
public javax.ws.rs.core.Response getUsableBillingAddressListTCDataBean(java.lang.String storeId,
                                                              java.lang.String orderId,
                                                              java.lang.String responseFormat,
                                                              java.lang.String profileName,
                                                              java.lang.String paymentTCId)
                                                                throws RestException
```
    Gets usable billing address information for order id.
    
    Parameters:
    
    storeId - The store identifier
    
    orderId - The purchase order id
    
    responseFormat - The response format
    
    profileName - The profile name
    
    paymentTCId - The payment terms and condition ID
    
    Returns:
    
    the billing address order information
    
    Throws:
    
    RestException
  - getPAttributeDataBean
```
public javax.ws.rs.core.Response getPAttributeDataBean(java.lang.String storeId,
                                              java.lang.String initKey_referenceNumber,
                                              java.lang.String responseFormat,
                                              java.lang.String profileName)
                                                throws RestException
```
    Gets payment attribute order information for terms & conditions Id.
    
    Parameters:
    
    storeId - the store id
    
    initKey_referenceNumber - the attribute Id of the payment terms & conditions
    
    responseFormat - the format of the response
    
    profileName - the profile name
    
    Returns:
    
    the payment attribute order information
    
    Throws:
    
    RestException
  - getPaymentPolicyListDataBean
```
public javax.ws.rs.core.Response getPaymentPolicyListDataBean(java.lang.String storeId,
                                                     java.lang.String responseFormat,
                                                     java.lang.String profileName)
                                                       throws RestException
```
    Gets payment policy list information for store.
    
    Parameters:
    
    storeId - the store id
    
    responseFormat - the format of the response
    
    profileName - the profile name
    
    Returns:
    
    the payment policy list information
    
    Throws:
    
    RestException
  - applyCheckoutProfile
```
public javax.ws.rs.core.Response applyCheckoutProfile(java.lang.String storeId,
                                             java.lang.String responseFormat)
```
    Apply quick checkout profile to current shopping cart.
    
    Parameters:
    
    storeId - the store id
    
    responseFormat - the response format
    
    Returns:
    
    Response
  - getUsablePaymentInfo
```
public javax.ws.rs.core.Response getUsablePaymentInfo(java.lang.String storeId,
                                             java.lang.String responseFormat,
                                             int pageNumber,
                                             int pageSize)
```
    Get usable payment information for the cart. If order id is specified, use the specified order id, otherwise find the order it through shopping cart.
    
    Parameters:
    
    storeId - the store id
    
    responseFormat - the response format
    
    pageNumber - the page number
    
    pageSize - the page size
    
    Returns:
    
    the usable payment info
  - addOrderItem
```
public javax.ws.rs.core.Response addOrderItem(java.lang.String storeId,
                                     java.lang.String responseFormat)
```
    This method adds one or multiple items to the shopping cart.
    
    Parameters:
    
    storeId - the store Id
    
    responseFormat - the response format (xml, json, or atom)
    
    Returns:
    
    the Order noun in the specified format
  - udpateOrderItem
```
@Deprecated
public javax.ws.rs.core.Response udpateOrderItem(java.lang.String storeId,
                                                   java.lang.String responseFormat)
```
    Deprecated. Replaced by updateOrderItem(String, String)
    
    This method update existing item(s)in the shopping cart.
    
    Parameters:
    
    storeId - The store ID.
    
    responseFormat - The response format (XML, JSON, or Atom).
    
    Returns:
    
    Order map in the specified format.
  - updateOrderItem
```
public javax.ws.rs.core.Response updateOrderItem(java.lang.String storeId,
                                        java.lang.String responseFormat)
```
    This method update existing item(s) in the shopping cart.
    
    Parameters:
    
    storeId - The store identifier.
    
    responseFormat - The response format (XML, JSON, or Atom).
    
    Returns:
    
    Order map in the specified format.
  - addConfigurationToCart
```
public javax.ws.rs.core.Response addConfigurationToCart(java.lang.String storeId,
                                               java.lang.String responseFormat)
```
    Adds a configuration of a dynamic kit to the cart.
    
    Parameters:
    
    storeId - The store identifier.
    
    responseFormat - The response format.
    
    Returns:
    
    A map of string [] with the order ID and order item ID.
  - addPreConfigurationToCart
```
public javax.ws.rs.core.Response addPreConfigurationToCart(java.lang.String storeId,
                                                  java.lang.String responseFormat)
```
    Adds a pre-configuration of a dynamic kit to the cart.
    
    Parameters:
    
    storeId - The store identifier.
    
    responseFormat - The response format.
    
    Returns:
    
    A map of string [] with the order ID and order item ID.
  - updateConfigurationInCart
```
public javax.ws.rs.core.Response updateConfigurationInCart(java.lang.String storeId,
                                                  java.lang.String responseFormat)
```
    Update a dynamic kit configuration in the cart.
    
    Parameters:
    
    storeId - The store identifier.
    
    responseFormat - The response format.
    
    Returns:
    
    The response
  - updateRewardOption
```
public javax.ws.rs.core.Response updateRewardOption(java.lang.String storeId,
                                           java.lang.String responseFormat)
```
    Updates the reward choice selection.
    
    Parameters:
    
    storeId - The store identifier.
    
    responseFormat - The response format
    
    Returns:
    
    A map of String array containing the order ID.
  - cancelOrderInCart
```
public javax.ws.rs.core.Response cancelOrderInCart(java.lang.String storeId,
                                          java.lang.String responseFormat)
```
    Delete all items in the shopping cart.
    
    Parameters:
    
    storeId - the store Id.
    
    responseFormat - the response format (xml, json, or atom).
    
    Returns:
    
    The Cart noun in the specified format.
  - moveOrderItem
```
public javax.ws.rs.core.Response moveOrderItem(java.lang.String storeId,
                                      java.lang.String responseFormat)
```
    Moves order items from one order to another.
    
    Parameters:
    
    storeId - The store identifier.
    
    responseFormat - The response format.
    
    Returns:
    
    The response
  - preCheckout
```
public javax.ws.rs.core.Response preCheckout(java.lang.String storeId,
                                    java.lang.String responseFormat)
```
    This method prepares the shopping cart for checkout. It calculates charges, performs inventory actions, and locks the price of the order to indicate that the order can be submitted. If successful, it returns current orderId that's in the shopper's cart.
    It must be called before invoking shipping cart/@self/checkout service.
    
    Parameters:
    
    storeId - store id
    
    responseFormat - response format
    
    Returns:
    
    Response
  - checkOut
```
public javax.ws.rs.core.Response checkOut(java.lang.String storeId,
                                 java.lang.String responseFormat)
```
    This method submits the shopping cart for checkout. Input data may be empty. You must first add payment instruction via URL store/{storeId}/cart/@self/payment_instruction or provide payment instruction with this method. If successful, it returns current orderId that's in the shopper's cart.
    
    Parameters:
    
    storeId - the store Id.
    
    responseFormat - the response format (xml, json, or atom).
    
    Returns:
    
    A map of String [] that contains the following response parameters: orderId, resourceId, resourceType
  - lockCart
```
public javax.ws.rs.core.Response lockCart(java.lang.String storeId,
                                 java.lang.String cartId,
                                 java.lang.String responseFormat)
```
    This method locks the cart specified by CSR.
    
    Parameters:
    
    storeId - the store Id.
    
    cartId - the cart Id.
    
    responseFormat - the response format (xml, json, or atom).
    
    Returns:
    
    A map of String [] that contains the following response parameters: cartId, resourceId, resourceType
  - lockCartOnBehalf
```
public javax.ws.rs.core.Response lockCartOnBehalf(java.lang.String storeId,
                                         java.lang.String cartId,
                                         java.lang.String responseFormat)
```
    This method locks the cart specified when the buyer administrator/CSR has established a session to act on behalf of a user.
    
    Parameters:
    
    storeId - the store Id.
    
    cartId - the cart Id.
    
    responseFormat - the response format (xml, json, or atom).
    
    Returns:
    
    A map of String [] that contains the following response parameters: cartId, resourceId, resourceType
  - unlockCart
```
public javax.ws.rs.core.Response unlockCart(java.lang.String storeId,
                                   java.lang.String cartId,
                                   java.lang.String responseFormat)
```
    This method unlocks the cart specified by CSR.
    
    Parameters:
    
    storeId - the store Id.
    
    cartId - the cart Id.
    
    responseFormat - the response format (xml, json, or atom).
    
    Returns:
    
    A map of String [] that contains the following response parameters: cartId, resourceId, resourceType
  - unlockCartOnBehalf
```
public javax.ws.rs.core.Response unlockCartOnBehalf(java.lang.String storeId,
                                           java.lang.String cartId,
                                           java.lang.String responseFormat)
```
    This method unlocks the cart specified when the buyer administrator/CSR has established a session to act on behalf of a user.
    
    Parameters:
    
    storeId - the store Id.
    
    cartId - the cart Id.
    
    responseFormat - the response format (xml, json, or atom).
    
    Returns:
    
    A map of String [] that contains the following response parameters: cartId, resourceId, resourceType
  - postProcess
```
public void postProcess(java.util.Map<java.lang.String,java.lang.Object> responseMap)
```
    Method to provide post process in out of box JSON/XML entity providers after each DataObject has been converted to a Map and before constructing the REST response. By default, it does nothing. Overwrite this method in your resource handler class to perform any post process, for example, merge maps from multiple DataObjects into a single Map.
    
    Parameters:
    
    responseMap - The response Map after each DataObject has been converted to a Map.
  - getAllowableShippingModes
```
@Deprecated
public javax.ws.rs.core.Response getAllowableShippingModes(java.lang.String storeId,
                                                             java.lang.String langId,
                                                             java.lang.String responseFormat)
```
    Deprecated. Adding query parameter "locale"
    
    Get allowable shipping information for the store
    
    Parameters:
    
    storeId - the store id
    
    langId - the langId
    
    responseFormat - the response format
    
    Returns:
    
    the allowable shipping modes
  - getAllowableShippingModes
```
public javax.ws.rs.core.Response getAllowableShippingModes(java.lang.String storeId,
                                                  java.lang.String locale,
                                                  java.lang.String langId,
                                                  java.lang.String responseFormat)
```
    Get allowable shipping information for the store
    
    Parameters:
    
    storeId - the store id
    
    locale - the locale
    
    langId - the langId
    
    responseFormat - the response format
    
    Returns:
    
    the allowable shipping modes

Class CartHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.rest.classic.core.AbstractConfigBasedClassicHandler

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

RESOURCE_NAME

CART_MAPPING_KEY

CART_CHANGE_MAPPING_KEY

USABLE_SHIPPING_INFO_MAPPING_KEY

USABLE_PAYMENT_INFO_MAPPING_KEY

FORMAT_GROUP_NAME

Constructor Detail

CartHandler

Method Detail

getResourceName

getFormattingGroupName

getHelper

getCart

scheduleOrder

setPendingOrder

cancelOrder

createOrder

copyOrder

deleteOrderItem

calculateOrder

calculateOrder

getUsableShippingInfo

getUsableShipChargesByShipMode

getBuyerPurchaseOrderDataBean

getUsableBillingAddressListTCDataBean

getPAttributeDataBean

getPaymentPolicyListDataBean

applyCheckoutProfile

getUsablePaymentInfo

addOrderItem

udpateOrderItem

updateOrderItem

addConfigurationToCart

addPreConfigurationToCart

updateConfigurationInCart

updateRewardOption

cancelOrderInCart

moveOrderItem

preCheckout

checkOut

lockCart

lockCartOnBehalf

unlockCart

unlockCartOnBehalf

postProcess

getAllowableShippingModes

getAllowableShippingModes