The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.
TMF622 Resource Mappings
These default mappings are supported for the TMF622 resources:
| TMForum Field | Field type | TMForum Description | Salesforce Mapping | Salesforce Description | Is Mandatory? | Prerequisite |
|---|
| description | string | Description of the product order. | Order.Description | Specifies the description of an order. | No | NA |
| externalId | string | ID given by the consumer and only understandable by him (to facilitate his searches afterwards). | Order.OrderReferenceNumber | Specifies the external ID of an order. | No | NA |
| requestedCompletionDate | DateTime | Requested delivery date from the requestor perspective. | Order.vlocity_cmt__RequestedCompletionDate__c | Specifies the requested completion date of an order. | No | NA |
| requestedStartDate | DateTime | Order fulfillment start date wished by the requestor. This is used when the requestor cannot allow seller to begin to operationally begin the fulfillment before a date. | order.vlocity_cmt__RequestedStartDate__c | Specifies the requested start date of an order. | Yes | NA |
| orderDate | DateTime | Date when the order was created. | Order.createdDate | Specifies the created date of the order. | Yes | NA |
| channel | | A list of related channels (RelatedChannel [*]). Related channel to another entity. May be online web, mobile app, social ,etc. | order.vlocity_cmt__OriginatingChannel__c | Specifies the originating channel of an order. | No | NA |
| note | | A list of notes (Note [*]). Extra information about a given entity. | order.vlocity_cmt__Notes__c | Specifies notes, if any, for an order. | No | NA |
| productOrderItem | | A list of product order items (ProductOrderItem [1..*]). An identified part of the order. A product order is decomposed into one or more order items. | OrderItem | Specifies the items of an order. | Yes | Products in the input payload must be available in the Salesforce org for creating an order. Products must have a valid EPC setup and price list entries. |
| relatedParty | | A list of related parties (RelatedParty [*]). Related Entity reference. A related party defines party or party role linked to a specific entity. | Account | Specifies the account to which an order belongs to. | Yes | relatedParty must be available in the input payload for creating an order. ‘relatedParty[0]’ is considered as account details from the incoming request. This account must be available in Salesforce with incoming role as the record type. name as the account name. and ID as account number. |
| | | vlocity_cmt__PriceList__c | Specifies the Price List of an order. | Yes | A valid Pricelist name must be configured in the TMForumPriceList metadata to add products to the cart. This pricelist must have a valid EPC setup in the Salesforce org. |
| state | | Specifies the state of an order. | order.Status | Specifies the status of an order. | No | NA |
| TMForum Field | Field type | TMForum Description | Salesforce Mapping | Salesforce Description | Is Mandatory? |
|---|
| action | string | Categorizes the order from a business perspective that can be useful for the OM system. | OrderItem.vlocity_cmt__Action__c | Specifies the action. | Yes |
| id | string | ID of the product order item. | OrderItem.Product2.vlocity_cmt__GroupGlobalKey__c | Specifies the unique identifier of a product. | Yes |
| quantity | | Quanity of a product order item. | OrderItem.Quantity | Specifies the quanity of an order product. | No |
| TMForum Field | TMForum Description | Salesforce Mapping | Salesforce Description | Is Mandatory? |
|---|
| name | A string. Name of the related entity. | Name | Specifies the name of the account. | No |
| href | An uri (Uri). Hyperlink reference. | TMF Account Url + Account | Specifies the TMF Product Ordering GET URL ending with ID field. | No |
| id | A string. unique identifier. | Account.AccountNumber | Specifies the external ID for the given account. | Yes |
| role | A string. Role played by the related party. | Account.AccountRecordType | Specifies the record type of the account. | No |
| @referredType | A string. The actual type of the target instance when needed for disambiguation. | Schema object name i.e "Account" | Specifies the entitye type is Account. | No |
| @type | A string. When sub-classing, this defines the sub-class Extensible name. | Json representation type i.e "RelatedParty" | NA | Yes |