Question & Answer
Question
How to Create, Delete and Modify Notes at Order and OrderLine Level
Answer
In Order Management version 9.3 we introduced a feature to Create, Delete and Modify Notes at Order and OrderLine Level
More details on this can be found here : http://www.ibm.com/support/knowledgecenter/SSYLSL_9.3.0/com.ibm.help.wcc.impl.doc/c_wcc_addnotes.html?cp=SS6QYM_9.3.0&lang=en
While this feature is also available in version 9.4, please note that the deletion and modification of orderline level notes has been introduced only in fix pack 13 of version 9.4
Defect ID : 463555
Description : The changeOrder API is enhanced to update and delete of existing notes at the order line level. To achieve this criteria, pass Operation attribute as "Modify" or "Delete" in the <Note> element during the API invocation.
Following are sample xmls used to Create and Delete Notes at Order and OrderLine Level
ORDER :
To Add : changeOrder API
<Order Action="MODIFY" AllocationRuleID="" ApplyOnlyItemLevelPricingRules="" AuditTransactionId="" AuthorizedClient="" AutoCancelDate="" BillToID="" BillToKey="" BuyerMarkForNodeId="" BuyerOrganizationCode="DEFAULT" BuyerReceivingNodeId="" BuyerUserId="" CancelOrderOnBackorder="Y" CarrierAccountNo="" CarrierServiceCode="" ChargeActualFreightFlag="" CustCustPONo="" CustomerContactID="" CustomerDOB="" CustomerEMailID="" CustomerFirstName="" CustomerLastName="" CustomerPONo="" CustomerPhoneNo="" CustomerRewardsNo="" CustomerZipCode="" DefaultCustomerInformation="" DefaultTemplate="" DeliveryCode="" DepartmentCode="" Division="" DocumentType="0001" EnteredBy="" EnterpriseCode="DEFAULT" EntryType="" ExchangeType="" ExpirationDate="" FreightTerms="" HoldFlag="" HoldReasonCode="" HoursBeforeNextIteration="" InStorePaymentRequired="" IsExpirationDateOverridden="" IsLineShipComplete="Y" IsLineShipSingleNode="Y" IsShipComplete="Y" IsShipSingleNode="Y" LevelOfService="" LinkedSourceKey="" MaskPaymentInfoWhenLoggingAudits="" ModificationReasonCode="" ModificationReasonText="" ModificationReference1="" ModificationReference2="" ModificationReference3="" ModificationReference4="" NextIterationDate="" NextIterationSeqNo="" NotificationReference="" NotificationType="" NotifyAfterShipmentFlag="" OptimizationType="" OrderDate="" OrderHeaderKey="" OrderName="" OrderNo="Notes1" OrderPurpose="" OrderType="" Override="" PaymentRuleId="" PaymentStatus="AUTHORIZED" PersonalizeCode="" PriceProgramName="" PriorityCode="" PriorityNumber="" ProcessPaymentOnReturnOrder="" PurgeHistoryDate="" Purpose="" ReceivingNode="" ReqCancelDate="" ReqDeliveryDate="" ReqShipDate="" RetainAnswerSets="" ReturnByGiftRecipient="" ReturnOrderHeaderKeyForExchange="" SCAC="" ScacAndService="" ScacAndServiceKey="" SearchCriteria1="" SearchCriteria2="" SelectMethod="" SellerOrganizationCode="DEFAULT" ShipNode="omsnode" ShipToKey="" SkipBOMValidations="N" SourcingClassification="" TaxExemptFlag="" TaxExemptionCertificate="" TaxJurisdiction="" TaxPayerId="" TermsCode="" ValidateExternalCoupons="">
<Notes>
<Note NotesKey = "" AuditTransactionId="" ContactReference="" ContactTime="" ContactType="" ContactUser="admin" CustomerSatIndicator="" NoteText="This is an admin note3" Operation="Create" Priority="" ReasonCode="" SequenceNo="1" Tranid="" VisibleToAll=""/>
</Notes>
</Order>
To get all the notes : getNoteList API
<Note AuditTransactionId="" ContactReference="" ContactTime="" ContactType="" ContactUser="admin" CustomerSatIndicator="" NoteText="" Priority="" ReasonCode="" SequenceNo="" TableKey="2016030216230330980" TableName="YFS_ORDER_HEADER" Tranid="" Tranname="" VisibleToAll=""/>
Template
<NoteList TotalNumberOfRecords="2"><Note NotesKey="" AuditTransactionId="" ContactReference="" ContactTime="2016-03-21T17:43:56-04:00" ContactType="" ContactUser="admin" CustomerSatIndicator="" NoteText="This is an admin note2" Priority="0.00" ReasonCode="" SequenceNo="1" Tranid="ORDER_CHANGE" Tranname="Change Order"><User Username="Administrator" Usertype="INTERNAL"/></Note></NoteList>
To delete : changeOrder API
<Order Action="MODIFY" AllocationRuleID="" ApplyOnlyItemLevelPricingRules="" AuditTransactionId="" AuthorizedClient="" AutoCancelDate="" BillToID="" BillToKey="" BuyerMarkForNodeId="" BuyerOrganizationCode="DEFAULT" BuyerReceivingNodeId="" BuyerUserId="" CancelOrderOnBackorder="Y" CarrierAccountNo="" CarrierServiceCode="" ChargeActualFreightFlag="" CustCustPONo="" CustomerContactID="" CustomerDOB="" CustomerEMailID="" CustomerFirstName="" CustomerLastName="" CustomerPONo="" CustomerPhoneNo="" CustomerRewardsNo="" CustomerZipCode="" DefaultCustomerInformation="" DefaultTemplate="" DeliveryCode="" DepartmentCode="" Division="" DocumentType="0001" EnteredBy="" EnterpriseCode="DEFAULT" EntryType="" ExchangeType="" ExpirationDate="" FreightTerms="" HoldFlag="" HoldReasonCode="" HoursBeforeNextIteration="" InStorePaymentRequired="" IsExpirationDateOverridden="" IsLineShipComplete="Y" IsLineShipSingleNode="Y" IsShipComplete="Y" IsShipSingleNode="Y" LevelOfService="" LinkedSourceKey="" MaskPaymentInfoWhenLoggingAudits="" ModificationReasonCode="" ModificationReasonText="" ModificationReference1="" ModificationReference2="" ModificationReference3="" ModificationReference4="" NextIterationDate="" NextIterationSeqNo="" NotificationReference="" NotificationType="" NotifyAfterShipmentFlag="" OptimizationType="" OrderDate="" OrderHeaderKey="" OrderName="" OrderNo="Notes1" OrderPurpose="" OrderType="" Override="" PaymentRuleId="" PaymentStatus="AUTHORIZED" PersonalizeCode="" PriceProgramName="" PriorityCode="" PriorityNumber="" ProcessPaymentOnReturnOrder="" PurgeHistoryDate="" Purpose="" ReceivingNode="" ReqCancelDate="" ReqDeliveryDate="" ReqShipDate="" RetainAnswerSets="" ReturnByGiftRecipient="" ReturnOrderHeaderKeyForExchange="" SCAC="" ScacAndService="" ScacAndServiceKey="" SearchCriteria1="" SearchCriteria2="" SelectMethod="" SellerOrganizationCode="DEFAULT" ShipNode="omsnode" ShipToKey="" SkipBOMValidations="N" SourcingClassification="" TaxExemptFlag="" TaxExemptionCertificate="" TaxJurisdiction="" TaxPayerId="" TermsCode="" ValidateExternalCoupons="">
<Notes>
<Note NotesKey = "2016030216250330984" AuditTransactionId="" ContactReference="" ContactTime="" ContactType="" ContactUser="admin" CustomerSatIndicator="" NoteText="This is an admin note" Operation="Delete" Priority="" ReasonCode="" SequenceNo="" Tranid="" VisibleToAll=""/>
</Notes>
</Order>
ORDERLINE :
To Add : changeOrder API
<Order Action="MODIFY" AllocationRuleID="" ApplyOnlyItemLevelPricingRules="" AuditTransactionId="" AuthorizedClient="" AutoCancelDate="" BillToID="" BillToKey="" BuyerMarkForNodeId="" BuyerOrganizationCode="DEFAULT" BuyerReceivingNodeId="" BuyerUserId="" CancelOrderOnBackorder="Y" CarrierAccountNo="" CarrierServiceCode="" ChargeActualFreightFlag="" CustCustPONo="" CustomerContactID="" CustomerDOB="" CustomerEMailID="" CustomerFirstName="" CustomerLastName="" CustomerPONo="" CustomerPhoneNo="" CustomerRewardsNo="" CustomerZipCode="" DefaultCustomerInformation="" DefaultTemplate="" DeliveryCode="" DepartmentCode="" Division="" DocumentType="0001" EnteredBy="" EnterpriseCode="DEFAULT" EntryType="" ExchangeType="" ExpirationDate="" FreightTerms="" HoldFlag="" HoldReasonCode="" HoursBeforeNextIteration="" InStorePaymentRequired="" IsExpirationDateOverridden="" IsLineShipComplete="Y" IsLineShipSingleNode="Y" IsShipComplete="Y" IsShipSingleNode="Y" LevelOfService="" LinkedSourceKey="" MaskPaymentInfoWhenLoggingAudits="" ModificationReasonCode="" ModificationReasonText="" ModificationReference1="" ModificationReference2="" ModificationReference3="" ModificationReference4="" NextIterationDate="" NextIterationSeqNo="" NotificationReference="" NotificationType="" NotifyAfterShipmentFlag="" OptimizationType="" OrderDate="" OrderHeaderKey="" OrderName="" OrderNo="Notes1" OrderPurpose="" OrderType="" Override="" PaymentRuleId="" PaymentStatus="AUTHORIZED" PersonalizeCode="" PriceProgramName="" PriorityCode="" PriorityNumber="" ProcessPaymentOnReturnOrder="" PurgeHistoryDate="" Purpose="" ReceivingNode="" ReqCancelDate="" ReqDeliveryDate="" ReqShipDate="" RetainAnswerSets="" ReturnByGiftRecipient="" ReturnOrderHeaderKeyForExchange="" SCAC="" ScacAndService="" ScacAndServiceKey="" SearchCriteria1="" SearchCriteria2="" SelectMethod="" SellerOrganizationCode="DEFAULT" ShipNode="omsnode" ShipToKey="" SkipBOMValidations="N" SourcingClassification="" TaxExemptFlag="" TaxExemptionCertificate="" TaxJurisdiction="" TaxPayerId="" TermsCode="" ValidateExternalCoupons="">
<OrderLines>
<OrderLine Action="MODIFY" OrderLineKey="2016030216234630981" ShipNode="omsnode" >
<Notes>
<Note AuditTransactionId="" ContactReference="" ContactTime="" ContactType="" ContactUser="admin" CustomerSatIndicator="" NoteText="This is orderline note 1" Operation="Create" Priority="" ReasonCode="" SequenceNo="" Tranid="" VisibleToAll=""/>
</Notes>
</OrderLine>
</OrderLines>
<Notes>
<Note NotesKey = "" AuditTransactionId="" ContactReference="" ContactTime="" ContactType="" ContactUser="admin" CustomerSatIndicator="" NoteText="This is an admin note4" Operation="Create" Priority="" ReasonCode="" SequenceNo="" Tranid="" VisibleToAll=""/>
</Notes>
</Order>
To get all the notes : getNoteList API
<Note AuditTransactionId="" ContactReference="" ContactTime="" ContactType="" ContactUser="admin" CustomerSatIndicator="" NoteText="" Priority="" ReasonCode="" SequenceNo="" TableKey="2016030216234630981" TableName="YFS_ORDER_LINE" Tranid="" Tranname="" VisibleToAll=""/>
Template
<NoteList TotalNumberOfRecords="2"><Note NotesKey="" AuditTransactionId="" ContactReference="" ContactTime="2016-03-21T17:43:56-04:00" ContactType="" ContactUser="admin" CustomerSatIndicator="" NoteText="This is an admin note2" Priority="0.00" ReasonCode="" SequenceNo="1" Tranid="ORDER_CHANGE" Tranname="Change Order"><User Username="Administrator" Usertype="INTERNAL"/></Note></NoteList>
To Delete : changeOrder API
<Order Action="MODIFY" AllocationRuleID="" ApplyOnlyItemLevelPricingRules="" AuditTransactionId="" AuthorizedClient="" AutoCancelDate="" BillToID="" BillToKey="" BuyerMarkForNodeId="" BuyerOrganizationCode="DEFAULT" BuyerReceivingNodeId="" BuyerUserId="" CancelOrderOnBackorder="Y" CarrierAccountNo="" CarrierServiceCode="" ChargeActualFreightFlag="" CustCustPONo="" CustomerContactID="" CustomerDOB="" CustomerEMailID="" CustomerFirstName="" CustomerLastName="" CustomerPONo="" CustomerPhoneNo="" CustomerRewardsNo="" CustomerZipCode="" DefaultCustomerInformation="" DefaultTemplate="" DeliveryCode="" DepartmentCode="" Division="" DocumentType="0001" EnteredBy="" EnterpriseCode="DEFAULT" EntryType="" ExchangeType="" ExpirationDate="" FreightTerms="" HoldFlag="" HoldReasonCode="" HoursBeforeNextIteration="" InStorePaymentRequired="" IsExpirationDateOverridden="" IsLineShipComplete="Y" IsLineShipSingleNode="Y" IsShipComplete="Y" IsShipSingleNode="Y" LevelOfService="" LinkedSourceKey="" MaskPaymentInfoWhenLoggingAudits="" ModificationReasonCode="" ModificationReasonText="" ModificationReference1="" ModificationReference2="" ModificationReference3="" ModificationReference4="" NextIterationDate="" NextIterationSeqNo="" NotificationReference="" NotificationType="" NotifyAfterShipmentFlag="" OptimizationType="" OrderDate="" OrderHeaderKey="" OrderName="" OrderNo="Notes1" OrderPurpose="" OrderType="" Override="" PaymentRuleId="" PaymentStatus="AUTHORIZED" PersonalizeCode="" PriceProgramName="" PriorityCode="" PriorityNumber="" ProcessPaymentOnReturnOrder="" PurgeHistoryDate="" Purpose="" ReceivingNode="" ReqCancelDate="" ReqDeliveryDate="" ReqShipDate="" RetainAnswerSets="" ReturnByGiftRecipient="" ReturnOrderHeaderKeyForExchange="" SCAC="" ScacAndService="" ScacAndServiceKey="" SearchCriteria1="" SearchCriteria2="" SelectMethod="" SellerOrganizationCode="DEFAULT" ShipNode="omsnode" ShipToKey="" SkipBOMValidations="N" SourcingClassification="" TaxExemptFlag="" TaxExemptionCertificate="" TaxJurisdiction="" TaxPayerId="" TermsCode="" ValidateExternalCoupons="">
<OrderLines>
<OrderLine Action="MODIFY" OrderLineKey="2016030216234630981" ShipNode="omsnode" >
<Notes>
<Note NotesKey= "2016032118061534194" AuditTransactionId="" ContactReference="" ContactTime="" ContactType="" ContactUser="admin" CustomerSatIndicator="" NoteText="" Operation="Delete" Priority="" ReasonCode="" SequenceNo="1" Tranid="" VisibleToAll=""/>
</Notes>
</OrderLine>
</OrderLines>
<Notes>
<Note NotesKey = "2016032117435634078 " AuditTransactionId="" ContactReference="" ContactTime="" ContactType="" ContactUser="admin" CustomerSatIndicator="" NoteText="" Operation="Delete" Priority="" ReasonCode="" SequenceNo="1" Tranid="" VisibleToAll=""/>
</Notes>
</Order>
Was this topic helpful?
Document Information
Modified date:
10 May 2022
UID
swg21982002