getOrderList
The GetOrderList mappings allow HCL Commerce to return historical order information from Sterling Order Management. When a shopper wants to view a history of orders in the My Account section, HCL Commerce returns a consolidated order history list to the shopper. The list includes both orders that were successfully created in Sterling Order Management, and orders that were not successfully created, but whose records are available locally in HCL Commerce. HCL Commerce uses the Sterling Order Management GetOrderList API to retrieve an order history.
| Sterling Order Management Path | HCL Commerce Path |
|---|---|
| Page/@PageSize | _ord:GetOrder/_ord:DataArea/oa:Get/@maxItems |
| Page/@PaginationStrategy | Set as "NEXTPAGE" |
| Page/API/@Name | Set as "getOrderList" |
| Page/API/Input/Order/@EnterpriseCode | Find the Mapping between Sterling Order Management OrganizationCode and HCL Commerce StoreIdentifier(StoreId) in the local file ValueMaps.xml. |
| Page/API/Input/Order/@SellerOrganizationCode | Find the Mapping between Sterling Order Management SellerOrganizationCode and HCL Commerce StoreIdentifier(StoreId) in the local file ValueMaps.xml. |
| Page/API/Input/Order/@BuyerUserId | LogOnID param in the Xpath selection criteria |
| Page/API/Input/Order/@BuyerUserIdQryType | Set as "EQ" |
| Page/API/Input/Order/@DocumentType | Set as "0001" |
| Page/API/Input/Order/@ReadFromHistory | Set as "B" |
| Page/API/Input/Order/@DraftOrderFlag | Set as "N" |
| Page/API/Input/Order/ComplexQuery/@Operator | Set as "AND" |
| Page/API/Input/Order/ComplexQuery/Or/Exp/@Name | Set as "OrderNo" |
| Page/API/Input/Order/ComplexQuery/Or/Exp/@QryType | Set as "EQ" |
| Page/API/Input/Order/ComplexQuery/Or/Exp/@Value | Append "WC_" before each UniqueID.1 param in the Xpath selection criteria |
| Page/API/Input/Order/OrderBy/Attribute/@Desc | Set as "Y" |
| Page/API/Input/Order/OrderBy/Attribute/@Name | Set as "OrderHeaderKey" |
| Page/PreviousPage/Order/@OrderHeaderKey | ExternalOrderID param in the Xpath selection criteria |
| HCL Commerce Path | Sterling Order Management Path |
|---|---|
| _ord:ShowOrder/_ord:DataArea/oa:Show/@recordSetCount | Page/Output/OrderList/@TotalOrderList |
| _ord:ShowOrder/_ord:DataArea/oa:Show/@recordSetTotal | Page/Output/OrderList/@TotalNumberOfRecords |
| _ord:ShowOrder/_ord:DataArea/oa:Show/@recordSetCompleteIndicator | 'true' if Page/@IsLastPage=='Y', otherwise 'false' |
| _ord:ShowOrder/_ord:DataArea/oa:Show/_ord:Order/_ord:OrderIdentifier/_wcf:UniqueID | Page/Output/OrderList/Order/@OrderNo with 'WC_' removed. |
| _ord:ShowOrder/_ord:DataArea/oa:Show/_ord:Order/_ord:OrderIdentifier/_wcf:ExternalOrderID | Page/Output/OrderList/Order/@OrderHeaderKey |
| _ord:ShowOrder/_ord:DataArea/oa:Show/_ord:Order/_wcf:PlacedDate | Page/Output/OrderList/Order/@OrderDate |
| _ord:ShowOrder/_ord:DataArea/oa:Show/_ord:Order/_ord:OrderStatus/_ord:Status | Find the Mapping between Sterling Order Management order status and HCL Commerce order status in the entry "scStatusToWcStatus"of local file ValueMaps.xml. |
| _ord:ShowOrder/_ord:DataArea/oa:Show/_ord:Order/_ord:OrderAmount/_wcf:GrandTotal | Page/Output/OrderList/Order/OverallTotals/@GrandTotal |
| _ord:ShowOrder/_ord:DataArea/oa:Show/_ord:Order/_ord:OrderAmount/_wcf:GrandTotal/@currency | Page/Output/OrderList/Order/PriceInfo/@Currency
The Mapping between Sterling Order Management currency and HCL Commerce currency in ValueMaps.xml. If no mapping is found, use the value above. |
| _ord:ShowOrder/_ord:DataArea/oa:Show/_ord:Order/_wcf:UserData/_wcf:UserDataField/[@name=MaxOrderStatus] | Page/Output/OrderList/Order/@MaxOrderStatus |
| _ord:ShowOrder/_ord:DataArea/oa:Show/_ord:Order/_wcf:UserData/_wcf:UserDataField/[@name=MaxOrderStatusDesc] | Page/Output/OrderList/Order/@MaxOrderStatusDesc |
| _ord:ShowOrder/_ord:DataArea/oa:Show/_ord:Order/_wcf:UserData/_wcf:UserDataField/[@name=MinOrderStatus] | Page/Output/OrderList/Order/@MinOrderStatus |
| _ord:ShowOrder/_ord:DataArea/oa:Show/_ord:Order/_wcf:UserData/_wcf:UserDataField/[@name=MinOrderStatusDesc] | Page/Output/OrderList/Order/@MinOrderStatusDesc |
| _ord:ShowOrder/_ord:DataArea/oa:Show/_ord:Order/_wcf:UserData/_wcf:UserDataField/[@name=Status] | Page/Output/OrderList/Order/@Status |