Product Offering Resource Mappings

FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory for the CPQ or EPC API implementation?Is Supported?
namestringRequired. Specifies the name of the product offering.Product2.NameSpecifies the name of the product.YesYes
agreementarrayRepresents 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-/-NoNo
attachmentarrayProvides additional description of an element, such as a product, through videos or pictures.VlocityAttachment__c-/-NoYes
categoryarrayGroups product offerings, services, and resource candidates in logical containers. Categories can contain other categories or product offerings, resources, or service candidates.CatalogProductRelationship__c-/-NoYes
channelarrayDefines the channel for selling product offerings.-/--/-NoNo
descriptionstringProvides a description of the product offering.Product2.DescriptionDescribes the product.NoYes
isBundlebooleanIndicates whether a product offering represents a single product offering (false) or a bundle of product offerings (true).Product2.specificationSubType__cDetermines whether the offer is of simple or bundle subtype.NoYes
isSellablebooleanIndicates whether the product offer can be sold standalone (true) or only within a bundle (false).Product2.IsOrderable__c-/-NoYes
productNumberstringSpecifies the code associated with the product.Product2.ProductCode-/-NoYes
lastUpdatedatetimeSpecifies the date and time of the last update.NA-/-NoYes
lifecycleStatusstringSpecifies the current lifecycle status.Product2.Status__cDetermines 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.NoYes
marketSegmentarrayProvides 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-/-NoNo
placearrayDefines the places where the products are sold or delivered.NA-/-NoNo
bundledProductOfferingarraySpecifies 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__cSpecifies the product child relationship.NoYes
prodSpecCharValueUsearrayA 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-/-NoYes
productOfferingPricearraySpecifies 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__cAn 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.NoYes
productOfferingRelationshipobjectSpecifies a relationship between the product offering and other product offerings.ProductRelationship__c-/-NoYes
productOfferingTermarraySpecifies 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-/-NoYes
productSpecificationobjectDetailed 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-/-NoYes
resourceCandidateobjectAn entity that makes a resource specification available to a catalog.NA-/-NoNo
serviceCandidateobjectAn entity that makes a service specification available to a catalog.NA-/-NoNo
serviceLevelAgreementobjectRepresents 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-/-NoNo
statusReasonstringProvides supplementary information about the value of the lifecycle status attribute.NA-/-NoYes
validForobjectSpecifies the period for which the product offering is valid.SellingStartDate__c-/-NoYes
validForobjectSpecifies the period for which the product offering is valid.EndOfLifeDate__c-/-NoYes
versionstringSpecifies the product offering version.VersionLabel__c-/-NoYes
FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory for the CPQ or EPC implementation?Is Supported?
namestringSpecifies the name of the attachment.NameSpecifies the name of the attachment.YesYes
descriptionstringDescribes the content of the attachment.Description__cDescribes the attachment.NoYes
hrefstringSpecifies the URI for the attachment.TMF Attachment URL + VlocityAttachment: IDSpecifies the GET URL of the TMF attachment that ends with the ID field.NoYes
idstringSpecifies the unique identifier of the attachment.AttachmentId__cSpecifies the ID of the attachment.NoYes
urlstringThe Uniform Resource Locator, which is a web page address and a subset of URI.UrlLong__cSpecifies the URL of the attachment.YesYes
NANANAObjectId__cObject ID is the product2 ID of the incoming product specification.YesYes
@baseTypestringDefines the super class when subclassing.NANANoNo
@schemaLocationstringSpecifies the URI to a JSON schema file that defines additional attributes and relationships.NANANoNo
@typestringDefines the subclass extensible name when subclassing.NANANoNo
attachmentTypestringSpecifies the attachment type, such as a video or a picture.ContentType__cSpecifies the content type, such as a picture, a video, or a file.NoYes
contentstringRetrieves the actual contents of the attachment object, if embedded, encoded as base64.NANANoYes
mimeTypestringSpecifies the attachment mime type, such as an extension file for a video, a picture, and a document.NANANoYes
sizeobjectSpecifies the size of the attachment.NANANoYes
validForobjectSpecifies the period for which the attachment is valid.NANANoYes
FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory for the CPQ or EPC implementation?Is Supported?
idstringSpecifies a unique identifier of the bundled product offering.ProductChildItem__c GlobalKey__c-/-NoYes
lifecycleStatusstringSpecifies the current lifecycle status.NA-/-NoYes
namestringSpecifies the name of the bundled product offering.ProductChildItem__c ChildProductId__r Name-/-NoYes
bundledProdOfferOptionintegerSpecifies the default number of product offerings that's procured as part of the related bundled product offering.Quantity__c-/-NoYes
bundledProdOfferOptionintegerSpecifies the lower limit for a product offering that's procured as part of the related bundled product offering.MinQuantity__c-/-NoYes
bundledProdOfferOptionintegerSpecifies the upper limit for a product offering that's procured as part of the related bundled product offering.MaxQuantity__c-/-NoYes
@baseTypestringDefines the super class when subclassing.NANANoNo
@schemaLocationstringSpecifies the URI to a JSON schema file that defines additional attributes and relationships.NANANoNo
@typestringDefines the subclass extensible name when subclassing.NANANoNo
FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory for the CPQ or EPC implementation?Is Supported?
isDefaultbooleanIndicates whether the value is the default for a characteristic (true) or not (false).attributeAssignments:attributes-/-NoYes
rangeIntervalstringSpecifies the inclusion or exclusion of the valueFrom and valueTo attributes. Possible values are open, closed, closedBottom, and closedTop.-/--/-NoYes
regexstringSpecifies a regular expression constraint for a given value.-/--/-NoYes
unitOfMeasurestringSpecifies 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.-/--/-NoYes
validForobjectSpecifies the period for which the value is applicable.EffectiveFromDate__c-/-NoYes
validForobjectSpecifies the period for which the value is applicable.EffectiveUntilDate__c-/-NoYes
valueanySpecifies a discrete value that the characteristic can accept or the actual value of the characteristic.value-/-NoYes
valueFromintegerSpecifies the lower range value that a characteristic can accept.-/--/-NoYes
valueTointegerSpecifies the upper range value that a characteristic can accept.-/--/-NoYes
valueTypestringSpecifies the type of value that the characteristic value can accept, such as numeric and text.ValueType__c-/-NoYes
@baseTypestringDefines the super class when subclassing.NANANoNo
@schemaLocationstringSpecifies the URI to a JSON schema file that defines additional attributes and relationships.NANANoNo
@typestringDefines the subclass extensible name when subclassing.NANANoNo
FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory for the CPQ or EPC implementation?Is Supported?
namestringRequired. Specifies the name of the product offering price.PriceListEntry__c.Name-/-YesYes
constraintarrayRepresents a policy or rule that's applied to the product offering price.-/--/-NoNo
descriptionstringProvides the description of the product offering price.PriceListEntry__c DisplayText__c-/-NoYes
isBundlebooleanIndicates whether the ProductOfferingPrice property is a composite bundle (true) or not (false).PriceListEntry__c isBundle-/-NoYes
lastUpdatedatetimeSpecifies the last update time of the product offering price.-/--/-NoYes
lifecycleStatusstringSpecifies the lifecycle status of the product offering price.PriceListEntry IsActive__c-/-NoYes
price.taxincludedamount.unitstringSpecifies the currency. The ISO4217 norm uses 3 letters to define the currency.PricingElementId__r CurrencyCode__c-/-NoYes
price.taxincludedamount.valuefloatSpecifies a positive floating point number.PricingElementId__r: Amount__c-/-NoYes
priceTypestringSpecifies a category that describes the price charge, such as recurring, penalty, and one-time fee.priceListEntries: PricingElementId__r: PricingVariableId__r: ChargeType__c-/-NoYes
recurringChargePeriodLengthintegerSpecifies 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-/-NoNo
recurringChargePeriodstringSpecifies the period to apply the price again, which can be months, weeks, and so on.PriceListEntry PricingElementId__r: PricingVariableId__r: RecurringFrequency__c-/-NoYes
taxarraySpecifies 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-/-NoNo
unitOfMeasureobjectSpecifies 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-/-NoYes
validForobjectSpecifies the period for which the product offering price is valid.PriceListEntry__c EffectiveFromDate__c EffectiveUntilDate__c-/-NoYes
versionstringSpecifies the product offering version.Not supported by EPC-/-NoYes
priceAlterationarraySpecifies an amount that modifies the price charged for an order item.priceListEntries: PricingElementId__r: PricingVariableId__r: ChargeType__c = Adjustment-/-NoYes
@baseTypestringDefines the super class when subclassing.NANANoNo
@schemaLocationstringSpecifies the URI to a JSON schema file that defines additional attributes and relationships.NANANoNo
@typestringDefines the subclass extensible name when subclassing.NANANoNo
FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory for the CPQ or EPC implementation?Is Supported?
@baseTypestringDefines the super class when subclassing.NANANoNo
@schemaLocationstringSpecifies the URI to a JSON schema file that defines additional attributes and relationships.NANANoNo
@typestringDefines the subclass extensible name when subclassing.NANANoNo
FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory for the CPQ or EPC implementation?Is Supported?
@baseTypestringDefines the super class when subclassing.NANANoNo
@schemaLocationstringSpecifies the URI to a JSON schema file that defines additional attributes and relationships.NANANoNo
@typestringDefines the subclass extensible name when subclassing.NANANoNo
FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory for the CPQ or EPC implementation?Is Supported?
@baseTypestringDefines the super class when subclassing.NANANoNo
@schemaLocationstringSpecifies the URI to a JSON schema file that defines additional attributes and relationships.NANANoNo
@typestringDefines the subclass extensible name when subclassing.NANANoNo