Reverting a Cancelled Order

This API reverts the cancellation of an order.

Note: For more information on how the order and its line items are affected when you revert a cancelled order, refer to the Order Management for Users.

API Details


API	Signature
undoCancelOrder	`webService static Apttus_Config2.CPQStruct.UndoCancelOrderResponseDO undoCancelOrder(Apttus_Config2.CPQStruct.UndoCancelOrderRequestDO)`


Parameters
Name	Type	Description
Request	`Apttus_Config2.CPQStruct.UndoCancelOrderRequestDO`	The request data object.


Request Data Object - Apttus_Config2.CPQStruct.UndoCancelOrderRequestDO
Field	Type	Required?	Description
orderId	`ID`	Yes	Unique identifier of the cancelled order.

API Response


Response Data Object - CPQStruct.UndoCancelOrderResponseDO
Field	Type	Description
PreviousOrderSO	Standard Data Object `<Apttus_Config2__Order__c>`	The fields of the Previous Order Object.

Code Sample

The following API lets you undo or revert the cancelled order.

Id orderId = 'a2n6C000000Dj0r';
Apttus_Config2.CPQStruct.UndoCancelOrderRequestDO request = new Apttus_Config2.CPQStruct.UndoCancelOrderRequestDO
request.OrderId = orderId;

Apttus_Config2.CPQStruct.UndoCancelOrderResponseDO result = OrderWebService.undoAmendOrder(request);

system.debug('order object undone cancallation'+result.PreviousOrderSO);

Integration Details

Use the following information in your integrations with Conga CPQ Web Services API. Refer to Integrate Conga with External Systems for information on how to get started.

API Prerequisites

None.

Request and Response XML

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ord="http://soap.sforce.com/schemas/class/Apttus_Config2/OrderWebService" xmlns:cpq="http://soap.sforce.com/schemas/class/Apttus_Config2/CPQStruct">
   <soapenv:Header>
      <ord:SessionHeader>
         <ord:sessionId>00D7A0000009QII!ARUAQFmpeBOmsYS2JcADxYc4PxWoOkAHJP1JiNo5vtvnDBCEvfnWWWmO7pqbEXY7WadiCmm_Vib6MjhmgUbR8321tIO1NQRg</ord:sessionId>
      </ord:SessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <ord:undoCancelOrder>
         <ord:request>
           <cpq:OrderId>a2n7A0000002twXQAQ</cpq:OrderId>
         </ord:request>
      </ord:undoCancelOrder>
   </soapenv:Body>
</soapenv:Envelope>

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/schemas/class/Apttus_Config2/OrderWebService" xmlns:UndoCancelOrderResponseDO="http://soap.sforce.com/schemas/class/Apttus_Config2/CPQStruct" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <undoCancelOrderResponse>
         <result>
            <UndoCancelOrderResponseDO:PreviousOrderSO xsi:type="Apttus_Config2__Order__c">
               <Id>a2n7A0000002tviQAA</Id>
               <Apttus_Config2__AutoActivateOrder__c>false</Apttus_Config2__AutoActivateOrder__c>
               <Apttus_Config2__BillToAccountId__c>0017A00000WW0pZQAT</Apttus_Config2__BillToAccountId__c>
               <Apttus_Config2__BillingPreferenceId__c>a2d2f0000000h0YAAQ</Apttus_Config2__BillingPreferenceId__c>
               <Apttus_Config2__ConfigurationSyncDate__c>2020-07-06T08:43:16.000Z</Apttus_Config2__ConfigurationSyncDate__c>
               <Apttus_Config2__IsTaskPending__c>false</Apttus_Config2__IsTaskPending__c>
               <Apttus_Config2__OrderAmount__c>300.00000</Apttus_Config2__OrderAmount__c>
               <Apttus_Config2__OrderDate__c>2020-07-06T06:33:53.000Z</Apttus_Config2__OrderDate__c>
               <Apttus_Config2__OriginalOrderNumber__c>O-00005958</Apttus_Config2__OriginalOrderNumber__c>
               <Apttus_Config2__PriceListId__c>a173C000000fHFQQA2</Apttus_Config2__PriceListId__c>
               <Apttus_Config2__PricingDate__c>2020-07-06T06:33:53.000Z</Apttus_Config2__PricingDate__c>
               <Apttus_Config2__ReadyForWorkflow__c>false</Apttus_Config2__ReadyForWorkflow__c>
               <Apttus_Config2__ShipToAccountId__c>0017A00000WW0pZQAT</Apttus_Config2__ShipToAccountId__c>
               <Apttus_Config2__SoldToAccountId__c>0017A00000WW0pZQAT</Apttus_Config2__SoldToAccountId__c>
               <Apttus_Config2__SourceChannel__c>Direct</Apttus_Config2__SourceChannel__c>
               <Apttus_Config2__Source__c>Account</Apttus_Config2__Source__c>
               <Apttus_Config2__Status__c>Draft</Apttus_Config2__Status__c>
               <Apttus_Config2__Type__c>New</Apttus_Config2__Type__c>
               <CurrencyIsoCode>USD</CurrencyIsoCode>
               <Name>O-00005958</Name>
            </UndoCancelOrderResponseDO:PreviousOrderSO>
         </result>
      </undoCancelOrderResponse>
   </soapenv:Body>
</soapenv:Envelope>

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.