getCompleteOrderDetails

The getCompleteOrderDetails communication maps historical order information between Sterling Order Management and HCL Commerce. When a shopper wants to view the details of an order that exists in Sterling Order Management, the getCompleteOrderDetails API is called. If the shopper wants to reorder and create a cart that is based on these order details, HCL Commerce calls the same API.

getCompleteOrderDetails mappings

A table showing the mappings between HCL Commerce and Sterling Order Management order information for getCompleteOrderDetails, with notes

HCL Commerce order information Sterling Order Management order information Notes®

_ord:Order/_ord:OrderIdentifier/_wcf:UniqueID

Order/@OrderNo

_ord:Order/_wcf:StoreIdentifier/_wcf:uniqueID

Order/@EnterpriseCode

Maintain the mapping between SC:OrganizationCode and WC:StoreIdentifer (StoreId) in ValueMaps.xml

_ord:Order/_wcf:StoreIdentifier/_wcf:uniqueID

Order/@SellerOrganizationCode

_ord:Order/_ord:PlacedDate

Order/@OrderDate

Time zone is included.

_ord:Order /_ord:OrderStatus/_ord:Status

Order/@OverallStatus

_ord:Order/ShipAsComplete

Order/@IsShipAsComplete

Order amount

_ord:Order/_ord:OrderAmount/_ord:GrandTotal

Order/OverallTotals/@GrandTotal

_ord:Order/_ord:OrderAmount/_ord:TotalProductPrice

Order/OverallTotals/@LineSubTotal

_ord:Order/_ord:OrderAmount/_ord:TotalAdjustment

Order/OverallTotals/@GrandDiscount

_ord:Order/_ord:OrderAmount/_ord:TotalShippingCharge

Order/OverallTotals/@GrandShippingTotal

_ord:Order/_ord:OrderAmount/_ord:TotalSalesTax

Order/OverallTotals/@GrandTax

_ord:Order/_ord:OrderAmount/_ord:TotalShippingTax

_wcf:Currency

Order/PriceInfo/@Currency

Order adjustment
ord:Order/_ord:OrderItem/ord:OrderItemAmount/@freeGift

Order/Awards/Award/AwardType

If @freeGift=true, set to Y.

For Order Level free gift, add Award to both Order level and line level.

(ChargeCategory)

Order shipping: Order items

_ord:Order/_ord:OrderItem/_ord:CatalogEntryIdentifier/_wcf:ExternalIdentifier/_wcf:PartNumber

Order/OrderLines/OrderLine/Item/@ItemID

ord:Order/_ord:OrderItem/_ord:Quantity

Order/OrderLines/OrderLine/@OrderedQty

ord:Order/_ord:OrderItem/_ord:Quantity/@uom

Order/OrderLines/OrderLine/Item/@UnitOfMeasure

ord:Order/_ord:OrderItem/_ord:OrderItemConfiguration

Order/OrderLines/OrderLine/@BOMXML

For DynamicKit

Order item shipping Info

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingMode/_ord:ShippingModeIdentifier/_ord:ExternalIdentifier/_ord:ShipModeCode

Order/OrderLines/OrderLine/@CarrierServiceCode

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingMode/_ord:ShippingModeIdentifier/_ord:ExternalIdentifier/_ord:ShipModeCode

Order/OrderLines/OrderLine/@DeliveryMethod

For Pickup in store, it should be set as “PICK.” Otherwise, it should be set as “SHP”

ord:Order/_ord:OrderItem/_ord:FulfillmentCenter/_ord:FulfillmentCenterIdentifier/_wcf:Name

Order/OrderLines/OrderLine/@ShipNode

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:RequestedShipDate

Order/OrderLines/OrderLine/@ReqShipDate

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingInstruction

Order/OrderLines/OrderLine/Instructions/Instruction(InstructionType=SHIP)

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:ContactName/_wcf::FirstName

Order/OrderLines/OrderLine/PersonInfoShipTo@FirstName

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:ContactName/_wcf::LastName

Order/OrderLines/OrderLine/PersonInfoShipTo@LastName

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:Address/_wcf::AddressLine[1]

Order/OrderLines/OrderLine/PersonInfoShipTo@AddressLine1

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:Address/_wcf::AddressLine[2]

Order/OrderLines/OrderLine/PersonInfoShipTo@AddressLine2

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:Address/_wcf::AddressLine[3]

Order/OrderLines/OrderLine/PersonInfoShipTo@AddressLine3

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:Address/_wcf::City

Order/OrderLines/OrderLine/PersonInfoShipTo@City

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:Address/_wcf::StateOrProvinceName

Order/OrderLines/OrderLine/PersonInfoShipTo@State

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:Address/_wcf::Country

Order/OrderLines/OrderLine/PersonInfoShipTo@Country

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:Address/_wcf::ZipCode

Order/OrderLines/OrderLine/PersonInfoShipTo@ZipCode

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:Address/_wcf:: EmailAddress1

Order/OrderLines/OrderLine/PersonInfoShipTo@EmailID

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:Address/_wcf: Telephone1

Order/OrderLines/OrderLine/PersonInfoShipTo /@DayPhone

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:Address/_wcf: Telephone2

Order/OrderLines/OrderLine/PersonInfoShipTo /@EveningPhone

ord:Order/_ord:OrderItem/_ord:OrderItemShippingInfo/_ord:ShippingAddress/_wcf:ContactInfoIdentifier/_wcf:ExternalIdentifier/ContactInfoNickName

