Product Offering Resource Mappings
| Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC API implementation? | Is Supported? |
|---|---|---|---|---|---|---|
| name | string | Required. Specifies the name of the product offering. | Product2.Name | Specifies the name of the product. | Yes | Yes |
| agreement | array | Represents a contract or arrangement, either written or verbal. An agreement is sometimes enforceable by law, such as a service-level agreement or a customer-price agreement. An agreement involves a number of other business entities, such as products, services, and resources with their specifications. | NA | -/- | No | No |
| attachment | array | Provides additional description of an element, such as a product, through videos or pictures. | VlocityAttachment__c | -/- | No | Yes |
| category | array | Groups product offerings, services, and resource candidates in logical containers. Categories can contain other categories or product offerings, resources, or service candidates. | CatalogProductRelationship__c | -/- | No | Yes |
| channel | array | Defines the channel for selling product offerings. | -/- | -/- | No | No |
| description | string | Provides a description of the product offering. | Product2.Description | Describes the product. | No | Yes |
| isBundle | boolean | Indicates whether a product offering represents a single product offering (false) or a bundle of product offerings (true). | Product2.specificationSubType__c | Determines whether the offer is of simple or bundle subtype. | No | Yes |
| isSellable | boolean | Indicates whether the product offer can be sold standalone (true) or only within a bundle (false). | Product2.IsOrderable__c | -/- | No | Yes |
| productNumber | string | Specifies the code associated with the product. | Product2.ProductCode | -/- | No | Yes |
| lastUpdate | datetime | Specifies the date and time of the last update. | NA | -/- | No | Yes |
| lifecycleStatus | string | Specifies the current lifecycle status. | Product2.Status__c | Determines the status of the product, which is also mapped to the IsActive property as true if the lifecycleStatus property is Active. Also, the lifecycleStatus property is set as Draft. | No | Yes |
| marketSegment | array | Provides references to the corresponding market segment as a target of product offerings. A market segment is a grouping of parties, geographic areas, sales channels, and so on. | NA | -/- | No | No |
| place | array | Defines the places where the products are sold or delivered. | NA | -/- | No | No |
| bundledProductOffering | array | Specifies a type of product offering that belongs to a grouping of product offerings made available to the market. A bundled product offering inherits all the attributes of a product offering. | ProductChildItem__c | Specifies the product child relationship. | No | Yes |
| prodSpecCharValueUse | array | A use of the ProductSpecificationCharacteristicValue object by a ProductOffering object to which additional properties (attributes) apply or override the properties of similar properties contained in the ProductSpecificationCharacteristicValue object. The values of characteristics exist in the corresponding product specification. The available characteristic values for a ProductSpecificationCharacteristic object in a product specification can be modified at the ProductOffering object level. For example, the Color characteristic can have White, Blue, Green, and Red as value. But, the list of values can be restricted to for example, White and Blue in an associated product offering. The list of values in a ProductSpecificationCharacteristicValueUse object is a strict subset of the list of values as defined in the corresponding product specification characteristics. | AttributeAssignment__c | -/- | No | Yes |
| productOfferingPrice | array | Specifies an amount, usually of money that is asked for or allowed when a product offering is bought, rented, or leased. The price is valid for a defined period and doesn’t necessarily represent the actual price paid by a customer. | PriceListEntry__c | An entry in a price list is a specific price, cost, fee, discount, or adjustment defined within a price list. A given price list entry is defined for an offer, a promotion, or some other context. The price list entry defines the terms and conditions of the pricing including the duration of the pricing as well as policies governing the pricing. | No | Yes |
| productOfferingRelationship | object | Specifies a relationship between the product offering and other product offerings. | ProductRelationship__c | -/- | No | Yes |
| productOfferingTerm | array | Specifies a condition with which a product offering is made available to customers. For instance, a product offering can be offered with multiple commitment periods. | Promotion__c | -/- | No | Yes |
| productSpecification | object | Detailed description of a tangible or intangible object made available externally in the form of a product offering to customers or other parties playing a party role. | Product2 | -/- | No | Yes |
| resourceCandidate | object | An entity that makes a resource specification available to a catalog. | NA | -/- | No | No |
| serviceCandidate | object | An entity that makes a service specification available to a catalog. | NA | -/- | No | No |
| serviceLevelAgreement | object | Represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so on. The service-level agreement (SLA) is a set of appropriate procedures and targets formally or informally agreed between parties to achieve and maintain specified quality of service. | NA | -/- | No | No |
| statusReason | string | Provides supplementary information about the value of the lifecycle status attribute. | NA | -/- | No | Yes |
| validFor | object | Specifies the period for which the product offering is valid. | SellingStartDate__c | -/- | No | Yes |
| validFor | object | Specifies the period for which the product offering is valid. | EndOfLifeDate__c | -/- | No | Yes |
| version | string | Specifies the product offering version. | VersionLabel__c | -/- | No | Yes |
| Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? | Is Supported? |
|---|---|---|---|---|---|---|
| name | string | Specifies the name of the attachment. | Name | Specifies the name of the attachment. | Yes | Yes |
| description | string | Describes the content of the attachment. | Description__c | Describes the attachment. | No | Yes |
| href | string | Specifies the URI for the attachment. | TMF Attachment URL + VlocityAttachment: ID | Specifies the GET URL of the TMF attachment that ends with the ID field. | No | Yes |
| id | string | Specifies the unique identifier of the attachment. | AttachmentId__c | Specifies the ID of the attachment. | No | Yes |
| 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 | Yes |
| NA | NA | NA | ObjectId__c | Object ID is the product2 ID of the incoming product specification. | Yes | Yes |
| @baseType | string | Defines the super class when subclassing. | NA | NA | No | No |
| @schemaLocation | string | Specifies the URI to a JSON schema file that defines additional attributes and relationships. | NA | NA | No | No |
| @type | string | Defines the subclass extensible name when subclassing. | NA | NA | No | No |
| 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 | Yes |
| content | string | Retrieves the actual contents of the attachment object, if embedded, encoded as base64. | NA | NA | No | Yes |
| mimeType | string | Specifies the attachment mime type, such as an extension file for a video, a picture, and a document. | NA | NA | No | Yes |
| size | object | Specifies the size of the attachment. | NA | NA | No | Yes |
| validFor | object | Specifies the period for which the attachment is valid. | NA | NA | No | Yes |
| Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? | Is Supported? |
|---|---|---|---|---|---|---|
| id | string | Specifies a unique identifier of the bundled product offering. | ParentProductId__r. GlobalKey__c | -/- | No | Yes |
| lifecycleStatus | string | Specifies the current lifecycle status. | NA | -/- | No | Yes |
| name | string | Specifies the name of the bundled product offering. | ParentProductId__r.Name | -/- | No | Yes |
| bundledProdOfferOption | integer | Specifies the default number of product offerings that's procured as part of the related bundled product offering. | Quantity__c | -/- | No | Yes |
| bundledProdOfferOption | integer | Specifies the lower limit for a product offering that's procured as part of the related bundled product offering. | MinQuantity__c | -/- | No | Yes |
| bundledProdOfferOption | integer | Specifies the upper limit for a product offering that's procured as part of the related bundled product offering. | MaxQuantity__c | -/- | No | Yes |
| @baseType | string | Defines the super class when subclassing. | NA | NA | No | No |
| @schemaLocation | string | Specifies the URI to a JSON schema file that defines additional attributes and relationships. | NA | NA | No | No |
| @type | string | Defines the subclass extensible name when subclassing. | NA | NA | No | No |
| Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? | Is Supported? |
|---|---|---|---|---|---|---|
| isDefault | boolean | Indicates whether the value is the default for a characteristic (true) or not (false). | attributeAssignments:attributes | -/- | No | Yes |
| rangeInterval | string | Specifies the inclusion or exclusion of the valueFrom and valueTo attributes. Possible values are open, closed, closedBottom, and closedTop. | -/- | -/- | No | Yes |
| regex | string | Specifies a regular expression constraint for a given value. | -/- | -/- | No | Yes |
| unitOfMeasure | string | Specifies a unit of measure, such as length, surface, volume, dry measure, liquid measure, money, weight, or time. Determines the quantity or magnitude of the designated kind and is a standard of comparison for others of the same kind. Assigns numerical values to the unit of measure, such as 1 foot, 1 yard, 1 mile, or 1 square foot. | -/- | -/- | No | Yes |
| validFor | object | Specifies the period for which the value is applicable. | EffectiveFromDate__c | -/- | No | Yes |
| validFor | object | Specifies the period for which the value is applicable. | EffectiveUntilDate__c | -/- | No | Yes |
| value | any | Specifies a discrete value that the characteristic can accept or the actual value of the characteristic. | value | -/- | No | Yes |
| valueFrom | integer | Specifies the lower range value that a characteristic can accept. | -/- | -/- | No | Yes |
| valueTo | integer | Specifies the upper range value that a characteristic can accept. | -/- | -/- | No | Yes |
| valueType | string | Specifies the type of value that the characteristic value can accept, such as numeric and text. | ValueType__c | -/- | No | Yes |
| @baseType | string | Defines the super class when subclassing. | NA | NA | No | No |
| @schemaLocation | string | Specifies the URI to a JSON schema file that defines additional attributes and relationships. | NA | NA | No | No |
| @type | string | Defines the subclass extensible name when subclassing. | NA | NA | No | No |
| Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? | Is Supported? |
|---|---|---|---|---|---|---|
| name | string | Required. Specifies the name of the product offering price. | PriceListEntry__c.Name | -/- | Yes | Yes |
| constraint | array | Represents a policy or rule that's applied to the product offering price. | -/- | -/- | No | No |
| description | string | Provides the description of the product offering price. | PriceListEntry__c DisplayText__c | -/- | No | Yes |
| isBundle | boolean | Indicates whether the ProductOfferingPrice property is a composite bundle (true) or not (false). | PriceListEntry__c isBundle | -/- | No | Yes |
| lastUpdate | datetime | Specifies the last update time of the product offering price. | -/- | -/- | No | Yes |
| lifecycleStatus | string | Specifies the lifecycle status of the product offering price. | PriceListEntry IsActive__c | -/- | No | Yes |
| price.taxincludedamount.unit | string | Specifies the currency. The ISO4217 norm uses 3 letters to define the currency. | PricingElementId__r CurrencyCode__c | -/- | No | Yes |
| price.taxincludedamount.value | float | Specifies a positive floating point number. | PricingElementId__r: Amount__c | -/- | No | Yes |
| priceType | string | Specifies a category that describes the price charge, such as recurring, penalty, and one-time fee. | priceListEntries: PricingElementId__r: PricingVariableId__r: ChargeType__c | -/- | No | Yes |
| recurringChargePeriodLength | integer | Specifies the period of the recurring charge: 1, 2, and so on. The recurringChargePeriodLength field is set to zero if not applicable. | Not supported by EPC | -/- | No | No |
| recurringChargePeriod | string | Specifies the period to apply the price again, which can be months, weeks, and so on. | PriceListEntry PricingElementId__r: PricingVariableId__r: RecurringFrequency__c | -/- | No | Yes |
| tax | array | Specifies a list of tax items (TaxItem [*]), which are the charges levied on the price of a product by a legislative body. | Not supported by EPC | -/- | No | No |
| unitOfMeasure | object | Specifies a number and unit representing the number of the product offerings available at the offered price. The unit of measure depends on the priceType property, which can be a price, rate, or discount. | Not supported by EPC | -/- | No | Yes |
| validFor | object | Specifies the period for which the product offering price is valid. | PriceListEntry__c EffectiveFromDate__c EffectiveUntilDate__c | -/- | No | Yes |
| version | string | Specifies the product offering version. | Not supported by EPC | -/- | No | Yes |
| priceAlteration | array | Specifies an amount that modifies the price charged for an order item. | priceListEntries: PricingElementId__r: PricingVariableId__r: ChargeType__c = Adjustment | -/- | No | Yes |
| @baseType | string | Defines the super class when subclassing. | NA | NA | No | No |
| @schemaLocation | string | Specifies the URI to a JSON schema file that defines additional attributes and relationships. | NA | NA | No | No |
| @type | string | Defines the subclass extensible name when subclassing. | NA | NA | No | No |
| Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? | Is Supported? |
|---|---|---|---|---|---|---|
| @baseType | string | Defines the super class when subclassing. | NA | NA | No | No |
| @schemaLocation | string | Specifies the URI to a JSON schema file that defines additional attributes and relationships. | NA | NA | No | No |
| @type | string | Defines the subclass extensible name when subclassing. | NA | NA | No | No |
| Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? | Is Supported? |
|---|---|---|---|---|---|---|
| @baseType | string | Defines the super class when subclassing. | NA | NA | No | No |
| @schemaLocation | string | Specifies the URI to a JSON schema file that defines additional attributes and relationships. | NA | NA | No | No |
| @type | string | Defines the subclass extensible name when subclassing. | NA | NA | No | No |
| Field | Type | Description | Salesforce Mapping | Salesforce Description | Is mandatory for the CPQ or EPC implementation? | Is Supported? |
|---|---|---|---|---|---|---|
| @baseType | string | Defines the super class when subclassing. | NA | NA | No | No |
| @schemaLocation | string | Specifies the URI to a JSON schema file that defines additional attributes and relationships. | NA | NA | No | No |
| @type | string | Defines the subclass extensible name when subclassing. | NA | NA | No | No |