Catalog Resource Mappings

FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory for the CPQ, EPC, or TMF API implementation?Is Supported?
hrefstringSpecifies a unique reference of the catalog.TMF Catalog URL + Catalog: IDSpecifies the GET URL of the TMF catalog that ends with the ID field.NoNo
idstringSpecifies a unique identifier of the catalog.vlocity_cmt__GlobalKey__cSpecifies the ID that the customer wants to add.NoYes
catalogTypestringSpecifies the type of catalog, such as a product, service, or resource catalog.Not available-/-NoNo
descriptionstringDescribes the catalog.Catalog__c.Description__c-/-NoYes
lifecycleStatusstringSpecifies the current lifecycle status.vlocity_cmt__IsActive__c-/-YesYes
namestringRequired. Specifies the name of the catalog.Name-/-YesYes
validFor - startDateTime/endDateTimeobjectSpecifies the period for which the catalog is valid.vlocity_cmt__StartDateTime__c/vlocity_cmt__EndDateTime__c-/-NoYes
versionstringSpecifies the catalog version.Not available-/-NoNo
relatedPartyarrayDefines a party or party role that's linked to a specific entity.vlocity_cmt__VendorAccount__cSpecifies the field that's derived from the vendor column of the catalog object.NoYes
@typestringDefines the subclass extensible name when subclassing.Resource name (Catalog)The @type attribute differentiates between the catalog and category request and doesn't have a direct mapping in Salesforce.YesYes
@schemaLocationstringSpecifies the URI to a JSON schema file that defines additional attributes and relationships.Not available-/-NoNo
Not available-/--/-vlocity_cmt__IsCatalogRoot__c-/-NoYes
Not available-/--/-vlocity_cmt__DefaultPriceListId__c-/-YesYes
FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory for the CPQ, EPC, or TMF API implementation?Is Supported?
namestringSpecifies the name of the related party.NameSpecifies the name of the account.NoYes
hrefstringSpecifies the hyperlink reference of the related party.TMF Account URL + Account: IDSpecifies the GET URL of the TMF catalog that ends with the ID field.NoNo
idstringSpecifies the unique identifier of the related party.AccountNumberSpecifies the external ID for the specified account.YesYes
rolestringSpecifies the role played by the related party.AccountRecordTypeSpecifies the record type of the account.NoYes
@referredTypestringSpecifies the actual type of the target instance when needed for disambiguation.Schema object name (Account)-/-NoYes
@typestringDefines the subclass extensible name when subclassing.JSON representation type (RelatedParty)-/-YesYes
@schemaLocationstringSpecifies the URI to a JSON schema file that defines additional attributes and relationships.Not available-/-NoNo