Create Supplemental Order
For CME Winter '20 and later releases, a supplemental order can be created to amend or cancel the previous order.
For releases prior to CME Winter '20, any supplemental order is treated as an order cancellation. See In-Flight Order Cancellation.
This API supports the guest user enhancements that Salesforce introduced with the Winter ‘21 release. To encrypt and decrypt data for guest users, use the UserSecurity class with this API. See Guest User Technical Details.
For additional information, see UserSecurity Class and CPQ and Digital Commerce Changes for Guest Users.
Use this CpqAppHandler method with the following inputs to create a supplemental order for an order that is already in a frozen state.
-
currentOrdId: The ID of the current order
-
intentForSupplement: A string indicating the reason for creating the supplemental order, which can be
Cancel(the default) orAmend. If the intent is not specified,Cancelis used.
Communication (vlocity_cmt)
For API parameter names and descriptions, see Cart-Based API Swagger Reference.
| Response Format | JSON |
|---|---|
| Resource URL | /services/apexrest/{namespace}/v2/cpq/carts/{order_ID}/cancel |
| Code | Description |
|---|---|
| SUPPLEMENT-1101 | The createSupplementalOrder API accepts the intent parameter and its valid values: Amend and Cancel (the default). If no value is passed, it is defaulted to Cancel. If an invalid value is passed, this error code is returned. |
| SUPPLEMENT-1102 | An internal error occurred during the createSupplementalOrder API call. |
| SUPPLEMENT-1103 | When the createSupplementalOrder API is invoked on an original order and the IsChangesAllowed flag is set to false, this code is returned. |
| SUPPLEMENT-1104 | When the createSupplementalOrder API is invoked on an order that is in a state other than In Progress, this error code is returned. |
| SUPPLEMENT-1105 | When the createSupplementalOrder API is invoked on an order that requires pricing and pricing implementation errors out, then this code is returned. |
| SUPPLEMENT-1106 | When the createSupplementalOrder API is invoked on an original order that already has a supplemental order, this code is returned. |
See Also