RCG B2B Commerce 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-pricebookentry-request | Pricebooks Create Mapping for B2B Commerce System |
| pricebook-entries-select | Pricebooks Query Mapping for B2B Commerce System |
| pricebook-put-pricebookentrybody | Pricebooks Create Mapping for B2B Commerce System |
| product-entitlements-assign-put | CommerceEntitlementProduct Create Mapping for B2B Commerce System |
| product-image-prepare-entries-to-be-created | ProductMedia Create Mapping for B2B Commerce System |
| product-media-select | ProductMedia Query Mapping for B2B Commerce System |
| product-primarycategory-select | ProductCatalog Query Mapping for B2B Commerce System |
| product-response-get | Product Query Mapping for B2B Commerce System |
| product-var-put-payload | Product Upsert Mapping for B2B Commerce System |
| search-products-response | Product Query Mapping for B2B Commerce System |
| update-pricebookentry-request | Pricebooks Update Mapping for B2B Commerce System |
create-pricebookentry-request
Pricebooks Create Mapping for B2B Commerce System
Source:
./src/main/resources/dwl/create-pricebookentry-request.dwl
Mapping Tables
Maps CIM PricebookEntry to B2B Commerce PricebookEntry format
| B2B Commerce | CIM | Description |
|---|---|---|
| IsActive | true | Indicates whether or not the pricebookEntry is active |
| Pricebook2Id | Pricebook2Id | The id of the pricebookEntry |
| Product2Id | productId | The id of the product |
| UnitPrice | unitListPrice | The unitListPrice of the pricebookEntry |
pricebook-entries-select
Pricebooks Query Mapping for B2B Commerce System
Source:
./src/main/resources/dwl/pricebook-entries-select.dwl
Mapping Tables
Maps B2B Commerce PricebookEntry to CIM PricebookEntry format
| CIM | B2B Commerce | Description |
|---|---|---|
| id | Pricebook2Id | The id of the pricebookEntry in B2B Commerce system |
| name | Pricebook2.Name | The name of the pricebookEntry in B2B Commerce system |
| unitListPrice | UnitPrice | The unit price of the pricebookEntry in B2B Commerce system |
| auditInfo.createdBy | CreatedById | Identifies the system or user which created the pricebookEntry entry |
| auditInfo.createdDate | CreatedDate | Timestamp of when the pricebookEntry entry was created |
| auditInfo.updatedBy | LastModifiedById | Identifies the system or user which last updated the pricebookEntry entry |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the pricebookEntry entry was last updated |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the pricebookEntry has been soft-deleted |
pricebook-put-pricebookentrybody
Pricebooks Create Mapping for B2B Commerce System
Source:
./src/main/resources/dwl/pricebook-put-pricebookentrybody.dwl
Variables
var s
Maps CIM PricebookEntry to B2B Commerce PricebookEntry format
Mapping Tables
Maps CIM PricebookEntry to B2B Commerce PricebookEntry format
| B2B Commerce | CIM | Description |
|---|---|---|
| External_ID__c | Pricebook2Id | The id of the pricebookEntry to be stored in B2B Commerce |
| IsActive | true | Indicates whether or not the pricebookEntry is active |
| Pricebook2Id | Pricebook2Id | The id of the pricebookEntry |
| Product2Id | productId | The id of the product |
| UnitPrice | unitListPrice | The unitListPrice of the pricebookEntry |
product-entitlements-assign-put
CommerceEntitlementProduct Create Mapping for B2B Commerce System
Source:
./src/main/resources/dwl/product-entitlements-assign-put.dwl
Mapping Tables
Maps Input request to B2B Commerce CommerceEntitlementProduct format
| B2B Commerce | Input Payload | Description |
|---|---|---|
| PolicyId | CommerceEntitlementPolicy.Id | The policy Id extracted from CommerceEntitlementPolicy object |
| ProductId | product2ID | The identifier of the product |
product-image-prepare-entries-to-be-created
ProductMedia Create Mapping for B2B Commerce System
Source:
./src/main/resources/dwl/product-image-prepare-entries-to-be-created.dwl
Variables
var s
Maps CIM ProductImage to B2B Commerce ProductMedia format
Mapping Tables
Maps CIM ProductImage to B2B Commerce ProductMedia format
| B2B Commerce | CIM | Description |
|---|---|---|
| ProductId | product2ID | The product code of the product to be updated |
| ElectronicMediaGroupId | ElectronicMediaGroupId | The Electronic Media Group Id of the Product image |
| ElectronicMediaId | ElectronicMediaId | The Electronic Media Id of the Product image |
product-media-select
ProductMedia Query Mapping for B2B Commerce System
Source:
./src/main/resources/dwl/product-media-select.dwl
Mapping Tables
Maps B2B Commerce ProductMedia to CIM ProductImage format
| CIM | B2B Commerce | Description |
|---|---|---|
| id | Id | The id of the product image in B2B Commerce system |
| name | Name | The name of the product image in B2B Commerce system |
| isDefaultImage | isDefaultImage | Indicates whether or not the product image is default image - default set to false |
| auditInfo.createdBy | CreatedById | Identifies the system or user which created the product image entry |
| auditInfo.createdDate | CreatedDate | Timestamp of when the product image entry was created |
| auditInfo.updatedBy | LastModifiedById | Identifies the system or user which last updated the product image entry |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the product image entry was last updated |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the product image has been soft-deleted |
product-primarycategory-select
ProductCatalog Query Mapping for B2B Commerce System
Source:
./src/main/resources/dwl/product-primarycategory-select.dwl
Mapping Tables
Maps B2B Commerce to CIM product.primaryProductCategory
| CIM | B2B Commerce | Description |
|---|---|---|
| id | ProductCategoryProduct.ProductCategory.Id | The identifier of the product category |
| name | ProductCategoryProduct.ProductCategory.Name | The name of the product category |
| activeFromDate | ProductCategoryProduct.ProductCategory.CreatedDate | Timestamp of when the product category entry was created |
| parentCategory | ProductCategoryProduct.ParentCategoryId | The parent category id of the product category |
| productCatalog.id | ProductCatalog.Id | The identifier of the product catalog |
| productCatalog.name | ProductCatalog.Name | The name of the product catalog |
| productCatalog.activeFromDate | ProductCatalog.CreatedDate | Timestamp of when the product catalog entry was created |
product-response-get
Product Query Mapping for B2B Commerce System
Source:
./src/main/resources/dwl/product-response-get.dwl
Mapping Tables
Maps B2B Commerce Product2 to CIM Product format
| CIM | B2B Commerce | Description |
|---|---|---|
| id | ID | The id of the Product in B2B Commerce system |
| name | Name | The name of the Product in B2B Commerce system |
| longDescription | Description | The description of the Product in B2B Commerce system |
| description | Short_Description__c | The description of the Product in B2B Commerce system |
| externalSourceRecord | External_ID__c | The external id of the Product in B2B Commerce system |
| isSellable | IsActive | Indicates whether or not the product is active |
| type | Family | The family of the Product in B2B Commerce system |
| primaryProductCategory | productCategory | The product category of the product retrieved using a separate call |
| productId | ProductCode | The id of the Product in B2B Commerce system |
| productSKU | StockKeepingUnit | The sku of the Product in B2B Commerce system |
| productStatus | Status__c | The status of the Product in B2B Commerce system |
| auditInfo.createdBy | CreatedById | Identifies the system or user which created the product entry |
| auditInfo.createdDate | CreatedDate | Timestamp of when the product entry was created |
| auditInfo.updatedBy | LastModifiedById | Identifies the system or user which last updated the product entry |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the product entry was last updated |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the product has been soft-deleted |
product-var-put-payload
Product Upsert Mapping for B2B Commerce System
Source:
./src/main/resources/dwl/product-var-put-payload.dwl
Mapping Tables
Maps CIM Product to B2B Commerce Product2 format
| B2B Commerce | CIM | Description |
|---|---|---|
| ProductCode | productCode | The product code of the product to be updated |
| Product_Catalog__c | "All Products" | Product catalog set to "All products" |
| Description | longDescription | The long description of the product |
| Item_Long_Description__c | The long description of the product | |
| Short_Description__c | description | The description of the product |
| Item_Short_Description__c | description | The description of the product |
| Status__c | productStatus | The status of the product |
| External_ID__c | externalSourceRecord | The external id of the product |
| ExternalId | externalSourceRecord | The external id of the product |
| Family | type | The type of the product |
| IsActive | isSellable | Indicates whether or not the product is active |
| StockKeepingUnit | productSKU | The sku of the product |
search-products-response
Product Query Mapping for B2B Commerce System
Source:
./src/main/resources/dwl/search-products-response.dwl
Variables
var s
Maps B2B Commerce Product2 to CIM Product format
Mapping Tables
Maps B2B Commerce Product2 to CIM Product format
| CIM | B2B Commerce | Description |
|---|---|---|
| id | ID | The id of the Product in B2B Commerce system |
| name | Name | The name of the Product in B2B Commerce system |
| longDescription | Description | The description of the Product in B2B Commerce system |
| description | Short_Description__c | The description of the Product in B2B Commerce system |
| externalSourceRecord | External_ID__c | The external id of the Product in B2B Commerce system |
| isSellable | IsActive | Indicates whether or not the product is active |
| type | Family | The family of the Product in B2B Commerce system |
| primaryProductCategory | productCategory | The product category of the product retrieved using a separate call |
| productId | ProductCode | The id of the Product in B2B Commerce system |
| productSKU | StockKeepingUnit | The sku of the Product in B2B Commerce system |
| productStatus | Status__c | The status of the Product in B2B Commerce system |
| auditInfo.createdBy | CreatedById | Identifies the system or user which created the product entry |
| auditInfo.createdDate | CreatedDate | Timestamp of when the product entry was created |
| auditInfo.updatedBy | LastModifiedById | Identifies the system or user which last updated the product entry |
| auditInfo.updatedDate | LastModifiedDate | Timestamp of when the product entry was last updated |
| auditInfo.isDeleted | IsDeleted | Indicates whether or not the product has been soft-deleted |
update-pricebookentry-request
Pricebooks Update Mapping for B2B Commerce System
Source:
./src/main/resources/dwl/update-pricebookentry-request.dwl
Mapping Tables
Maps CIM PricebookEntry to B2B Commerce PricebookEntry format
| B2B Commerce | CIM | Description |
|---|---|---|
| Id | vars.pricebookEntryRecordList[0].Id | The Identifier of the existing standard pricebook entry |
| IsActive | true | Indicates whether or not the pricebookEntry is active |
| Pricebook2Id | Pricebook2Id | The id of the pricebookEntry |
| Product2Id | productId | The id of the product |
| UnitPrice | unitListPrice | The unitListPrice of the pricebookEntry |