Get Template
Retrieves a specific Sales Configuration Template by its ID, including metadata, associated tags, and cart totals.
- Resource URL:
/services/apexrest/<namespace>/v1/cpq/templates/{templateId} - HTTP Method: GET
- Content-Type: application/json
- Response Format: JSON
| Parameter | Type | Required | Description |
|---|---|---|---|
| templateId | String | Yes | The SalesConfigTemplate__c record ID. |
GET /services/apexrest/vlocity_cmt/v1/cpq/templates/a1Bxx0000004XyzDEF
| 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. |
Success Response (200):