Splitting an Order using API

This API divides an existing order (parent order) into multiple orders (child orders) during the provisioning process. You can split any large order that was created from a Quote, Agreement, or Direct order that has not been amended.

API Details

API	Signature
SplitOrder	webService static Apttus_Config2.CPQStruct.SplitOrderResponseDO splitOrder(Apttus_Config2.CPQStruct.SplitOrderRequestDO)

Parameters
Name	Type	Description
request	CPQStruct.SplitOrderRequestDO	The request data object.

Request Data Object - CPQStruct.SplitOrderRequestDO
Field	Type	Required?	Description
OrderId	ID	Yes	The parent order ID to create a split order.
OrderLineNumbers	ID	Yes	order line numbers to be part of new split order.

API Response

Response Data Object - CPQStruct.SplitOrderResponseDO
Field	Type	Description
SplitOrderSO	ID	The Id of the newly created split order.

Code Sample

The following code sample enables you to split an existing valid order into multiple orders using OrderId and OrderLineNumbers.

Sample snippet:

// split the order
    Apttus_Config2.CPQStruct.SplitOrderRequestDO request = new Apttus_Config2.CPQStruct.SplitOrderRequestDO();
    request.OrderId = 'a2n7A0000002jnWQAQ'; // order id to create split order from
   
    request.OrderLineNumbers = new List<Integer>{1}; //add order line numbers to be part of new split order
   
    Apttus_Config2.CPQStruct.SplitOrderResponseDO result = Apttus_Config2.OrderWebService.splitOrder(request);
       
    Apttus_Config2__Order__c splitOrderSO = result.SplitOrderSO;

CODE

Integration Details

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

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:splitOrder>
         <ord:request>
            <cpq:OrderId>a2n7A0000002tviQAA</cpq:OrderId>
           <cpq:OrderLineNumbers>2</cpq:OrderLineNumbers>
         </ord:request>
      </ord:splitOrder>
   </soapenv:Body>
</soapenv:Envelope>

XML

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/schemas/class/Apttus_Config2/OrderWebService" xmlns:SplitOrderResponseDO="http://soap.sforce.com/schemas/class/Apttus_Config2/CPQStruct" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <splitOrderResponse>
         <result>
            <SplitOrderResponseDO:SplitOrderSO xsi:type="Apttus_Config2__Order__c">
               <Id>a2n7A0000002tvxQAA</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:39:40.000Z</Apttus_Config2__ConfigurationSyncDate__c>
               <Apttus_Config2__IsTaskPending__c>false</Apttus_Config2__IsTaskPending__c>
               <Apttus_Config2__OrderAmount__c>500.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__ParentOrderId__c>a2n7A0000002tviQAA</Apttus_Config2__ParentOrderId__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>
            </SplitOrderResponseDO:SplitOrderSO>
         </result>
      </splitOrderResponse>
   </soapenv:Body>
</soapenv:Envelope>

XML