Order/OrderLines/OrderLine/PersonInfoShipTo /@AddressID

Order item amount

ord:Order/_ord:OrderItem/_ord:OrderItemAmount/_wcf:UnitPrice/_wcf:Price

Order/OrderLines/OrderLine/ComputedPrice/@UnitPrice

ord:Order/_ord:OrderItem/_ord:OrderItemAmount/_wcf:OrderItemPrice

Order/OrderLines/OrderLine/ComputedPrice /@ExtendedPrice

ord:Order/_ord:OrderItem/_ord:OrderItemAmount/_wcf:TotalAdjustment

Order/OrderLines/OrderLine/ComputedPrice /@Discount

ord:Order/_ord:OrderItem/_ord:OrderItemAmount/_wcf:SalesTax

Order/OrderLines/OrderLine/ComputedPrice /@Tax

ord:Order/_ord:OrderItem/_ord:OrderItemAmount/_wcf:ShippingTax

Order item adjustment

ord:Order/_ord:OrderItem/ord:OrderItemAmount/@freeGift

Order/OrderLines/ OrderLine/@isFreeGift

If @freeGift=true, set to Y.

For Order Level free gift, add Award to Both Order level and line level.

For line level free gift, only add Award to line level.

(ChargeCategory)

Order item status

ord:Order/_ord:OrderItem/_ord:OrderItemStatus/_ord:Status

Order/OrderLine/OrderStatus/@Status

Order payment info

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:PaymentMethod/_ord:PaymentMethodName

Order/PaymentMethods/PaymentMethod/@PaymentType

Credit card

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:ProtocolData: _display_value

Order/PaymentMethods/PaymentMethod/DisplayCreditCardNo

HCL Commerce-side attribute is for display purposes.

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:ProtocolData:cc_brand

Order/PaymentMethods/PaymentMethod/CreditCardType

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:ProtocolData:expire_month

Order/PaymentMethods/PaymentMethod/CreditCardExpDate

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:ProtocolData:expire_year

Order/PaymentMethods/PaymentMethod/CreditCardExpDate

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:ContactName/_wcf:FirstName

Order/PaymentMethods/PaymentMethod/FirstName

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:ContactName/_wcf:LastName

Order/PaymentMethods/PaymentMethod/LastName

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:ContactName/_wcf:MiddleName

Order/PaymentMethods/PaymentMethod/MiddleName

Customer Account

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:ProtocolData: _display_value

Order/PaymentMethods/PaymentMethod/DisplayCustomerAccountNo

HCL Commerce-side attribute is for display purposes.
Check

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:ProtocolData: _display_value

Order/PaymentMethods/PaymentMethod/DisplayPaymentReference1

HCL Commerce-side attribute is for display purposes.
Other

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:ProtocolData: _display_value

Order/PaymentMethods/PaymentMethod/ DisplayPaymentReference1

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:Amount

Order/PaymentMethods/PaymentMethod/MaxChargeLimit

Financial Transaction

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:ContactName/_wcf:FirstName

Order/PersonInfoBillTo@FirstName

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo@FirstName

Billing address is always binding with payment method in HCL Commerce. Map billing address for first payment method to Order/PersonInfoBillTo.

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:ContactName/_wcf:MiddleName

Order/PersonInfoBillTo@MiddleName

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo@ MiddleName

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:ContactName/_wcf:LastName

Order/PersonInfoBillTo@LastName

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo@ LastName

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf:AddressLine[1]

Order/PersonInfoBillTo@AddressLine1

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo@ AddressLine1

_ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf:AddressLine[2]

Order/PersonInfoBillTo@AddressLine2

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo@ AddressLine2

ord:Order/_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf:AddressLine[3]

Order/PersonInfoBillTo@AddressLine3

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo@ AddressLine3

ord:Order /_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf:City

Order/PersonInfoBillTo@City

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo@ City

ord:Order /_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf: StateOrProvinceName

Order/PersonInfoBillTo@State

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo/@State

ord:Order /_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf: Country

Order/PersonInfoBillTo@Country

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo/@Country

ord:Order /_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf: PostalCode

Order/PersonInfoBillTo@ZipCode

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo/@ZipCode

ord:Order /_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf: EmailAddress1/_wcf:value

Order/PersonInfoBillTo@EmailID

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo/@EmailID

ord:Order /_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf: EmailAddress2/_wcf:value

Order/PersonInfoBillTo@ AlternateEmailID

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo/@ AlternateEmailID

ord:Order /_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf: Telephone1

Order/PersonInfoBillTo/@DayPhone

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo/@DayPhone

ord:Order /_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf: Telephone2

Order/PersonInfoBillTo/@EveningPhone

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo/@EveningPhone

ord:Order /_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf: Fax1

Order/PersonInfoBillTo/@DayFaxNo

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo/@ DayFaxNo

ord:Order /_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:Address/_wcf: Fax2

Order/PersonInfoBillTo/@EveningFaxNo

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo/@ EveningFaxNo

ord:Order /_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf:ContactInfoIdentifier/_wcf:ExternalIdentifier/ContactInfoNickName

Order/PersonInfoBillTo/@AddressID

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo/@AddressID

ord:Order /_ord:OrderPaymentInfo/_ord:PaymentInstruction/_ord:BillingAddress/_wcf: ContactName/_wcf:PersonTitle

Order/PersonInfoBillTo/@Title

Order/PaymentMethods/PaymentMethod/ PersonInfoBillTo/@Title