ccrz.ccLogicCartPlace.placeOrder

Passes the input data to the ccrz.cc_api_Cart.placeEOrder public method, which invokes methods of the ccrz.cc_hk_Order and ccrz.cc_hk_Payment extension point classes. Those methods return data to this method, including the created order and the transaction details.

Compatibility

This reference applies to:

Release Managed Package Version API Version
B2B Commerce for Visualforce Spring ’20 4.12 11
B2B Commerce for Visualforce Summer ’19 4.11 10
B2B Commerce for Visualforce Spring ’19 4.10 9
B2B Commerce for Visualforce Summer ’18 4.9 8

This method isn't used in the logic chain for B2B Commerce for Visualforce Winter ’21 (managed package version 4.13 and API version 12). The ccrz.cc_api_Cart.placeEOrder public method is deprecated in this version.

Important

Signature

global virtual Map<String, Object> placeOrder(Map<String, Object>)

Inputs (Required)

This method accepts the working Map<String, Object> from the ccrz.ccLogicCartPlace.processInput method.

This method requires one of the following keys to execute:

ccrz.ccApiCart.CART_ID
String that specifies the Salesforce ID of the cart to convert.
ccrz.ccApiCart.CART_ENCID
String that specifies the encrypted ID of the cart to convert.

Inputs (Optional)

If the working map includes the following keys, this method evaluates them:

ccrz.ccApi.API_SIZING
Map<String, Object> that describes options for sizing and scoping the method's return data. This method supports ccrz.ccApi.SZ_REFETCH => TRUE, which specifies that this method invokes ccrz.ccApiCart.fetch for returning the ordered cart.
ccrz.ccApi.SIZING => new Map<String, Object>{
    ccrz.ccApiCart.ENTITYNAME => new Map<String, Object>{
        ccrz.ccApi.SZ_REFETCH => TRUE
    }
}
ccrz.ccApiCart.PAYMENTDATA
JSON-formatted string that describes payment information passed to the ccrz.cc_hk_Payment.processPayment extension point method's ccrz.cc_hk_Payment.PARAM_TRANSACTION_DATA input.
ccrz.ccApiCart.TRANSPAYMENTDATA
JSON-formatted string that describes payment information returned in the ccrz.cc_hk_Payment.processPayment extension point method's ccrz.cc_hk_Payment.PARAM_TRANSACTION_PROCESSED_DATA output.
ccrz.ccApiCart.PAYMENTRESULT
Map<String, Object> that represents the output from the ccrz.cc_hk_Payment.processPayment extension point method.
ccrz.ccApiOrder.PARAM_ORDER_STATUS
String that specifies the status of the corresponding order. By default, this method expects the value Order Submitted.

Outputs

This method returns the working Map<String, Object>, and sets the following key:

ccrz.ccApi.SUCCESS
Boolean
Value Usage
true The call completed.
false The call encountered errors.

B2B Commerce for Visualforce doesn't always return an exception for any errors that can occur. When this value is false, consider rolling back the API transaction to a previous savepoint.

Tip

ccrz.ccApiCart.CART_OBJLIST
List<Map<String, Object>>, which contains one Map<String, Object> that represents the ccrz__E_Cart__c record, which the ccrz.ccApiCart.fetch method returned.
  • This key is returned only when the input map specified ccrz.ccApi.SZ_REFETCH => true.
  • The ccrz.ccApiCart.fetch call can also return ccrz.ccApiAddress.ADDRESSLIST and ccrz.ccApiProduct.PRODUCTLIST keys. For more information about returning address and product data for a cart, see ccrz.ccApiCart.fetch.

Note

ccrz.ccApiCart.ORDER_ID
String that specifies the Salesforce ID of the created ccrz__E_Order__c.
ccrz.ccApiCart.SUBCRESULT
Map<String, Object> that contains the results of the ccrz.cc_hk_Subscriptions.onOrder method, which is invoked from ccrz.cc_api_Cart.placeEOrder.
ccrz.ccApiCart.TRANSACTIONRESULT
Map<String, Object> that contains the results of the ccrz.cc_hk_Order.createTransaction method, which is invoked from ccrz.cc_api_Cart.placeEOrder.