MFG PIM 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 |
---|---|
products-getbyid-payload | Products select Mapping for PIM System |
products-get-payload | Products select Mapping for PIM System |
products-patchbyid-payload | Products Upsert Mapping for PIM System |
products-upsert-pricebooks-payload | PriceBookEntry Upsert Mapping for PIM System |
products-upsert-productcategorycatalog-payload | Product Category and Product Catalog - Upsert Mapping for PIM System |
products-upsert-products-payload | Products Upsert Mapping for PIM System |
products-getbyid-payload
Products select Mapping for PIM System
Source:
./src/main/resources/dwl/products-getbyid-payload.dwl
Mapping Tables
Maps CIM Product to JSON which is used by stored procedure - sp_Products_Upsert
JSON used by the stored procedure | CIM | Description |
---|---|---|
allowCustomerReturn | allowCustomerReturn | flag to allow customer to return a Product |
allowPartialRefund | allowPartialRefund | flag to allow partial refund for a Product |
brand | brand | brand grade of a Product |
brandGrade | brandGrade | brand grade of a Product |
canUseQuantitySchedule | canUseQuantitySchedule | flag for quantity schedule |
canUseRevenueSchedule | canUseRevenueSchedule | flag for revenue schedule |
description | description | description of the Product |
displayUrl | displayUrl | display URL of the Product |
disposalType | disposalType | disposal type of the Product |
externalSourceRecord | externalSourceRecord | external source record of the Product |
glAccountCode | glAccountCode | GL Account Code of the Product |
id | id | unique Id of the Product |
isAutoProvisionable | isAutoProvisionable | flag for auto provisioning |
isBackOrdered | isBackOrdered | flag for back ordered Product |
isCouponRedemptionAllowed | isCouponRedemptionAllowed | flag to allow redemption of coupon |
isCustomerDiscountAllowed | isCustomerDiscountAllowed | flag to allow customer discount on the Product |
isDynamicBundle | isDynamicBundle | flag to highlight if a Product is part of a dynamic bundle |
isFoodstampPaymentAllowed | isFoodstampPaymentAllowed | flag to allow food stamp payment |
isInstallable | isInstallable | flag to install a Product |
isIntellectualPropertyProtected | isIntellectualPropertyProtected | flag to protect the Product as intellectual property |
isManualPriceEntryRequired | isManualPriceEntryRequired | flag to enter the price of Product manually |
isMultipleCouponsAllowed | isMultipleCouponsAllowed | flag to allow multiple coupons on the Product |
isPartnerDiscountAllowed | isPartnerDiscountAllowed | flag to allow partner discounts |
isPreOrderable | isPreOrderable | flag to preorder the Product |
isQualityVerificationRequired | isQualityVerificationRequired | flag to mandate verification of quality of the Product |
isQuantityEntryRequired | isQuantityEntryRequired | flag to mandate entry of quantity |
isRainCheckAllowed | isRainCheckAllowed | flag to allow rain check |
isReturnable | isReturnable | flag to allow returning of Product |
isSellable | isSellable | flag allow a Product to be sold |
isSellableIndependently | isSellableIndependently | flag to allow a Product to be sold independently |
isSellableWithoutPrice | isSellableWithoutPrice | flag to allow a Product to be sold independently |
isSerialized | isSerialized | flag to serialize a Product |
isWeightEntryRequired | isWeightEntryRequired | flag to enter weight of the Product |
isWorkerDiscountAllowed | isWorkerDiscountAllowed | flag to allow discount for workers |
longDescription | longDescription | long description of the Product |
lotIdentity | lotIdentity | lot to identify the Product |
manufacturerName | manufacturerName | manufacturer name of the Product |
masterProduct | masterProduct | master Product of the Product |
maximumOrderQuantityCount | maximumOrderQuantityCount | max. quantity that can be ordered of that Product |
minimumAdvertisementAmount | minimumAdvertisementAmount | min. amount of advertisement of the Product |
minimumAdvertisementAmountStartDate | minimumAdvertisementAmountStartDate | min. amount to start advertisement of the Product |
minimumOrderQuantityCount | minimumOrderQuantityCount | min. amount of advertisement of the Product |
modelNumber | modelNumber | model number of the Product |
modelYear | modelYear | model year of the Product |
mSRPAmount | mSRPAmount | MSRP amount of the Product |
name | name | name of the Product |
priceChargeType | priceChargeType | price change type of the Product |
primaryProductCategory | primaryProductCategory | primary category of the Product |
primarySalesChannel | primarySalesChannel | primary sales channel for the Product |
productSKU | productSKU | SKU of the Product |
productStatus | productStatus | status of the Product |
quantityInstallmentCount | quantityInstallmentCount | quantity installment count of the Product |
quantityInstallmentPeriod | quantityInstallmentPeriod | quantity installment period of the Product |
quantityScheduleType | quantityScheduleType | quantity schedule type of the Product |
requiredDepositAmount | requiredDepositAmount | requested deposit amount for the Product |
requiredDepositPercentage | requiredDepositPercentage | requested deposit percentage for the Product |
requiresInvididualUnitPricing | requiresInvididualUnitPricing | flag to highlight that the Product requires individual unit pricing |
revenueInstallmentCount | revenueInstallmentCount | revenue installment count of the Product |
revenueInstallmentPeriod | revenueInstallmentPeriod | revenue installment period of the Product |
revenueScheduleType | revenueScheduleType | revenue schedule type of the Product |
rewardProgramPointsCount | rewardProgramPointsCount | reward program points count of the Product |
standardWarrantyLengthMonth | standardWarrantyLengthMonth | standard warranty length of the Product in months |
stockLedgerValuationAmount | stockLedgerValuationAmount | stock ledger valuation amount of the Product |
type | type | type of Product |
validForPeriodCount | validForPeriodCount | valid for period count of the Product |
validFromDate | validFromDate | valid from date of the Product |
validToDate | validToDate | valid to date of the Product |
versionNumber | versionNumber | version number of the Product |
productCategory.id | productCategory.id | unique Id of the Product Category |
productCategory.name | productCategory.name | name of the Product Category |
productCategory.activeFromDate | productCategory.activeFromDate | activeFromDate of a Product Category |
productCategory.activeToDate | productCategory.activeToDate | activeToDate of the Product Category |
productCatalog.id | productCatalog.id | unique Id of the Product Catalog |
productCatalog.name | productCatalog.name | name of the Product Catalog |
productCatalog.activeFromDate | productCatalog.activeFromDate | activeFromDate of a Product Catalog |
productCatalog.activeToDate | productCatalog.activeToDate | activeToDate of the Product Catalog |
priceBookEntry.id | id | unique Id of the PriceBookEntry |
priceBookEntry.isActive | isActive | status of the PriceBookEntry |
priceBookEntry.minRequiredQuantity | minRequiredQuantity | minimum required quantity for the product |
priceBookEntry.minRequiredOrderValue | minRequiredOrderValue | minimum required order value for the product |
priceBookEntry.maxRequiredOrderValue | maxRequiredOrderValue | maximum required order value for the product |
priceBookEntry.servicePeriodCount | servicePeriodCount | service period count for the product |
priceBookEntry.unitListPrice | unitListPrice | price of the product within the priceBookEntry |
priceBookEntry.useStandardPrice | useStandardPrice | Whether the price book entry inherits its price from the standard price book |
auditInfo.createdBy | createdBy | Identifies the system or user which created the entry |
auditInfo.updatedBy | UpdatedBy | Identifies the system or user which last updated the entry |
auditInfo.createdDate | createdDate | Identifies the created Time stamp of this entry |
auditInfo.updatedDate | UpdatedDate | Identifies the updated Time stamp of this entry |
externalIds.id | externalId.id | Identifies the id for externalId |
externalIds.externalId | externalId.externalId | Identifies the externalId for the ExternalId type |
externalIds.externalIdType | externalId.externalIdType | Identifies the externalID type |
externalIds.status | externalId.status | Whether the External Id status is Valid |
products-get-payload
Products select Mapping for PIM System
Source:
./src/main/resources/dwl/products-get-payload.dwl
Mapping Tables
Maps CIM Product to JSON which is used by stored procedure - sp_Products_Upsert
JSON used by the stored procedure | CIM | Description |
---|---|---|
allowCustomerReturn | allowCustomerReturn | flag to allow customer to return a Product |
allowPartialRefund | allowPartialRefund | flag to allow partial refund for a Product |
brand | brand | brand grade of a Product |
brandGrade | brandGrade | brand grade of a Product |
canUseQuantitySchedule | canUseQuantitySchedule | flag for quantity schedule |
canUseRevenueSchedule | canUseRevenueSchedule | flag for revenue schedule |
description | description | description of the Product |
displayUrl | displayUrl | display URL of the Product |
disposalType | disposalType | disposal type of the Product |
externalSourceRecord | externalSourceRecord | external source record of the Product |
glAccountCode | glAccountCode | GL Account Code of the Product |
id | id | unique Id of the Product |
isAutoProvisionable | isAutoProvisionable | flag for auto provisioning |
isBackOrdered | isBackOrdered | flag for back ordered Product |
isCouponRedemptionAllowed | isCouponRedemptionAllowed | flag to allow redemption of coupon |
isCustomerDiscountAllowed | isCustomerDiscountAllowed | flag to allow customer discount on the Product |
isDynamicBundle | isDynamicBundle | flag to highlight if a Product is part of a dynamic bundle |
isFoodstampPaymentAllowed | isFoodstampPaymentAllowed | flag to allow food stamp payment |
isInstallable | isInstallable | flag to install a Product |
isIntellectualPropertyProtected | isIntellectualPropertyProtected | flag to protect the Product as intellectual property |
isManualPriceEntryRequired | isManualPriceEntryRequired | flag to enter the price of Product manually |
isMultipleCouponsAllowed | isMultipleCouponsAllowed | flag to allow multiple coupons on the Product |
isPartnerDiscountAllowed | isPartnerDiscountAllowed | flag to allow partner discounts |
isPreOrderable | isPreOrderable | flag to preorder the Product |
isQualityVerificationRequired | isQualityVerificationRequired | flag to mandate verification of quality of the Product |
isQuantityEntryRequired | isQuantityEntryRequired | flag to mandate entry of quantity |
isRainCheckAllowed | isRainCheckAllowed | flag to allow rain check |
isReturnable | isReturnable | flag to allow returning of Product |
isSellable | isSellable | flag allow a Product to be sold |
isSellableIndependently | isSellableIndependently | flag to allow a Product to be sold independently |
isSellableWithoutPrice | isSellableWithoutPrice | flag to allow a Product to be sold independently |
isSerialized | isSerialized | flag to serialize a Product |
isWeightEntryRequired | isWeightEntryRequired | flag to enter weight of the Product |
isWorkerDiscountAllowed | isWorkerDiscountAllowed | flag to allow discount for workers |
longDescription | longDescription | long description of the Product |
lotIdentity | lotIdentity | lot to identify the Product |
manufacturerName | manufacturerName | manufacturer name of the Product |
masterProduct | masterProduct | master Product of the Product |
maximumOrderQuantityCount | maximumOrderQuantityCount | max. quantity that can be ordered of that Product |
minimumAdvertisementAmount | minimumAdvertisementAmount | min. amount of advertisement of the Product |
minimumAdvertisementAmountStartDate | minimumAdvertisementAmountStartDate | min. amount to start advertisement of the Product |
minimumOrderQuantityCount | minimumOrderQuantityCount | min. amount of advertisement of the Product |
modelNumber | modelNumber | model number of the Product |
modelYear | modelYear | model year of the Product |
mSRPAmount | mSRPAmount | MSRP amount of the Product |
name | name | name of the Product |
priceChargeType | priceChargeType | price change type of the Product |
primaryProductCategory | primaryProductCategory | primary category of the Product |
primarySalesChannel | primarySalesChannel | primary sales channel for the Product |
productSKU | productSKU | SKU of the Product |
productStatus | productStatus | status of the Product |
quantityInstallmentCount | quantityInstallmentCount | quantity installment count of the Product |
quantityInstallmentPeriod | quantityInstallmentPeriod | quantity installment period of the Product |
quantityScheduleType | quantityScheduleType | quantity schedule type of the Product |
requiredDepositAmount | requiredDepositAmount | requested deposit amount for the Product |
requiredDepositPercentage | requiredDepositPercentage | requested deposit percentage for the Product |
requiresInvididualUnitPricing | requiresInvididualUnitPricing | flag to highlight that the Product requires individual unit pricing |
revenueInstallmentCount | revenueInstallmentCount | revenue installment count of the Product |
revenueInstallmentPeriod | revenueInstallmentPeriod | revenue installment period of the Product |
revenueScheduleType | revenueScheduleType | revenue schedule type of the Product |
rewardProgramPointsCount | rewardProgramPointsCount | reward program points count of the Product |
standardWarrantyLengthMonth | standardWarrantyLengthMonth | standard warranty length of the Product in months |
stockLedgerValuationAmount | stockLedgerValuationAmount | stock ledger valuation amount of the Product |
type | type | type of Product |
validForPeriodCount | validForPeriodCount | valid for period count of the Product |
validFromDate | validFromDate | valid from date of the Product |
validToDate | validToDate | valid to date of the Product |
versionNumber | versionNumber | version number of the Product |
productCategory.id | productCategory.id | unique Id of the Product Category |
productCategory.name | productCategory.name | name of the Product Category |
productCategory.activeFromDate | productCategory.activeFromDate | activeFromDate of a Product Category |
productCategory.activeToDate | productCategory.activeToDate | activeToDate of the Product Category |
productCatalog.id | productCatalog.id | unique Id of the Product Catalog |
productCatalog.name | productCatalog.name | name of the Product Catalog |
productCatalog.activeFromDate | productCatalog.activeFromDate | activeFromDate of a Product Catalog |
productCatalog.activeToDate | productCatalog.activeToDate | activeToDate of the Product Catalog |
priceBookEntry.id | id | unique Id of the PriceBookEntry |
priceBookEntry.isActive | isActive | status of the PriceBookEntry |
priceBookEntry.minRequiredQuantity | minRequiredQuantity | minimum required quantity for the product |
priceBookEntry.minRequiredOrderValue | minRequiredOrderValue | minimum required order value for the product |
priceBookEntry.maxRequiredOrderValue | maxRequiredOrderValue | maximum required order value for the product |
priceBookEntry.servicePeriodCount | servicePeriodCount | service period count for the product |
priceBookEntry.unitListPrice | unitListPrice | price of the product within the priceBookEntry |
priceBookEntry.useStandardPrice | useStandardPrice | Whether the price book entry inherits its price from the standard price book |
auditInfo.createdBy | createdBy | Identifies the system or user which created the entry |
auditInfo.updatedBy | UpdatedBy | Identifies the system or user which last updated the entry |
auditInfo.createdDate | createdDate | Identifies the created Time stamp of this entry |
auditInfo.updatedDate | UpdatedDate | Identifies the updated Time stamp of this entry |
externalIds.id | externalId.id | Identifies the id for externalId |
externalIds.externalId | externalId.externalId | Identifies the externalId for the ExternalId type |
externalIds.externalIdType | externalId.externalIdType | Identifies the externalID type |
externalIds.status | externalId.status | Whether the External Id status is Valid |
products-patchbyid-payload
Products Upsert Mapping for PIM System
Source:
./src/main/resources/dwl/products-patchbyid-payload.dwl
Mapping Tables
Maps CIM Product to JSON which is used by stored procedure - sp_ExternalIds_Create
JSON used by the stored procedure | CIM | Description |
---|---|---|
id | externalIds.id | The id of the entry in MDM system |
externalId | externalIds.externalId | A unique identifier assigned to the individual in another system |
externalIdType | externalIds.externalIdType | Identifies the system that owns or otherwise recognizes this unique identifier |
status | externalIds.status | Indicates whether this identifier is currently valid or not |
statusLastChangedDate | externalIds.statusLastChangedDate | Date and time of the last change in status |
createdBy | application name from properties | Identifies the system or user which created the entry |
updatedBy | application name from properties | Identifies the system or user which last updated the entry |
productId | id | unique id of the product |
products-upsert-pricebooks-payload
PriceBookEntry Upsert Mapping for PIM System
Source:
./src/main/resources/dwl/products-upsert-pricebooks-payload.dwl
Mapping Tables
Maps CIM PriceBookEntry to JSON which is used by stored procedure - sp_PriceBookEntry_upsert
JSON used by the stored procedure | CIM | Description |
---|---|---|
id | priceBookEntry.id | unique Id of the PriceBookEntry |
isActive | priceBookEntry.isActive | status of the PriceBookEntry |
minRequiredQuantity | priceBookEntry.minRequiredQuantity | minimum required quantity for the product |
minRequiredOrderValue | priceBookEntry.minRequiredOrderValue | minimum required order value for the product |
maxRequiredOrderValue | priceBookEntry.maxRequiredOrderValue | maximum required order value for the product |
productId | id | unique Id of the Product |
servicePeriodCount | priceBookEntry.servicePeriodCount | service period count for the product |
unitListPrice | priceBookEntry.unitListPrice | price of the product within the priceBookEntry |
useStandardPrice | priceBookEntry.useStandardPrice | Whether the price book entry inherits its price from the standard price book |
createdBy | application name from properties | Identifies the system or user which created the entry |
updatedBy | application name from properties | Identifies the system or user which last updated the entry |
products-upsert-productcategorycatalog-payload
Product Category and Product Catalog - Upsert Mapping for PIM System
Source:
./src/main/resources/dwl/products-upsert-productcategorycatalog-payload.dwl
Mapping Tables
Maps CIM Product Category and Catalog to JSON which is used by stored procedure - sp_ProductCategoryCatalog_upsert
JSON used by the stored procedure | CIM | Description |
---|---|---|
id | productCategory.id | unique Id of the Product Category |
name | productCategory.name | name of the Product Category |
activeFromDate | productCategory.activeFromDate | activeFromDate of a Product Category |
activeToDate | productCategory.activeToDate | activeToDate of the Product Category |
createdBy | application name from properties | Identifies the system or user which created the entry |
updatedBy | application name from properties | Identifies the system or user which last updated the entry |
productCatalog.id | productCatalog.id | unique Id of the Product Catalog |
productCatalog.name | productCatalog.name | name of the Product Catalog |
productCatalog.activeFromDate | productCatalog.activeFromDate | activeFromDate of a Product Catalog |
productCatalog.activeToDate | productCatalog.activeToDate | activeToDate of the Product Catalog |
createdBy | application name from properties | Identifies the system or user which created the entry |
updatedBy | application name from properties | Identifies the system or user which last updated the entry |
productId | id | unique Id of the Product |
products-upsert-products-payload
Products Upsert Mapping for PIM System
Source:
./src/main/resources/dwl/products-upsert-products-payload.dwl
Mapping Tables
Maps CIM Product to JSON which is used by stored procedure - sp_Products_Upsert
JSON used by the stored procedure | CIM | Description |
---|---|---|
allowCustomerReturn | allowCustomerReturn | flag to allow customer to return a Product |
allowPartialRefund | allowPartialRefund | flag to allow partial refund for a Product |
brand | brand | brand grade of a Product |
brandGrade | brandGrade | brand grade of a Product |
canUseQuantitySchedule | canUseQuantitySchedule | flag for quantity schedule |
canUseRevenueSchedule | canUseRevenueSchedule | flag for revenue schedule |
description | description | description of the Product |
displayUrl | displayUrl | display URL of the Product |
disposalType | disposalType | disposal type of the Product |
externalSourceRecord | externalSourceRecord | external source record of the Product |
glAccountCode | glAccountCode | GL Account Code of the Product |
id | id | unique Id of the Product |
isAutoProvisionable | isAutoProvisionable | flag for auto provisioning |
isBackOrdered | isBackOrdered | flag for back ordered Product |
isCouponRedemptionAllowed | isCouponRedemptionAllowed | flag to allow redemption of coupon |
isCustomerDiscountAllowed | isCustomerDiscountAllowed | flag to allow customer discount on the Product |
isDynamicBundle | isDynamicBundle | flag to highlight if a Product is part of a dynamic bundle |
isFoodstampPaymentAllowed | isFoodstampPaymentAllowed | flag to allow food stamp payment |
isInstallable | isInstallable | flag to install a Product |
isIntellectualPropertyProtected | isIntellectualPropertyProtected | flag to protect the Product as intellectual property |
isManualPriceEntryRequired | isManualPriceEntryRequired | flag to enter the price of Product manually |
isMultipleCouponsAllowed | isMultipleCouponsAllowed | flag to allow multiple coupons on the Product |
isPartnerDiscountAllowed | isPartnerDiscountAllowed | flag to allow partner discounts |
isPreOrderable | isPreOrderable | flag to preorder the Product |
isQualityVerificationRequired | isQualityVerificationRequired | flag to mandate verification of quality of the Product |
isQuantityEntryRequired | isQuantityEntryRequired | flag to mandate entry of quantity |
isRainCheckAllowed | isRainCheckAllowed | flag to allow rain check |
isReturnable | isReturnable | flag to allow returning of Product |
isSellable | isSellable | flag allow a Product to be sold |
isSellableIndependently | isSellableIndependently | flag to allow a Product to be sold independently |
isSellableWithoutPrice | isSellableWithoutPrice | flag to allow a Product to be sold independently |
isSerialized | isSerialized | flag to serialize a Product |
isWeightEntryRequired | isWeightEntryRequired | flag to enter weight of the Product |
isWorkerDiscountAllowed | isWorkerDiscountAllowed | flag to allow discount for workers |
longDescription | longDescription | long description of the Product |
lotIdentity | lotIdentity | lot to identify the Product |
manufacturerName | manufacturerName | manufacturer name of the Product |
masterProduct | masterProduct | master Product of the Product |
maximumOrderQuantityCount | maximumOrderQuantityCount | max. quantity that can be ordered of that Product |
minimumAdvertisementAmount | minimumAdvertisementAmount | min. amount of advertisement of the Product |
minimumAdvertisementAmountStartDate | minimumAdvertisementAmountStartDate | min. amount to start advertisement of the Product |
minimumOrderQuantityCount | minimumOrderQuantityCount | min. amount of advertisement of the Product |
modelNumber | modelNumber | model number of the Product |
modelYear | modelYear | model year of the Product |
mSRPAmount | mSRPAmount | MSRP amount of the Product |
name | name | name of the Product |
priceChargeType | priceChargeType | price change type of the Product |
primaryProductCategory | primaryProductCategory | primary category of the Product |
primarySalesChannel | primarySalesChannel | primary sales channel for the Product |
productSKU | productSKU | SKU of the Product |
productStatus | productStatus | status of the Product |
quantityInstallmentCount | quantityInstallmentCount | quantity installment count of the Product |
quantityInstallmentPeriod | quantityInstallmentPeriod | quantity installment period of the Product |
quantityScheduleType | quantityScheduleType | quantity schedule type of the Product |
requiredDepositAmount | requiredDepositAmount | requested deposit amount for the Product |
requiredDepositPercentage | requiredDepositPercentage | requested deposit percentage for the Product |
requiresInvididualUnitPricing | requiresInvididualUnitPricing | flag to highlight that the Product requires individual unit pricing |
revenueInstallmentCount | revenueInstallmentCount | revenue installment count of the Product |
revenueInstallmentPeriod | revenueInstallmentPeriod | revenue installment period of the Product |
revenueScheduleType | revenueScheduleType | revenue schedule type of the Product |
rewardProgramPointsCount | rewardProgramPointsCount | reward program points count of the Product |
standardWarrantyLengthMonth | standardWarrantyLengthMonth | standard warranty length of the Product in months |
stockLedgerValuationAmount | stockLedgerValuationAmount | stock ledger valuation amount of the Product |
type | type | type of Product |
validForPeriodCount | validForPeriodCount | valid for period count of the Product |
validFromDate | validFromDate | valid from date of the Product |
validToDate | validToDate | valid to date of the Product |
versionNumber | versionNumber | version number of the Product |
externalIds | vars.customerExternalIds | The externalIds of the product that are stored in MDM |
createdBy | application name from properties | Identifies the system or user which created the entry |
updatedBy | application name from properties | Identifies the system or user which last updated the entry |