RCG Salesforce Orders System API - Implementation Template
Data mappings
This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.
Module | Description |
---|---|
create-orderlineitem-request | Create OrderLines mapping |
createOrdersRequest | Create Order mapping |
getOrderByIdResponse | Get OrderById response mapping |
getOrderListResponse | Get OrdersList response mapping |
updateOrderRequest | Update order mapping |
create-orderlineitem-request
Create OrderLines mapping
Source:
./src/main/resources/dwl/create-orderlineitem-request.dwl
Variables
var s
Create OrderLines mapping.
Mapping Tables
Create OrderLines mapping.
Request Field | CIM Source field | Description of source field |
---|---|---|
OrderId | salesOrderResponse ID | Order ID |
TotalLineAmount | totalPriceAmount | Total Price Amount of a Product |
Product2Id | Product2Id from Query Response | Product ID |
PricebookEntryId | PricebookEntryId from Query Response | PriceBook Entry ID |
SBQQOrderedQuantityc | orderedQuantity | Order Quantity |
UnitPrice | totalUnitPriceAmount | Unit Price of the Product |
Quantity | orderedQuantity | Order Quantity |
createOrdersRequest
Create Order mapping
Source:
./src/main/resources/dwl/createOrdersRequest.dwl
Mapping Tables
Create Order mapping.
Request Field | CIM Source field | Description of source field |
---|---|---|
name | name | Order Name |
AccountId | soldToCustomer | Account Id Info |
Description | description | Description of the Order |
EffectiveDate | sysdate | Effective date of the Order |
Global_SalesOrder_Id__c | externalIds[0].externalId | Global SalesOrder Id |
Status | salesOrderStatus | Status of the order |
Type | salesOrderType | Type of order |
Pricebook2Id | default value | PriceBook ID |
Total_Tax__c | totalTaxAmount | Total Tax Amount |
Shipping__c | totalDeliveryFeeAmount | Shipping Fee |
getOrderByIdResponse
Get OrderById response mapping
Source:
./src/main/resources/dwl/getOrderByIdResponse.dwl
Mapping Tables
Get OrderById response mapping.
Resp Field | Salesforce Source field | Description of source field |
---|---|---|
name | Name | name of the Order |
requestedStartDate | OrderedDate | Ordered Date |
id | Id | Salesforce Order Id |
soldToCustomer | AccountId | Salesforce Account Id Info |
description | Description | Description of the Order |
salesOrderConfirmationStatus.id | Id | Salesforce Order Id confirmation |
salesOrderConfirmationStatus.name | Name | name of the order confirmation |
taxRate | Tax__c | tax Rate |
totalProductAmount | TotalAmount | total Product Amount |
purchaseOrderNumber | PoNumber | Po Number |
totalDeliveryAmount | TotalAdjustedDeliveryAmount | Delivery Amount |
activatedDate | EffectiveDate | Effective Date |
renewalTerm.name | SBQQRenewalTermc | Renewal term details |
totalAdjustmentAmount | TotalAdjustedProductAmount | Total Adjusted Product Amount |
shipToContact | ShipToContactId | Ship To ContactId Info |
billToEmail | BillingEmailAddress | Billing EmailAddress |
promiseFulfillmentDate | EffectiveDate | Effective Date |
grandTotalAmount | OrderTotalAmount__c | TotalAmount of the Order |
shipToAddress | shipToAddress | Shipping Address |
purchaseOrderDate | PoDate | Purchase Order date |
adjustedTotalProductAmount | TotalAdjustedProductAmount | Adjusted Product Amount |
orderStartDate | OrderedDate | Salesforce Order start date |
totalDeliveryFeeAmount | Shipping__c | Shipping Fee |
salesChannel | SalesChannelId | Sales Channel Id |
originalOrder | OriginalOrderId | Salesforce Original Order Id |
totalProductTaxAmount | TotalTaxAmount | Tax Amount |
billToAddress | BillingAddress | Billing Address Info |
salesOrderType.id | RecordTypeId | Record Type Id |
salesOrderType.name | Type | Salesforce Order Type |
totalAdjustmentTaxAmount | Tax__c | Tax amount |
totalAdjustedDeliveryTaxAmount | TotalAdjustedDeliveryTaxAmount | Delivery Tax Amount |
billToPhoneNumber | BillingPhoneNumber | Billing Phone Number |
totalBookingAmount | SBQQOrderBookingsc | Booking Amount |
totalTaxAmount | Total_Tax__c | Total Tax Amount |
priceCalculationStatusMessageText | SBQQPriceCalcStatusMessagec | Price Calculation Status Message |
orderEndDate | EndDate | EndDate for Order |
renewalUpliftRate | SBQQRenewalUpliftRatec | renewal Uplift Rate |
auditInfo.createdBy | CreatedById | CreatedBy Id |
auditInfo.updatedBy | LastModifiedById | UpdatedBy Id |
auditInfo.updatedDate | LastModifiedDate | Updated Date |
auditInfo.createdDate | CreatedDate | Created Date |
salesOrderSystemStatus | Status | Status of the Salesforce Order |
externalIds.externalIdType | "MDM" | Master data management |
externalIds.externalId | External_ID__c | Global SalesOrder id |
getOrderListResponse
Get OrdersList response mapping
Source:
./src/main/resources/dwl/getOrderListResponse.dwl
Mapping Tables
Get OrdersList response mapping.
Resp Field | Salesforce Source field | Description of source field |
---|---|---|
name | Name | name of the Order |
requestedStartDate | OrderedDate | Ordered Date |
id | Id | Salesforce Order Id |
soldToCustomer | AccountId | Salesforce Account Id Info |
description | Description | Description of the Order |
salesOrderConfirmationStatus.id | Id | Salesforce Order Id confirmation |
salesOrderConfirmationStatus.name | Name | name of the order confirmation |
taxRate | Tax__c | tax Rate |
totalProductAmount | TotalAmount | total Product Amount |
purchaseOrderNumber | PoNumber | Po Number |
totalDeliveryAmount | TotalAdjustedDeliveryAmount | Delivery Amount |
activatedDate | EffectiveDate | Effective Date |
renewalTerm.name | SBQQRenewalTermc | Renewal term details |
totalAdjustmentAmount | TotalAdjustedProductAmount | Total Adjusted Product Amount |
shipToContact | ShipToContactId | Ship To ContactId Info |
billToEmail | BillingEmailAddress | Billing EmailAddress |
promiseFulfillmentDate | EffectiveDate | Effective Date |
grandTotalAmount | OrderTotalAmount__c | TotalAmount of the Order |
shipToAddress | shipToAddress | Shipping Address |
purchaseOrderDate | PoDate | Purchase Order date |
adjustedTotalProductAmount | TotalAdjustedProductAmount | Adjusted Product Amount |
orderStartDate | OrderedDate | Salesforce Order start date |
totalDeliveryFeeAmount | Shipping__c | Shipping Fee |
salesChannel | SalesChannelId | Sales Channel Id |
originalOrder | OriginalOrderId | Salesforce Original Order Id |
totalProductTaxAmount | TotalTaxAmount | Tax Amount |
billToAddress | BillingAddress | Billing Address Info |
salesOrderType.id | RecordTypeId | Record Type Id |
salesOrderType.name | Type | salefore order type |
totalAdjustmentTaxAmount | Tax__c | Tax amount |
totalAdjustedDeliveryTaxAmount | TotalAdjustedDeliveryTaxAmount | Delivery Tax Amount |
billToPhoneNumber | BillingPhoneNumber | Billing Phone Number |
totalBookingAmount | SBQQOrderBookingsc | Booking Amount |
totalTaxAmount | Total_Tax__c | Total Tax Amount |
priceCalculationStatusMessageText | SBQQPriceCalcStatusMessagec | Price Calculation Status Message |
orderEndDate | EndDate | EndDate for Order |
renewalUpliftRate | SBQQRenewalUpliftRatec | renewal Uplift Rate |
auditInfo.createdBy | CreatedById | CreatedBy Id |
auditInfo.updatedBy | LastModifiedById | UpdatedBy Id |
auditInfo.updatedDate | LastModifiedDate | Updated Date |
auditInfo.createdDate | CreatedDate | Created Date |
salesOrderSystemStatus | Status | Status of the Salesforce Order |
externalIds.externalIdType | "MDM" | Master data management |
externalIds.externalId | External_ID__c | Global SalesOrder id |
updateOrderRequest
Update order mapping
Source:
./src/main/resources/dwl/updateOrderRequest.dwl
Mapping Tables
Update order mapping.
Resp Field | CIM Source field | Description of source field |
---|---|---|
name | name | Order Name |
AccountId | soldToCustomer | Account Id Info |
Description | description | Description of the Order |
EffectiveDate | sysdate | Effective date of the Order |
Global_SalesOrder_Id__c | externalIds[0].externalId | Global SalesOrder Id |
Status | salesOrderStatus | Status of the order |