Quote Term Reader API

Retrieve quote terms for a quote.

Formats

JSON, Apex

HTTP Method

PATCH

Authentication

Authorization: Bearer token

REQUEST

Parameter 1

Name: quoteId

Type: Id

Required: Yes

Description: The quote record's ID

Parameter 2

Name: templateId

Type: Id

Required: Optional

Description: The quote template record's ID. If you don’t include the templateId parameter, the quote terms associated with the template contents don’t return.

Parameter 3

Name: language

Type: String

Required: Optional

Description: Language code when using CPQ translations.

RESPONSE

Type

QuoteTermModel

Description

The representation of SBQQ__QuoteTerm__c data

Example request body termContext.json file for reading quote terms. The context value is a JSON-formatted string.

An example response body returning two quote terms. The actual response is a JSON-formatted string.

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

For an example of the QuoteTermReader class, run this code in anonymous Apex.