RCG B2C 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 |
|---|---|
| createProductInventoryRequest | Maps Input payload to B2C Commerce Cloud Product Inventory |
| createProductRequest | Maps Input payload to B2C Commerce Cloud Product |
| createProductVariationValueResponse | Maps Input payload to B2C Commerce Cloud Product attribute |
| createVariationMasterProductRequest | Prepare payload to assign variation for Master product |
| getProductByIdResponse | Maps B2C Commerce Cloud to CIM Product Payload |
| get-promotions | B2C Promotions Mapping |
| map-b2c-order-to-cim | B2C Order Mapping |
| put-cc-products | Maps Input payload to B2C Commerce Cloud Product |
| put-product-var-att | B2C Promotions Mapping |
createProductInventoryRequest
Maps Input payload to B2C Commerce Cloud Product Inventory
Source:
./src/main/resources/dwl/createProductInventoryRequest.dwl
Mapping Tables
Maps Input payload to B2C Commerce Cloud Product Inventory
| B2C | Input | Description |
|---|---|---|
| id | id | The id of the product |
| productId | id | The id of the product |
| locationType | PARTNER | The PARTNER by default |
| productName | name | The name of the product |
| locationId | inventory_m | The inventory_m by default |
| locationName | inventory_m | The inventory_m by default |
| quantityInStock | maximumOrderQuantityCount | The quantity count of the product |
createProductRequest
Maps Input payload to B2C Commerce Cloud Product
Source:
./src/main/resources/dwl/createProductRequest.dwl
Mapping Tables
Maps Input payload to B2C Commerce Cloud Product
| B2C | Input | Description |
|---|---|---|
| id | id | The id of the product |
| manufacturer_name | manufacturerName | The manufacturer's name of the product |
| manufacturer_sku | productSKU | The manufacturer's SKu of the product |
| name.default | name | The name of the product |
| brand | brand | The brand name of the product |
| short_description.markup | description | The short description of the product |
| short_description.source | description | The short description of the product |
| long_description.markup | longDescription | The long description of the product |
| long_description.source | longDescription | The long description of the product |
| upc | modelNumber | modelNumber of the Product |
| unit | maximumOrderQuantityCount | maximumOrderQuantityCount |
| unit.master.master_id | masterProduct | The masterProduct (applicable only to the 'variant' products) |
| master.link | url | hardcoded url (applicable only to the 'variant' products) |
| owning_catalog_id | primaryProductCategory.productCatalog.id | Owning Catalog Id |
| c_globalProductId | externalIds.externalId | MDM Id |
| online_flag.default | true | default value is true |
| searchable.default | true | default value is true |
createProductVariationValueResponse
Maps Input payload to B2C Commerce Cloud Product attribute
Source:
./src/main/resources/dwl/createProductVariationValueResponse.dwl
Mapping Tables
Maps Input payload to B2C Commerce Cloud Product attribute
| B2C | Input | Description |
|---|---|---|
| id | attributeDefinitionId | Id of the attribute |
| name | attributeDefinitionName | Name of the attribute |
| attributeValue | values.value | value of the attribute |
createVariationMasterProductRequest
Prepare payload to assign variation for Master product
Source:
./src/main/resources/dwl/createVariationMasterProductRequest.dwl
Mapping Tables
Maps Input payload to B2C Commerce Cloud Product
| B2C | Input | Description |
|---|---|---|
| defaultProductVariation | true | Default value is true |
| productId | id | The id of the product |
getProductByIdResponse
Maps B2C Commerce Cloud to CIM Product Payload
Source:
./src/main/resources/dwl/getProductByIdResponse.dwl
Mapping Tables
Maps B2C Commerce Cloud to CIM Product Payload
| CIM | B2C | Description | |
|---|---|---|---|
| id | id | The id of the product | |
| name | name | The name of the product | |
| longDescription | longDescription.default.source | The longDescription of the product | |
| description | shortDescription.default.source | The shortDescription of the product | |
| manufacturerName | manufacturer_name | The manufacturer's name of the product | |
| productSKU | manufacturer_sku | The product's SKu of the product | |
| validFromDate | creationDate | The Creation Date of the Product | |
| modelNumber | upc | upc of the Product | |
| maximumOrderQuantityCount | ats | unit of the product | |
| manufacturerName | manufacturer_name | The manufacturer's name of the product | |
| primaryProductCategory.productCatalog.id | owningCatalogId | product Catalog Id | |
| primaryProductCategory.productCatalog.name | owningCatalogName.default | product Catalog name | |
| primaryProductCategory.productCatalog.activeFromDate | creationDate | active from date | |
| externalSourceRecord | id | The product id | |
| mSRPAmount | price | mSRP Amount fo the product | |
| masterProduct | master.master_id | masterProduct Id of the Product variant | |
| brand | brand | Brand of the Product | |
| productAttributes.id | attributeDefinitionId | The product attribute id | |
| productAttributes.name | attributeDefinitionName.default | The product attribute name | |
| productAttributes.attributeValue | values.value | The product attribute value | |
| externalIds.id | c_globalProductId | The c_globalProductId value default | |
| externalIds.externalId | c_globalProductId | The c_globalProductId value default | |
| externalIds.externalIdType | MDM | Hardcoded as MDM | |
| externalIds.status | VALID | Hardocded as VALID | |
| auditInfo.createdDate | creationDate | created Date of the Product | |
| auditInfo.createdBy | rcg-b2c-commerce-sys-api | Hardcoded as rcg-b2c-commerce-sys-api | |
| auditInfo.updatedDate | lastModified | updated Date of the Product | |
| auditInfo.updatedBy | rcg-b2c-commerce-sys-api | Hardcoded as rcg-b2c-commerce-sys-api | |
| productCatalog.name | name.default | name of the catalog | |
| productCatalog.id | owningCatalogName.default | id of the catalog | |
| productCatalog.activeFromDate | activeFromDate | activeFromDate of the catalog | |
| productCategory.name | assignedCategories.categoryId | name of the category | |
| productCategory.id | assignedCategories.categoryId | id of the category | |
| productCategory.activeFromDate | activeFromDate | activeFromDate of the category |
get-promotions
B2C Promotions Mapping
Source:
./src/main/resources/dwl/get-promotions.dwl
Mapping Tables
Maps B2C Promotions to Promotions output format
| output | B2C | Description |
|---|---|---|
| promotionId | PromotionId | The id of the Promotion created for that campaign |
| promotionName | promotionName | The name of the promotion |
| customerProfile.customerId | CustomerId | The B2C customer Id |
| customerProfile.firstName | Firstname | The FirstName of the customer |
| customerProfile.lastName | LastName | The Lastname of the Customer |
| customerProfile.emailAddress | emailAddress | The Customer Email address |
map-b2c-order-to-cim
B2C Order Mapping
Source:
./src/main/resources/dwl/map-b2c-order-to-cim.dwl
Variables
var s
Maps B2C Orders to CIM Sales Order format
Mapping Tables
Maps B2C Orders to CIM Sales Order format
| CIM | B2C | Description |
|---|---|---|
| id | c_globalSalesOrderId | The id of the Sales Order |
| orderNumber | order_no | The order number of the Sales Order |
| grandTotalAmount | Customer | The total amount of the Sales Order |
| totalTaxAmount | merchandize_total_tax | The tax amount of the Sales Order |
| requestedStartDate | creation_date | The created date of Sales Order |
| salesOrderType | ORDER | The type of Sales Order |
| salesOrderStatus | status | The status of Sales Order |
| customer.id | customer_info.customer_no | The customer ID |
| partyType | Individual | The type of party hardcoded to 'Customer' |
| personName | customer_info.customer_name | The customer name |
| contactPoints.name | BillingAddress | The contact point name |
| contactPoints.contactPointType | ContactPointAddress | The type of contact point |
| contactPoints.addressLine1 | billing_address.address1 | Address 1 |
| contactPoints.addressLine2 | billing_address.address2 | Address 2 |
| contactPoints.cityName | billing_address.city | The city name |
| contactPoints.stateProvinceName | billing_address.state_code | The state code |
| contactPoints.countryName | billing_address.country_code | The country code |
| contactPoints.postalCodeText | billing_address.postal_code | The postal code |
| externalIds.externalId | order_no | The external Id |
| externalIds.externalIdType | SALESFORCE_B2C | The external Id type |
| auditInfo.createdDate | creation_date | The order created date |
| auditInfo.createdBy | created_by | The order created by |
| auditInfo.updatedDate | last_modified | The order last modified date |
| auditInfo.updatedBy | created_by | The order last modified by |
put-cc-products
Maps Input payload to B2C Commerce Cloud Product
Source:
./src/main/resources/dwl/put-cc-products.dwl
Mapping Tables
Maps Input payload to B2C Commerce Cloud Product
| B2C | Input | Description |
|---|---|---|
| id | id | The id of the product |
| manufacturer_name | manufacturerName | The manufacturer's name of the product |
| manufacturer_sku | productSKU | The manufacturer's SKu of the product |
| name.default | name | The name of the product |
| brand | brand | The brand name of the product |
| short_description.markup | description | The short description of the product |
| short_description.source | description | The short description of the product |
| long_description.markup | longDescription | The long description of the product |
| long_description.source | longDescription | The long description of the product |
| upc | modelNumber | modelNumber of the Product |
| unit | maximumOrderQuantityCount | maximumOrderQuantityCount |
| master.master_id | masterProduct | The masterProduct (applicable only to the 'variant' products) |
| master.link | url | hardcoded url (applicable only to the 'variant' products) |
| owning_catalog_id | primaryProductCategory.productCatalog.id | Owning Catalog Id |
| c_globalProductId | externalIds.externalId | MDM Id |
| online_flag.default | true | default value is true |
| c_availableForInStorePickup | true | Product default available for Instore pickup |
put-product-var-att
B2C Promotions Mapping
Source:
./src/main/resources/dwl/put-product-var-att.dwl
Mapping Tables
Maps Input payload to B2C Commerce Cloud Product Attribute
| B2C | Input | Description |
|---|---|---|
| attributeDefinitionId | productAttributes.id | The attributeDefinitionId id |
| id | id | The product attribute id |