Get Template

Retrieves a specific Sales Configuration Template by its ID, including metadata, associated tags, and cart totals.

Resource Information

Resource URL: /services/apexrest/<namespace>/v1/cpq/templates/{templateId}
HTTP Method: GET
Content-Type: application/json
Response Format: JSON

Request Body

Parameter	Type	Required	Description
templateId	String	Yes	The SalesConfigTemplate__c record ID.

Example REST Request

GET /services/apexrest/vlocity_cmt/v1/cpq/templates/a1Bxx0000004XyzDEF

Response Parameters

Parameter	Type	Description
Id	String	Template record ID.
Name	String	Template name.
Description__c	String	Template description.
Status__c	String	Current lifecycle status.
Category__c	String	Template category.
TemplateQuoteId__c	String	ID of the underlying template Quote (if Quote-based).
TemplateOrderId__c	String	ID of the underlying template Order (if Order-based).
CartType	String	Either "Quote" or "Order", indicating the type of the underlying cart.
Tags	Array	List of associated tag objects, each containing Id, Name, and Description__c.
EffectiveOneTimeTotal__c	Decimal	Total effective one-time charges from the template cart.
EffectiveRecurringTotal__c	Decimal	Total effective recurring charges from the template cart.
EffectiveUsagePriceTotal__c	Decimal	Total effective usage charges (only present when the Usage Pricing feature is enabled).
PriceList__r	Object	Related Price List with Id, Name, and CurrencyCode__c.

Example REST Response

Success Response (200):

{
  "success": true,
  "errorCode": "INVOKE-200",
  "result": {
    "messages": [],
    "templateDetails": {
      "template": {
        "Id": "a1Bxx0000004XyzDEF",
        "Name": "Enterprise Fiber Bundle",
        "vlocity_cmt__Description__c": "Standard fiber bundle for enterprise customers",
        "vlocity_cmt__Status__c": "Approved",
        "vlocity_cmt__Category__c": "Enterprise",
        "vlocity_cmt__TemplateQuoteId__c": "0Q0xx0000004CabCAE",
        "CartType": "Quote",
        "Tags": [
          {
            "Id": "a2Cxx0000001AbcDEF",
            "Name": "Enterprise",
            "vlocity_cmt__Description__c": "Templates for enterprise customers"
          },
          {
            "Id": "a2Cxx0000001DefGHI",
            "Name": "Fiber",
            "vlocity_cmt__Description__c": null
          }
        ],
        "vlocity_cmt__EffectiveOneTimeTotal__c": 299.99,
        "vlocity_cmt__EffectiveRecurringTotal__c": 89.99,
        "vlocity_cmt__EffectiveUsagePriceTotal__c": 0.00,
        "vlocity_cmt__PriceList__r": {
          "Id": "a3Dxx0000002GhiJKL",
          "Name": "Standard Price List",
          "vlocity_cmt__CurrencyCode__c": "USD"
        }
      }
    }
  }
}