Salesforce CPQ Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Salesforce CPQ Developer Guide
Get Started with Salesforce CPQ API
CPQ API Models
CPQ Quote API
CPQ Configuration API
CPQ Contract API
Contract Amender API
Contract Renewer API
Generate Quote Document API
Service Router
CPQ API Quickstart Guide
Disable CPQ Triggers in Apex
Advanced Approvals API
Salesforce CPQ Plugins
PDF

Contract Amender API

Receive a CPQ contract ID in a request, and return quote data for an amendment quote.
Available in: Salesforce CPQ Summer ’16 and later
Special Access Rules: All of these user permissions are required.
  • Create on Opportunity
  • Read on Quote, Opportunity, and Product2
  • Insert and update on Quote and Opportunity
  • Delete on Quote and Opportunity

Without full access on Opportunity, an error results, and contract amendment fails.

Important

Service Provider Name
SBQQ.ContractManipulationAPI.ContractAmender
Formats
JSON, Apex
HTTP Method
PATCH
Authentication
Authorization: Bearer token
REQUEST
Parameter 1
Name: uid
Type: String
Required: Yes
Description: 15-character case sensitive or 18-character case insensitive Salesforce Contract ID to amend.
Parameter 2
Available in: Salesforce CPQ Winter ’21 and later
Name: AmendmentContext
Type: AmendmentContext
Required: No
Description: Context for the contract to amend.
RESPONSE
Type
QuoteModel
Description
Representation of SBQQ__Quote__c data for an amendment quote

REST Examples

curl "https://yourInstance.salesforce.com/services/apexrest/SBQQ/ServiceRouter?loader=SBQQ.ContractManipulationAPI.ContractAmender&uid=800R00000000X4g"
    -H  "Content-Type: application/json" -H "Authorization: Bearer token" -X PATCH
An example response body after amending a quote. The actual response is a JSON formatted string.
{
    "record": {
        "attributes": {
            "type": "SBQQ__Quote__c", 
            "url": "/services/data/v41.0/sobjects/SBQQ__Quote__c/a0p610000040iumAAA"
        }, 
        "Id": "a0p610000040iumAAA", 
        "Name": "Q-00880"
    }, 
    "nextKey": 5, 
    "netTotal": 300, 
    "netNonSegmentTotal": 300, 
    "lineItems": [
        {
            "record": {
                "attributes": {
                    "type": "SBQQ__QuoteLine__c", 
                    "url": "/services/data/v41.0/sobjects/SBQQ__QuoteLine__c/a0l61000003u09UAAQ"
                }, 
                "Id": "a0l61000003u09UAAQ"
            }
        }
    "lineItemGroups": [ ]
}
An example response body after amending a quote. The actual response is a JSON formatted string.
{
  "record": {
    "attributes": {
      "type": "SBQQ__Quote__c",
      "url": "/services/data/v41.0/sobjects/SBQQ__Quote__c/a0p61000004IpR8AAK"
    }
  },
  "nextKey": 4,
  "netTotal": 0.00,
  "lineItems": [
    {
      "record": {
        "attributes": {
          "type": "SBQQ__QuoteLine__c"
        },
        "SBQQ__Product__c": "01t610000033JNtAAM"
      },
      "productQuantityEditable": true,
      "productHasDimensions": false,
      "key": 3,
      "descriptionLocked": false
    },
    {
      "record": {
        "attributes": {
          "type": "SBQQ__QuoteLine__c"
        },
        "SBQQ__Product__c": "01t610000033JNUAA2",
        "SBQQ__Product__r": {
          "attributes": {
            "type": "Product2",
            "url": "/services/data/v41.0/sobjects/Product2/01t610000033JNUAA2"
          },
          "Id": "01t610000033JNUAA2",
          "Name": "Product 2",
          "ProductCode": "P2"
        }
      }
    }
  ],
  "lineItemGroups": [
    {
      "record": {
        "attributes": {
          "type": "SBQQ__QuoteLineGroup__c",
          "url": "/services/data/v41.0/sobjects/SBQQ__QuoteLineGroup__c/a0k61000008WIF1AAO"
        },
        "SBQQ__Quote__c": "a0p61000004IpR8AAK",
        "Id": "a0k61000008WIF1AAO",
        "SBQQ__Number__c": 1.0,
        "SBQQ__SeparateContract__c": false,
        "Name": "Group1"
      },
      "key": 2,
      "hasMultiSegmentLines": false
    }
  ],
  "customerTotal": 0.00
}

Apex Examples

Before saving the ContractAmender example class, make sure that the CPQ model classes are added as individual Apex classes in your org.

Note

In this example, the amendment context isn’t used.

public with sharing class ContractAmender {
    public QuoteModel load(String contractId) {
        String quoteJSON = SBQQ.ServiceRouter.load('SBQQ.ContractManipulationAPI.ContractAmender', contractId, null);
        return (QuoteModel) JSON.deserialize(quoteJSON, QuoteModel.class);
    }
}
 
ContractAmender amender = new ContractAmender();
QuoteModel quote = amender.load('8001D000000AUlg'); // example id
System.debug(quote);

In this example, the amendment context is used.

public with sharing class ContractAmenderTest {

    public QuoteModel load(String contractId, String context) {

        String quoteJSON = SBQQ.ServiceRouter.load('SBQQ.ContractManipulationAPI.ContractAmender', contractId, context);
        return (QuoteModel) JSON.deserialize(quoteJSON, QuoteModel.class);
    }
}

// Create an amendment context
private with sharing class AmendmentContextTest {
    public Boolean returnOnlyQuoteId;
}

AmendmentContextTest context = new AmendmentContextTest();
context.returnOnlyQuoteId = true; 

// Invoke the ContractAmender API
String contextJson = JSON.serialize(context);
ContractAmenderTest amender = new ContractAmenderTest();
QuoteModel quote = amender.load('CONTRACT_ID', contextJson);
Example response body for returnOnlyQuoteId = true:
{"attributes":{"type":"SBQQ__Quote__c","url":"/services/data/v50.0/sobjects/SBQQ__Quote__c/12345"},"Id":"12345"}