getOrderPriceUE
The GetOrderPriceUE mappings allow for orders created in Sterling Order Management or Sterling Call Center to retrieve unit prices, promotion discounts, free gifts, and shipping promotion discount information from HCL Commerce.
getOrderPrice request mappings
These are the getOrderPrice request mappings:
| Sterling Order Management API path | HCL Commerce path |
|---|---|
| ORDER | |
| hardcode in transformation xslt (ProcessOrder/Calculate) | Process/ActionCriteria/ActionExpression@actionCode |
| Order/@OrderReference | Order/ OrderIdentifier/ExternalOrderID |
| Order/@OrderNo | Order/OrderIdentifier/UniqueID |
| Order/@BuyerUserID | Order/BuyerIdentifier/ExternalIdentifier/Identifier |
| Order/@Currency | Order/OrderAmount/TotalProductPrice/@Currency |
| Order/@CustomerId | |
| Order/@OrganizationCode | Order/StoreIdentifier/UniqueID Use the common attribute mapping file, ValueMaps.xml, to implement this mapping. |
| Order/@EnterpriseCode | |
| <PaymentMethod CheckReference="" CreditCardName="" CreditCardType="" CustomerAccountNo="" DisplayCustomerAccountNo="" DisplayPaymentReference1="" DisplaySvcNo="" PaymentReference1="" PaymentReference2="" PaymentReference3="" PaymentType="">, get the payment method as per the CreditCardName and payment type to get PaymentMethodName | Order/OrderPaymentInfo/PaymentInstructionType/PaymentMethod/PaymentMethodName Use the common attribute mapping file, ValueMaps.xml, to implement this mapping. If the mapping does not exist, the getOrderPrice request is used directly. |
| Order/@DocumentType | |
| Order/@PricingDate | Order/CalculationInfo/PricingDate |
| Order/@RunCatalogOnlyRules | These elements/attributes are not used in getOrderPrice. |
| Order/@SuggestManualRuleAdjustments | |
| Order/@SuppressRuleExecution | |
| Order/@SuppressShipping | |
| Order/SelectionCriteria/PersonInfo/@AddressLine1 | Shipping charge is not supported in current release; address mapping is canceled. |
| Order/SelectionCriteria/PersonInfo/@AddressLine2 | |
| Order/SelectionCriteria/PersonInfo/@AddressLine3 | |
| Order/SelectionCriteria/PersonInfo/@AddressLine4 | |
| Order/SelectionCriteria/PersonInfo/@AddressLine5 | |
| Order/SelectionCriteria/PersonInfo/@AddressLine6 | |
| Order/SelectionCriteria/PersonInfo/@AlternateEmailID | |
| Order/SelectionCriteria/PersonInfo/@Beeper | |
| Order/SelectionCriteria/PersonInfo/@City | |
| Order/SelectionCriteria/PersonInfo/@Company | |
| Order/SelectionCriteria/PersonInfo/@Country | |
| Order/SelectionCriteria/PersonInfo/@LastName | |
| Order/SelectionCriteria/PersonInfo/@MiddleName | |
| Order/SelectionCriteria/PersonInfo/@PersonID | |
| Order/SelectionCriteria/PersonInfo/@PreferredShippingAddress | |
| Order/SelectionCriteria/PersonInfo/@State | |
| Order/SelectionCriteria/PersonInfo/@TaxGeoCode | |
| Order/SelectionCriteria/PersonInfo/@ZipCode | |
| Passes in usageIds/ if for Sterling Order Management, only discount and shipping adjustment are supported in current release. Shipping charge is out of scope. | Order/CalculationInfo/Usage= -1,-7 |
| Hard code mapping in transformation file, since the price will be always updated default=AlwaysUpdate | Order/CalculationInfo/PriceUpdateFlag (NeverUpdate, AlwaysUpdate, UpdateIfExpired) |
| Order/ManualRuleAdjustments/ManualRuleAdjustment/@Adjustment | ManualRuleAdjustment is not supported in current release. |
| Order/ManualRuleAdjustments/ManualRuleAdjustment/@PricingRuleKey | |
| Order/ManualRuleAdjustments/ManualRuleAdjustment/@PricingRuleName | |
| Order/ManualAdjustments/ManualAdjustment/@Adjustment | Order/CalculationInfo/ExtraAdjustment/AdjustmentApplyAmount |
| Order/ ManualAdjustments/ ManualAdjustment/@AdjustmentID | Order/CalculationInfo/ExtraAdjustments/CalculationCodeIdentifier/UniqueID |
| Only fixed replacement is supported in current release; hardcode this mapping in transformation file. | Order/CalculationInfo/ExtraAdjustments/AdjustmentApplyPolicy (1) Fixed replacement |
| hardcode false | Order/CalculationInfo/ExtraAdjustment/IsOverrideExistingAdjustment |
| Order/Shipping/@CarrierServiceCode | Order/OrderShippingInfo/ShippingMode Use the common attribute mapping file, ValueMaps.xml, to implement this mapping. |
| Order/Shipping/Carrier | Order/OrderShippingInfo/Carrier |
| Order/Shipping/@MinimizeNumberOfShipments | (not used) |
| Order/Shipping/@ShippingCharge | Order/OrderShippingInfo/TotalShippingCharge |
| ORDER LINE/ORDER ITEM | |
| Order/OrderLines/OrderLine/Shipping/@CarrierServiceCode | Order/OrderItem/OrderItemShippingInfo/ShippingMode |
| Order/OrderLines/OrderLine/Shipping/Carrier | Order/OrderItem/OrderItemShippingInfo/Carrier |
| Order/OrderLines/OrderLine/Shipping/@ShippingCharge | Order/OrderItem/OrderItemShippingInfo/TotalShippingCharge |
| Order/OrderLines/OrderLine/@DeliveryMethod(shipment, pickup, delivery) | |
| Order/OrderLines/OrderLine/@EligibleForShippingDiscount | |
| Order/OrderLines/OrderLine/@IsLinePriceForInformationOnly | |
| Order/OrderLines/OrderLine/@IsPriceLocked | Order/OrderItem/OrderItemAmount/@priceOverride |
| Transform is done in transformation file of WebSphere Enterprise Service Bus; compose ItemIds to OrderItem's component using ParentLineId. | Order/OrderItem/OrderItemComponent |
| ItemID(partnumber) | Order/OrderItem/CatalogEntryIdentifier/UniqueID |
| Order/OrderLines/OrderLine/@ItemID | Order/OrderItem/CatalogEntryIdentifier/ExternalIdentifier/partnumber |
| Order/OrderLines/OrderLine/@LineID | Order/OrderItem/OrderItemIdentifier/ExternalOrderItemID |
| Order/OrderLines/OrderLine/@Quantity | Order/OrderItem/Quantity |
| Order/OrderLines/OrderLine/@UnitOfMeasure | Order/OrderItem/Quantity/@UOM Use the common attribute mapping file, ValueMaps.xml, to implement this mapping. |
| <Awards><Award AwardAmount="" AwardApplied="" AwardId="" AwardKey="" AwardType="" ChargeCategory="" ChargeName="" DenialReason="" Description="" IsPromotionOnOrder="" IsPromotionOnOrderLine="" PosReasonCode="" PromotionId="" PromotionKey=""/></Awards>: AwardType='FreeGift' to identify this award is a free gift, and use AwardAmount to calculate the free gift's quantity | Order/OrderItem/OrderItemAmount/@freegift |
| Order/OrderLines/OrderLine/@UnitPrice | Order/OrderItem/OrderItemAmount/UnitPrice |
| Order/OrderLines/OrderLine/ManualRuleAdjustments/ManualRuleAdjustment/@Adjustment | This is implemented by the WebSphere® Commerce price/promotion component. |
| Order/OrderLines/OrderLine/ManualRuleAdjustments/ManualRuleAdjustment/ @PricingRuleKey | |
| Order/OrderLines/OrderLine/ManualRuleAdjustments/ManualRuleAdjustment/@PricingRuleName | |
| Order/OrderLines/OrderLine/ManualAdjustments/ManualAdjustment/@AdjustmentID | Order/CalculationInfo/ExtraAdjustments/CalculationCodeIdentifier/UniqueID (1) -10: CSR order discount (2) -11: CSR order item discount (3)-12: CSR shipping adjustment |
| Order/OrderLines/OrderLine/ManualAdjustments/ManualAdjustment/@AdjustmentPerLine | Order/CalculationInfo/ExtraAdjustments/AdjustmentApplyAmount (AdjustmentPerUnit * Quantity + AdjustmentPerLine) |
| Order/OrderLines/OrderLine/ManualAdjustments/ManualAdjustment/@AdjustmentPerUnit | |
| Hard coded in WESB mapping; only fixed replacement type is used for Sterling Order Management. | Order/CalculationInfo/ExtraAdjustments/AdjustmentApplyPolicy (1)
Fixed adjustment (2) Percentage adjustment (3) Fixed replacement Note: Only
Fixed replacement is supported in the current release. |
| Done in transformation xslt. | Order/CalculationInfo/ExtraAdjustments/OrderItemIdentifier/UniqueID Order/CalculationInfo/ExtraAdjustments/OrderItemIdentifier/ExternalOrderItemID |
| Hard coded in WESB mapping; it is false | Order/CalculationInfo/IsOverrideExistingAdjustments |
| Order/Coupons/Coupon/@CouponID | Order/PromotionCode/Code |
getOrderPriceUE response mappings
These
are the getOrderPrice response mappings:
| HCL Commerce Path | Sterling Order Management API Path |
|---|---|
| ORDER | |
| Order/OrderAmount/TotalProductPrice/@Currency | Order/@Currency |
| Order/OrderIdentifier/UniqueID | Order/@OrderReference |
| Order/OrderIdentifier/externalOrderID | |
| Order/BuyerIdentifier/ExternalIdentifier/Identifier | Order/@BuyerUserId |
| Order/@EnterpriseCode | |
| Order/OrderAmount/TotalProductPrice | Order/@LinePriceTotal |
| Order/OrderAmount/TotalAdjustment | Order/@OrderAdjustment |
| Order/OrderAmount/GrandTotal | Order/@OrderTotal |
| Order/StoreIdentifier/UniqueID (ValueMaps.xml) | Order/@OrganizationCode |
| Use the same PricingDate as the request input. | Order/@PricingDate |
| (not used) | Order/@RunCategoryOnlyRules |
| totalproductPrice + order/item discount (not include shipping adjustment) | Order/@Subtotal |
| (not used) | Order/@SuggestManualRuleAdjustment |
| (not used) | Order/@SuppressExecution |
| (not used) | Order/@SuppressShipping |
| (not used) | Order/@ManualRuleAdjustments |
| (not used) | Order/@ApplicableManualRules |
| (not used) | Order/@ApplicableManualRuleSummary |
| CarrierServiceCode="" DistributeAdjustment="" EndDateActive="" IgnoreRuleOnManualAdjustment="" IgnoreRuleOnPriceLock="" IsCouponRule="" IsItemAttributeValueRule="" IsItemRule="" IsManualAdjustment="" IsManualRule="" ItemOperatorCode="" MinimizeNumberOfShipments="" OrganizationCode="" PricingRuleKey="" PricingRuleName="" PricingStatus="" RuleCategory="" RuleType="" StartDateActive="" | |
| Order/PromotionCode/Code | Order/Coupon/@CouponID |
| Order/PromotionCode/Reason/ReasonCode | Order/Coupon/@CouponStatusMsgCode |
| Order/PromotionCode/Reason/Valid | Order/Coupon/@Valid |
| Order/PricingDate | Order/@PricingDate |
| (No corresponding field in HCL Commerce.) | Order/Coupon/StatusAttribute/@Name |
| (No corresponding field in HCL Commerce.) | Order/Coupon/StatusAttribute/@Value |
| ORDER ITEM/ORDER LINE | |
| XXX, WC price component | Order/OrderLines/OrderLine/@AbsoluteAdjustment |
| Order/OrderLines/OrderLine/@DeliveryMethod | |
| (not used) | Order/OrderLines/OrderLine/@EligibleForShippingDiscount |
| (not used) | Order/OrderLines/OrderLine/@ExtendedPrice |
| (not used) | Order/OrderLines/OrderLine/@isLinePriceForInformationOnly |
| Use the same values as the request input. | Order/OrderLines/OrderLine/@isPriceLocked |
| Order/OrderItem/CatentryIdentifier/ExtendedIdentifier/partnumber | Order/OrderLines/OrderLine/@ItemID |
| Order/OrderItem/OrderItemAmount/Adjustment (sum of displayLevel = orderitem) | Order/OrderLines/OrderLine/@LineAdjustment |
| Order/OrderItem/OrderItemIdentifier/UniqueID | Order/OrderLines/OrderLine/@LineId |
| Order/OrderItem/OrderItemAmount/OrderItemPrice | Order/OrderLines/OrderLine/@LinePrice |
| Order/OrderItem/OrderItemAmount/(OrderItemPrice
+ totaladjustment + shipping charge Note: Shipping tax and
sales tax are not available in this release in getOrderPriceUE. |
Order/OrderLines/OrderLine/@LineTotal |
| Not used in HCL Commerce order; unit price is used. | Order/OrderLines/OrderLine/@ListPrice |
| Order/OrderItem/OrderItemAmount/Adjustment (sum of displaylevel = order) | Order/OrderLines/OrderLine/@OrderAdjustment |
| (not used) | Order/OrderLines/OrderLine/@PercentAdjustment |
| Order/OrderItem/Quantity | Order/OrderLines/OrderLine/@Quantity |
| ShippingCharge adjustment + surcharge Note: Shipping
surcharge is not supported in HCL Commerce; it is a normal
shipping charge. |
Order/OrderLines/OrderLine/@ShippingAdjustment |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount (sum of usage =-7 and amount <0, usage =-7 is shipping adjustment) | Order/OrderLines/OrderLine/@ShippingChargeAdjustment |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount (sum of usage =-7 and amount>0, usage =-7 is shipping adjustment) | Order/OrderLines/OrderLine/@ShippingSurcharge |
| Order/OrderItem/Quantity/UOM | Order/OrderLines/OrderLine/@UnitofMeasure |
| Order/OrderItem/OrderItemAmount/UnitPrice | Order/OrderLines/OrderLine/@UnitPrice |
| (not used) | Order/OrderLines/OrderLine/@ManualRuleAdjustments |
| (not used) | Order/OrderLines/OrderLine/@ApplicablesManualRules |
| ORDER ITEM/ORDER LINE - Line Adjustments | |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount (usageId -1 discount, displaylevel = orderitem) | Order/OrderLines/OrderLine/LineAdjustments/Adjustment/@AdjustmentApplied |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount (usageId -1 discount, displaylevel = orderitem) | Order/OrderLines/OrderLine/LineAdjustments/Adjustment/@AdjustmentAvailable |
| Order/OrderItem/OrderItemAmount/Adjustment/Code (usage=-1 discount, displaylevel = orderitem) | Order/OrderLines/OrderLine/LineAdjustments/Adjustment/@AdjustmentID |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount SUM (usageId -1 discount, displaylevel = orderitem) | Order/OrderLines/OrderLine/LineAdjustments/Adjustment/@AdjustmentPerLine |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount SUM/Quantity (usageId -1 discount, displaylevel = orderitem) | Order/OrderLines/OrderLine/LineAdjustments/Adjustment/@AdjustmentPerUnit |
| (not used) | Order/OrderLines/OrderLine/LineAdjustments/Adjustment/@CarrierServiceCode |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount/Currency | Order/OrderLines/OrderLine/LineAdjustments/@Adjustment/Currency |
| Order/OrderItem/OrderItemAmount/Adjustment/Description | Order/OrderLines/OrderLine/LineAdjustment/@Adjustment/Description |
| Order/OrderItem/OrderItemAmount/Adjustment/CalculationCodeIdentifier | Order/OrderLines/OrderLine/LineAdjustment/Adjustment/@PricingRuleName |
| default value = true, in WC, we always distribute the adjustments | Order/OrderLines/OrderLine/LineAdjustment/Adjustment/@DistributeAdjustment |
| If this item is a free gift, we will mark this adjustment's RuleCategory is FreeGift | Order/OrderLines/OrderLine/LineAdjustment/@Adjustment/RuleCategory |
| (not used) | CarrierServiceCode="" EndDateActive="" IgnoreRuleOnManualAdjustment="" IgnoreRuleOnPriceLock="" IsCouponRule="" IsItemAttributeValueRule="" IsItemRule="" IsManualAdjustment="" IsManualRule="" ItemOperatorCode="" MinimizeNumberOfShipments="" OrganizationCode="" PricingRuleKey="" PricingRuleName="" PricingStatus="" RuleCategory="" RuleType="" StartDateActive="" |
| Order/OrderItem/OrderItemAmount/Adjustment/CalculationCodeIdentifier | Order/OrderLines/OrderLine/LineAdjustments/Adjustment/AdjustmentAction/@ChargeName |
| Order/OrderItem/OrderItemAmount/Adjustment/CalculationCodeIdentifier | Order/OrderLines/OrderLine/ LineAdjustments/Adjustment/Coupon/@CouponID (if this adjustment is coupon required) |
| ORDER ITEM/ORDER LINE - Shipping Adjustments | |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount (usageId -7 shipping adjustment, displaylevel = orderitem) | Order/OrderLines/OrderLine/ShippingAdjustments/Adjustment/@AdjustmentApplied |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount (usageId -7 shipping adjustment, displaylevel = orderitem) | Order/OrderLines/OrderLine/ShippingAdjustments/Adjustment/@AdjustmentAvailable |
| Order/OrderItem/OrderItemAmount/Adjustment/Code (usage=-7 shipping adjustment, displaylevel = orderitem) | Order/OrderLines/OrderLine/ShippingAdjustments/Adjustment/@AdjustmentID |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount SUM of the amount (usageId -7shipping adjustment, displaylevel = orderitem) | Order/OrderLines/OrderLine/ShippingAdjustments/Adjustment/@AdjustmentPerLine |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount SUM of the amount/ Quantity (usageId -7 shipping adjustment, displaylevel = orderitem) | Order/OrderLines/OrderLine/ShippingAdjustments/Adjustment/@AdjustmentPerUnit |
| (not used) | Order/OrderLines/OrderLine/ShippingAdjustments/Adjustment/@CarrierServiceCode |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount/Currency | Order/OrderLines/OrderLine/ShippingAdjustments/Adjustment/@Currency |
| Order/OrderItem/OrderItemAmount/Adjustment/Description | Order/OrderLines/OrderLine/ShippingAdjustments/Adjustment/@Description |
| Order/OrderItem/OrderItemAmount/Adjustment/CalculationCodeIdentifier | Order/OrderLines/OrderLine/ShippingAdjustments/Adjustment/@PricingRuleName |
| default value = true; in HCL Commerce, adjustments are always distributed. | Order/OrderLines/OrderLine/ShippingAdjustments/Adjustment/@DistributeAdjustment |
| (not used) | CarrierServiceCode="" EndDateActive="" IgnoreRuleOnManualAdjustment="" IgnoreRuleOnPriceLock="" IsCouponRule="" IsItemAttributeValueRule="" IsItemRule="" IsManualAdjustment="" IsManualRule="" ItemOperatorCode="" MinimizeNumberOfShipments="" OrganizationCode="" PricingRuleKey="" PricingRuleName="" PricingStatus="" RuleCategory="" RuleType="" StartDateActive="" |
| Order/OrderItem/OrderItemAmount/Adjustment/CalculationCodeIdentifier | Order/OrderLines/OrderLine/ShippingAdjustments/Adjustment/AdjustmentAction/@ChargeName |
| Order/OrderItem/OrderItemAmount/Adjustment/CalculationCodeIdentifier | Order/OrderLines/OrderLine/Shipping/Adjustments/Adjustment/Coupon/@CouponID ( if this adjustment is coupon required) |
| ORDER ITEM/ORDER LINE - Order Adjustments | |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount (usageId -1, displaylevel = order) | Order/OrderLines/OrderLine/OrderAdjustments/Adjustment/@AdjustmentApplied |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount (usageId -1, displaylevel = order) | Order/OrderLines/OrderLine/OrderAdjustments/Adjustment/@AdjustmentAvailable |
| Order/OrderItem/OrderItemAmount/Adjustment/Code (usage=-1, displaylevel = order) | Order/OrderLines/OrderLine/OrderAdjustments/Adjustment/@AdjustmentID |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount SUM (usageId -1, displaylevel = order) | Order/OrderLines/OrderLine/OrderAdjustments/Adjustment/@AdjustmentPerLine |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount SUM/Quantity (usageId -1, displaylevel = order) | Order/OrderLines/OrderLine/OrderAdjustments/Adjustment/@AdjustmentPerUnit |
| (not used) | Order/OrderLines/OrderLine/OrderAdjustments/Adjustment/@CarrierServiceCode |
| Order/OrderItem/OrderItemAmount/Adjustment/Amount/Currency | Order/OrderLines/OrderLine/OrderAdjustments/@Adjustment/Currency |
| Order/OrderItem/OrderItemAmount/Adjustment/Description | Order/OrderLines/OrderLine/OrderAdjustments/@Adjustment/Description |
| Order/OrderItem/OrderItemAmount/Adjustment/CalculationCodeIdentifier | Order/OrderLines/OrderLine/OrderAdjustments/Adjustment/@PricingRuleName |
| default value = true; in WebSphere® Commerce, adjustments are always distributed | Order/OrderLines/OrderLine/OrderAdjustments/Adjustment/@DistributeAdjustment |
| If this item is a free gift, this adjustment's RuleCategory is marked as FreeGift. | Order/OrderLines/OrderLine/OrderAdjustments/Adjustment/@RuleCategory |
| (not used) | CarrierServiceCode="" EndDateActive="" IgnoreRuleOnManualAdjustment="" IgnoreRuleOnPriceLock="" IsCouponRule="" IsItemAttributeValueRule="" IsItemRule="" IsManualAdjustment="" IsManualRule="" ItemOperatorCode="" MinimizeNumberOfShipments="" OrganizationCode="" PricingRuleKey="" PricingRuleName="" PricingStatus="" RuleCategory="" RuleType="" StartDateActive="" |
| Order/OrderItem/OrderItemAmount/Adjustment/CalculationCodeIdentifier | Order/OrderLines/OrderLine/OrderAdjustments/Adjustment/AdjustmentAction/@ChargeName |
| Order/OrderItem/OrderItemAmount/Adjustment/CalculationCodeIdentifier | Order/OrderLines/OrderLine/OrderAdjustments/Adjustment/Coupon/@CouponID (if this adjustment is coupon required) |
| SHIPPING | |
| Order/OrderAmount/TotalShippingCharge + shipping adjustment | Order/Shipping/@AdjustedShippingTotal |
| Order/OrderShippingInfo/ShippingMode | Order/Shipping/@CarrierServiceCode |
| (not used) | Order/Shipping/@MinimizeNumberOfShipments |
| shippingchargeadjustment+shipping surcharge | Order/Shipping/@ShippingAdjustment |
| Order/OrderAmount/TotalShippingCharge | Order/Shipping/@ShippingCharge |
| Order/OrderAmount/Adjustment/Amount sum of usageId =-7 and value<0 | Order/Shipping/@ShippingChargeAdjustment |
| Order/OrderAmount/Adjustment/Amount sum of usageId =-7 and value>0 | Order/Shipping/@ShippingSurcharge |
Note: Calculation usages: -1: discount (including free
gift) -7: shipping adjustment