Product Specification Resource Mappings
Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? |
---|---|---|---|---|---|
href | string | Specifies a unique reference of the catalog. | TMF product specification URL + product2: ID | Specifies the GET URL of the TMF product specification that ends with the ID field. | No |
description | string | Specifies the details of the product specification. | Product2.Description | Describes the product. | No |
name | string | Required. Specifies the name of the product specification. | Product2.Name | Specifies the name of the product. | Yes |
productNumber | string | Specifies the identification number assigned to uniquely identify the specification. | Product2.ProductCode | Specifies the product code. | Yes |
lifecycleStatus | string | Specifies the current lifecycle status. | Product2. IsActive Product2.Status__c | Product2. IsActive field specifies the active status flag. Product2.Status__c field specifies the status of a product. | No |
attachment | array | Specifies a list of attachment references or values (AttachmentRefOrValue [*]). Supplements the description of an element, such as a product, through videos or pictures. | VlocityAttachment__c | Specifies the product attachments. | No |
validFor: startDateTime | object | Specifies the period for which the catalog is valid. | Product2.EffectiveDate__c Product2.FulfilmentStartDate__c Product2.SellingStartDate__c Product2.VersionStartDateTime__c | Specifies the start dates of the validity period. | No |
validFor: endDateTime | object | Specifies the period for which the catalog is valid. | Product2.EndDate__c Product2.EndOfLifeDate__c Product2.SellingEndDate__c Product2.VersionEndDateTime__c | Specifies the end dates of the validity period. | No |
version | string | Specifies the product specification version. | Product2.VersionLabel__c | Specifies the version number of the product specification. | No |
bundledProductSpecification | array | Specifies a type of product specification that belongs to a grouping of product specifications made available to the market. A bundled product specification inherits all attributes of a product specification. | ProductChildItem__c | Specifies the product child relationship. | No |
targetProductSchema | object | Specifies the reference object to the schema and type of a target product, which is described by the product specification. | Product2.ObjectTypeId__c | Specifies the object type of a product. | No |
productSpecificationRelationship | array | Specifies migration, substitution, dependency, or exclusivity relationship between product specifications. | ProductRelationship__c | Specifies the product relationships. | No |
isSellable | boolean | Indicates whether the product offer can be sold standalone (true) or within a bundle only (false). | Product2.IsOrderable__c | Specifies if the product can be ordered or not. | No |
Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? |
---|---|---|---|---|---|
name | string | Specifies the name of the related party. | Name | Specifies the name of the account. | Yes |
href | string | Specifies the hyperlink reference of the related party. | TMF Account URL + Account: ID | Specifies the GET URL of the TMF catalog that ends with the ID field. | No |
id | string | Specifies the unique identifier of the related party. | AccountNumber | Specifies the external ID for the specified account. | Yes |
role | string | Specifies the role played by the related party. | AccountRecordType | Specifies the record type of the account. | No |
Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? |
---|---|---|---|---|---|
name | string | Specifies the name of the attachment. | Name | Specifies the name of the attachment. | Yes |
description | string | Describes the content of the attachment. | Description__c | Describes the attachment. | No |
href | string | Specifies the URI of the attachment. | TMF Attachment URL + VlocityAttachment | Specifies the GET URL of the TMF attachment that ends with the ID field. | No |
id | string | Specifies the unique identifier of the attachment. | AttachmentId__c | Specifies the ID of the attachment. | No |
url | string | The Uniform Resource Locator, which is a web page address and a subset of URI. | UrlLong__c | Specifies the URL of the attachment. | Yes |
attachmentType | string | Specifies the attachment type, such as a video or a picture. | ContentType__c | Specifies the content type, such as a picture, a video, or a file. | No |
Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? |
---|---|---|---|---|---|
href | string | Specifies the hyperlink reference of the product specification. | TMF Attachment URL + Product2: ID | Specifies the GET URL of the TMF product specification that ends with the ID field. | No |
id | string | Specifies a unique identifier of the product specification. | ParentProductId__r. GlobalKey__c | Specifies the external ID of the parent product. | No |
name | string | Specifies the name of the product specification. | ParentProductId__r.Name | Specifies the name of the parent product. | Yes |
Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? |
---|---|---|---|---|---|
name | string | Specifies the name of the related entity. | RelatedProductId__r.Name | Specifies the name of the related product. | Yes |
id | string | Specifies a unique identifier of the product specification relationship. | RelatedProductId__r. GlobalKey__c | Specifies the external ID of the related product. | No |
href | string | Specifies the hyperlink reference of the product specification relationship. | TMF Attachment URL + Product2: ID | Specifies the GET URL of the TMF product specification that ends with the ID field. | No |
relationshipType | string | Specifies the type of relationship, such as migration, substitution, dependency, or exclusivity. | RelationshipType__c | Specifies the relationship type. The expected values must be configured in Salesforce CRM before invoking the resource. | Yes |
Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? |
---|---|---|---|---|---|
name | string | Specifies a word, term, or phrase by which the characteristic specification is known and distinguished from other characteristic specifications. | Attribute__c.Name AttributeAssignment__c.Name Picklist__c.Name | Specifies the name of the attribute and attribute assignment. | Yes |
description | string | Describes the CharacteristicSpecification object. | Attribute__c.Description__c | Describes the attribute. | No |
valueType | string | Specifies a type of value that the characteristic can accept, such as numeric and text. | Attribute__c. ValueDataType__c Picklist__c.DataType__c | Specifies the external ID of the related product. | Yes |
productSpecCharacteristicValue: value | array | Defines a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. | Attribute__c.Value__c PicklistValue__c.Name | Specifies the value of the attribute. | Yes |