public abstract class ReturnRequest extends TelesalesRequest
Modifier and Type | Field and Description |
---|---|
protected org.w3c.dom.Element | headerElement_
headerElement_ contains the request document's Header element.
|
protected org.w3c.dom.Element | refundElement_
refundElement_ contains the request document's Refund element.
|
static java.lang.String | REQUEST_ID_ADD_RETURN_ITEM
Service request ID for add Return.
|
static java.lang.String | REQUEST_ID_APPROVE_RETURN
Service request ID for prepare Return.
|
static java.lang.String | REQUEST_ID_BEGIN_RETURN
Service request ID for begin edit return.
|
static java.lang.String | REQUEST_ID_CANCEL_RETURN
Service request ID for cancel Return.
|
static java.lang.String | REQUEST_ID_CREATE_RETURN
Service request ID for create return.
|
static java.lang.String | REQUEST_ID_CREATE_RETURN_FROM_ORDER
Service request ID to create a return from an order.
|
static java.lang.String | REQUEST_ID_DELETE_RETURN_ITEM
Service request ID for delete Return item.
|
static java.lang.String | REQUEST_ID_DUPLICATE_RETURN
Service request ID for cloning Return.
|
static java.lang.String | REQUEST_ID_END_RETURN
Service request ID for end edit return.
|
static java.lang.String | REQUEST_ID_FIND_RETURN
Service request ID for find Return.
|
static java.lang.String | REQUEST_ID_PROCESS_RETURN
Service request ID for submit order.
|
static java.lang.String | REQUEST_ID_SUBMIT_PREPARE
Service request ID for submit order.
|
static java.lang.String | REQUEST_ID_UPDATE_RETURN
Service request ID for update Return.
|
static java.lang.String | REQUEST_ID_UPDATE_RETURN_ITEM
Service request ID for update Return item.
|
static java.lang.String | REQUEST_ID_UPDATE_RETURN_ITEM_COMP
Service request ID for update Return item component.
|
protected org.w3c.dom.Element | returnElement_
returnElement_ contains the request document's Return element.
|
protected Return | rma_
The Return object found in the TelesalesProperties object passed to this request.
|
Constructor and Description |
---|
ReturnRequest()
Creates a new request handler.
|
Modifier and Type | Method and Description |
---|---|
protected org.w3c.dom.Element | createCustomerElement()
This method builds a Customer element and adds it as a child of headerElement_.
|
protected org.w3c.dom.Element | createDocumentIdElement(org.w3c.dom.Element documentIdsElement, java.lang.String id)
This method builds a DocumentId element and adds it as a child of the specified DocumentIds element.
|
protected org.w3c.dom.Element | createDocumentIdsElement()
This method builds a DocumentIds element and adds it as a child of the headerElement_ element.
|
protected org.w3c.dom.Element | createHeaderElement()
This method builds the Header element and adds it as a child of returnElement_ element.
|
protected org.w3c.dom.Element | createLineDocumentIdsElement(org.w3c.dom.Element lineElement, ReturnItem returnItem)
This method builds a DocumentIds element and adds it as a child of the specified Line element.
|
protected org.w3c.dom.Element | createLineElement(ReturnItem returnItem)
This method builds a Line element for the specified return item and adds it as a child of returnElement_.
|
protected void | createLineElements()
This method creates a Line element for each ReturnItem provided in the "items" property.
|
protected org.w3c.dom.Element | createRefundAmountElement(org.w3c.dom.Element lineElement, ReturnItem returnItem)
This method builds a RefundAmount element and adds it as a child of the specified Line element.
|
protected org.w3c.dom.Element | createRefundElement()
This method builds a Refund element and adds it as a child of headerElement_.
|
protected org.w3c.dom.Element | createReturnElement()
This method builds the Return element and adds it as a child of dataAreaElement_.
|
protected org.w3c.dom.Element | createSerialNumberElement(org.w3c.dom.Element lineElement, ReturnItem returnItem, java.lang.String serialNumber)
This method builds a SerialNumber element for the specified return item and serial number and adds it as a child of the specified Line element.
|
protected void | createSerialNumberElements(org.w3c.dom.Element lineElement, ReturnItem returnItem)
This method creates a SerialNumber element for each serial number found in the specified return item.
|
protected Session | getResponseData()
This method returns the response data for this request.
|
ServiceContext | getServiceContext()
This method returns the ServiceContext object.
|
protected void | setTelesalesProperties(TelesalesProperties properties)
This method sets rma_ to the Return object found in the specified properties object under the key "rma".
|
protected java.util.HashMap | unmarshallAllowedRefundPaymentPolicies(Return rma, java.util.List allowedRefundPaymentPolicyElements)
This method unmarshalls the AllowedRefundPaymentPolicy elements.
|
protected java.util.HashMap | unmarshallAllowedRefundPolicies(Return rma, java.util.List allowedRefundPoliciyElements)
This method unmarshalls the AllowedRefundPolicy elements.
|
protected void | unmarshallBOD(Return rma, org.w3c.dom.Element bodElement)
This method unmarshalls the BOD element inside the DataArea.
|
protected void | unmarshallBODHeader(org.w3c.dom.Element bodHeaderElement)
This method unmarshalls the BODHeader element.
|
protected void | unmarshallConfirmReturn(Return rma, org.w3c.dom.Element confirmReturnElement)
This method unmarshalls the ConfirmReturn element.
|
protected Contract | unmarshallContract(Return rma, org.w3c.dom.Element contractElement)
This method unmarshalls the Contract element.
|
protected java.util.HashMap | unmarshallCreditLinesUsed(Return rma, java.util.List creditLineUsedElements)
This method unmarshalls the CreditLineUsed element.
|
protected abstract void | unmarshallCustomerElement(Return rma, org.w3c.dom.Element customerElement)
This method unmarshall the Customer element.
|
protected void | unmarshallDataArea(Return rma, org.w3c.dom.Element dataAreaElement)
This method unmarshalls the DataArea element.
|
protected void | unmarshallDocumentId(Return rma, org.w3c.dom.Element documentIdElement)
This method unmarshalls the DocumentId element.
|
protected void | unmarshallDocumentIds(Return rma, org.w3c.dom.Element documentIdsElement)
This method unmarshalls the DocumentIds element.
|
protected FFMCenter | unmarshallFulfillmentCenter(Return rma, org.w3c.dom.Element fulfillmentCenterElement)
This method unmarshalls the FulfillmentCenter element.
|
protected void | unmarshallHeader(Return rma, org.w3c.dom.Element headerElement)
This method unmarshalls the Header element.
|
protected ReturnItem | unmarshallLine(Return rma, org.w3c.dom.Element lineElement)
This method unmarshalls the Line element.
|
protected void | unmarshallNounOutcome(Return rma, org.w3c.dom.Element nounOutcomeElement)
This method unmarshalls the NounOutcome element.
|
protected void | unmarshallPhysicalReturn(ReturnItem returnItem, java.lang.String physical)
This method unmarshalls the PhysicalReturn element.
|
protected void | unmarshallRefund(Return rma, org.w3c.dom.Element refundElement)
This method unmarshalls the Refund element.
|
protected void | unmarshallRefundAmount(ReturnItem rmaItem, org.w3c.dom.Element refundAmountElement)
This method unmarshalls the RefundAmount element.
|
protected void | unmarshallResponseBod(org.w3c.dom.Document bod)
This method unmarshall the response BOD.
|
protected void | unmarshallReturn(Return rma, org.w3c.dom.Element returnElement)
This method unmarshalls the Return element.
|
protected void | unmarshallSerialNumbers(ReturnItem returnItem, java.util.ArrayList childElements)
This method unmarshalls the SearialNumber element.
|
protected void | updateModel(java.lang.Object databean)
This method updates the model with the specified databean.
|
public static final java.lang.String REQUEST_ID_CREATE_RETURN
public static final java.lang.String REQUEST_ID_CREATE_RETURN_FROM_ORDER
public static final java.lang.String REQUEST_ID_FIND_RETURN
public static final java.lang.String REQUEST_ID_APPROVE_RETURN
public static final java.lang.String REQUEST_ID_UPDATE_RETURN
public static final java.lang.String REQUEST_ID_SUBMIT_PREPARE
public static final java.lang.String REQUEST_ID_PROCESS_RETURN
public static final java.lang.String REQUEST_ID_DUPLICATE_RETURN
public static final java.lang.String REQUEST_ID_CANCEL_RETURN
public static final java.lang.String REQUEST_ID_ADD_RETURN_ITEM
public static final java.lang.String REQUEST_ID_DELETE_RETURN_ITEM
public static final java.lang.String REQUEST_ID_UPDATE_RETURN_ITEM
public static final java.lang.String REQUEST_ID_UPDATE_RETURN_ITEM_COMP
public static final java.lang.String REQUEST_ID_BEGIN_RETURN
public static final java.lang.String REQUEST_ID_END_RETURN
protected org.w3c.dom.Element returnElement_
protected org.w3c.dom.Element headerElement_
protected org.w3c.dom.Element refundElement_
protected Return rma_
protected Session getResponseData()
public ServiceContext getServiceContext()
protected org.w3c.dom.Element createReturnElement()
The following outline shows the structure of the Return element and its construction:
<Return> <Header> <!-- constructed by createHeaderElement() --> . . </Header> <Line> <!-- constructed by createLineElements() --> . . </Line> <Line> <!-- constructed by createLineElements() --> . . </Line> <!-- constructed by createUserDataElement("rma") --> <wc:UserData> <!-- constructed by createUserDataElement() --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </Return>
protected void createLineElements()
protected org.w3c.dom.Element createLineElement(ReturnItem returnItem)
The following outline shows the structure of the Line element and its construction:
<Line> <DocumentIds> <!-- constructed by createDocumentIdsElement() --> . . </DocumentIds> <RmaItemId>101</RmaItemId> <!-- returnItem.getRMAItem_id() --> <OrderItemId>101</OrderItemId> <!-- returnItem.getOrderitemId() --> <CatEntryId>101</CatEntryId> <!-- returnItem.getCatEntryID() --> <Quantity>1</Quantity> <!-- returnItem.getQuantity() --> <ReturnReason>return reason</ReturnReason> <!-- returnItem.getReturnReason() --> <PhysicalReturn>Y</PhysicalReturn> <!-- returnItem.getPhysicalReason() --> <SerialNumber> <!-- constructed by createSerialNumberElements() --> . . </SerialNumber> <SerialNumber> <!-- constructed by createSerialNumberElements() --> . . </SerialNumber> <LastUpdated/> <!-- returnItem.getLastUpdated() --> <Comment/> <!-- returnItem.getComment() --> <RefundAmount> <-- createRefundAmountElement --> . . </RefundAmount> <!-- constructed by createUserDataElement() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </Line>
protected void createSerialNumberElements(org.w3c.dom.Element lineElement, ReturnItem returnItem)
protected org.w3c.dom.Element createSerialNumberElement(org.w3c.dom.Element lineElement, ReturnItem returnItem, java.lang.String serialNumber)
The following outline shows the structure of the SerialNumber element and its construction:
<SerialNumber> <RmaItemId>101</RmaItemId> <!-- returnItem.getRMAItem_id() --> <RmaItemComponentId>101</RmaItemComponentId> <!-- returnItem.getData("rMAItemComponent_id") --> <SerialNumber>123456</SerialNumber> <!-- returnItem.getCatEntryID() --> <Quantity>1</Quantity> <!-- serialNumber --> </SerialNumber>
protected org.w3c.dom.Element createHeaderElement()
The following outline shows the structure of the Header element and its construction:
<Header> <DocumentIds> <!-- createDocumentIdsElement() --> . . </DocumentIds> <ForUserId>101</ForUserId> <!-- rma_.getRmaId() --> <RMA_Id>1002</RMA_Id> <!-- getServiceContext().getRunAsId() --> <ReturnStatus>PND</ReturnStatus> <!-- rma_.getRmaStatus() --> <LastModificationDateTime>xxx</LastModificationDateTime> <!-- rma_.getLastUpdated() --> <StoreId>10001</StoreId> <!-- rma_.getStoreId() --> <CreationDateTime>xxx</CreationDateTime> <!-- rma_.getDateCreated() --> <Customer> <!-- createCustomerElement() --> . . </Customer> <Refund> <!-- createRefundElement() --> . . </Refund> <Comment>xxx</Comment> <!-- rma_.getComment() --> <TakeOverLock>Y</TakeOverLock> <!-- "takeOver" property --> <CommerceArea> <!-- createCommerceAreaElement() --> . . </CommerceArea> </Header>
protected org.w3c.dom.Element createCustomerElement()
The following outline shows the structure of the Customer element and its construction:
<Customer> <MemberId>101</MemberId> <!-- rma_.getCustomer().getMemberId() --> <UserId>user1</UserId> <!-- rma_.getCustomer().getUsername() --> <!-- constructed by createUserDataElement() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </Customer>
protected org.w3c.dom.Element createRefundAmountElement(org.w3c.dom.Element lineElement, ReturnItem returnItem)
The following outline shows the structure of the RefundAmount element and its construction:
<RefundAmount> <CreditAmount>10.00</CreditAmount> <!-- returnItem.getCreditAmount() --> <CreditAdjustment>10.00</CreditAdjustment> <!-- returnItem.getCreditAdjustment() --> </RefundAmount>
protected org.w3c.dom.Element createRefundElement()
The following outline shows the structure of the Refund element and its construction:
<Refund> <Currency>USD</Currency> <!-- rma_.getCurrency() --> <RefundPolicyIdUsed>101</RefundPolicyIdUsed> <!-- rma_.getRefundPolicyId() --> <RefundPaymentIdUsed>101</RefundPaymentIdUsed> <!-- rma_.getRefundPaymentTypeId() --> <OtherCharges>10.00</OtherCharges> <!-- rma_.getOtherCharges() --> <TotalCredit>10.00</TotalCredit> <!-- rma_.getTotalCredit() --> </Refund>
protected org.w3c.dom.Element createDocumentIdsElement()
The following outline shows the structure of the DocumentIds element and its construction:
<DocumentIds> <DocumentId> <!-- createDocumentIdElement(rma_.getRmaId()) --> . . </DocumentId> </DocumentIds>
protected org.w3c.dom.Element createLineDocumentIdsElement(org.w3c.dom.Element lineElement, ReturnItem returnItem)
The following outline shows the structure of the DocumentIds element and its construction:
<DocumentIds> <DocumentId> <!-- createDocumentIdElement(returnItem.getRMAItem_id()) --> . . </DocumentId> </DocumentIds>
protected org.w3c.dom.Element createDocumentIdElement(org.w3c.dom.Element documentIdsElement, java.lang.String id)
The following outline shows the structure of the DocumentId element and its construction:
<DocumentId> <Id>101</Id> <!-- id --> </DocumentId>
protected void unmarshallConfirmReturn(Return rma, org.w3c.dom.Element confirmReturnElement)
<ConfirmReturn> <!-- for a Return, this is ConfirmReturn --> <oa:ApplicationArea> <!-- unmarshalled by unmarshallApplicationArea() --> . . </oa:ApplicationArea> <DataArea> <!-- unmarshalled by unmarshallDataArea() --> . . </DataArea> </ConfirmReturn>
protected void unmarshallNounOutcome(Return rma, org.w3c.dom.Element nounOutcomeElement)
<NounOutcome> <oa:DocumentIds> <!-- unmarshalled by unmarshallNounOutcome() --> . . </oa:DocumentIds> <Return> <!-- unmarshalled by unmarshallReturn() --> . . </Return> </NounOutcome>
protected void updateModel(java.lang.Object databean)
protected void unmarshallResponseBod(org.w3c.dom.Document bod)
protected void unmarshallBOD(Return rma, org.w3c.dom.Element bodElement)
<BOD> <BODHeader> <!-- unmarshalled by unmarshallBODHeader() --> . . </BODHeader> <NounOutcome> <!-- unmarshalled by unmarshallNounOutcome() --> . . </NounOutcome> </BOD>
protected void unmarshallBODHeader(org.w3c.dom.Element bodHeaderElement)
<BODHeader> <BODFailure> <!-- unmarshalled by unmarshallBODFailure() --> . . </BODFailure> <BODSuccess> <!-- unmarshalled by unmarshallBODSuccess() --> . . </BODSuccess> </BODHeader>
protected void unmarshallRefund(Return rma, org.w3c.dom.Element refundElement)
<Refund> <Currency/> <!-- rma.setCurrency() --> <Tax/> <!-- rma.setTax() --> <PaymentMethodOrderId/> <!-- rma.setPayMethodOrderId() --> <RefundPolicyIdUsed/> <!-- rma.setRefundPolicyId() --> <RefundPaymentIdUsed/> <!-- rma.setRefundPaymentTypeId() --> <OtherCharges/> <!-- rma.setOtherCharges() --> <AllowedRefundPolicy> <!-- unmarshalled by unmarshallAllowedRefundPolicies() --> . . </AllowedRefundPolicy> <AllowedRefundPaymentPolicy> <!-- unmarshalled by unmarshallAllowedRefundPaymentPolicies() --> . . </AllowedRefundPaymentPolicy> <CreditLineUsed> <!-- unmarshalled by unmarshallCreditLinesUsed() --> . . </CreditLineUsed> <OtherCharges/> <!-- rma.setOtherCharges() --> </Refund>
protected java.util.HashMap unmarshallAllowedRefundPolicies(Return rma, java.util.List allowedRefundPoliciyElements)
<AllowedRefundPolicy> <RefundPolicyId>100</RefundPolicyId> <RefundPolicyDescription>Policy description</RefundPolicyDescription> </AllowedRefundPolicy>A new HashMap object is created and populated with the refund policy IDs as the keys and the refund policy descriptions as the values. The map is added to the specified Return model object under the "allowedRefundPolicies" key.
protected java.util.HashMap unmarshallAllowedRefundPaymentPolicies(Return rma, java.util.List allowedRefundPaymentPolicyElements)
<AllowedRefundPaymentPolicy> <RefundPaymentId>100</RefundPaymentId> <RefundPaymentTypeDescription>Payment policy description</RefundPaymentTypeDescription> </AllowedRefundPaymentPolicy>A new HashMap object is created and populated with the refund payment IDs as the keys and the refund payment type descriptions as the values. The map is added to the specified Return model object under the "allowedPaymentTypes" key.
protected java.util.HashMap unmarshallCreditLinesUsed(Return rma, java.util.List creditLineUsedElements)
<CreditLineUsed> <CreditLineID>100</CreditLineID> <CreditLineDesc>Credit line description</CreditLineDesc> </CreditLineUsed>A new HashMap object is created and populated with the credit line IDs as the keys and the credit line descriptions as the values. The map is added to the specified Return model object under the "allowedCreditLineTypes" key.
protected void unmarshallRefundAmount(ReturnItem rmaItem, org.w3c.dom.Element refundAmountElement)
<RefundAmount> <CreditAmount>100</CreditAmount> <!-- rmaItem.setCreditAmount() --> <CreditAdjustment>100</CreditAdjustment> <!-- rmaItem.setCreditAdjustment() --> </RefundAmount>
protected FFMCenter unmarshallFulfillmentCenter(Return rma, org.w3c.dom.Element fulfillmentCenterElement)
<FulfillmentCenter> <FfmCenterId>101</FfmCenterId> <!-- ffmCenter.setFfmCenterId() --> <FfmCenterName>xxx</FfmCenterName> <!-- ffmCenter.setFfmCenterName() --> <FfmCenterAddress1>xxx</FfmCenterAddress1> <!-- ffmCenter.setFfmCenterAddress1() --> <FfmCenterAddress2>xxx</FfmCenterAddress2> <!-- ffmCenter.setFfmCenterAddress2() --> <FfmCenterAddress3>xxx</FfmCenterAddress3> <!-- ffmCenter.setFfmCenterAddress3() --> <FfmCenterCity>xxx</FfmCenterCity> <!-- ffmCenter.setFfmCenterCity() --> <FfmCenterState>xxx</FfmCenterState> <!-- ffmCenter.setFfmCenterState() --> <FfmCenterCountry>xxx</FfmCenterCountry> <!-- ffmCenter.setFfmCenterCountry() --> <FfmCenterZip>xxx</FfmCenterZip> <!-- ffmCenter.setFfmCenterZip() --> <!-- unmarshalled by unmarshallUserData() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </FulfillmentCenter>
protected void unmarshallDataArea(Return rma, org.w3c.dom.Element dataAreaElement)
<DataArea> <BOD> <!-- unmarshalled by unmarshallBOD() --> . . </BOD> </DataArea>
protected void unmarshallDocumentId(Return rma, org.w3c.dom.Element documentIdElement)
<oa:DocumentId> <oa:Id>100</oa:Id> <!-- rma.setUniqueId() --> </oa:DocumentId>
protected void unmarshallDocumentIds(Return rma, org.w3c.dom.Element documentIdsElement)
<oa:DocumentIds> <oa:DocumentId> <!-- unmarshalled by unmarshallDocumentId() --> . . </oa:DocumentId> </oa:DocumentIds>
protected void unmarshallHeader(Return rma, org.w3c.dom.Element headerElement)
<Header> <RMA_Id>101</RMA_Id> <!-- rma.setRmaId() --> <ReturnStatus>EDT</ReturnStatus> <!-- rma.setRmaStatus() --> <LastModificationDateTime>2004-09-13 11:36:25.229</LastModificationDateTime> <!-- rma.setLastUpdated() --> <StoreId>1001</StoreId> <!-- rma.setStoreId() --> <CreationDateTime>2004-09-13 11:36:25.229</CreationDateTime> <!-- rma.setDateCreated() --> <Customer> <!-- unmarshalled by unmarshallCustomerElement() --> . . </Customer> <Contract> <!-- unmarshalled by unmarshallContract() --> . . </Contract> <FulfillmentCenter> <!-- unmarshalled by unmarshallFulfillmentCenter() --> . . </FulfillmentCenter> <Refund> <!-- unmarshalled by unmarshallRefund() --> . . </Refund> <Comment>xxx</Comment> <!-- rma.setComment() --> <RMALocked>Y</RMALocked> <!-- rma.setLocked() --> </Header>
protected abstract void unmarshallCustomerElement(Return rma, org.w3c.dom.Element customerElement)
protected Contract unmarshallContract(Return rma, org.w3c.dom.Element contractElement)
<Contract> <PolicyId>100</PolicyId> <!-- contract.setPolicy_id --> <PolicyName>Contract name</PolicyName> <!-- contract.setContractName() --> <!-- unmarshalled by unmarshallUserData() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </Contract>
protected void unmarshallReturn(Return rma, org.w3c.dom.Element returnElement)
<Return> <Header> <!-- unmarshalled by unmarshallHeader() --> . . </Header> <Line> <!-- unmarshalled by unmarshallLine() --> . . </Line> <Line> <!-- unmarshalled by unmarshallLine() --> . . </Line> <UserData/> <!-- unmarshalled by unmarshallUserData() --> </Return>
protected ReturnItem unmarshallLine(Return rma, org.w3c.dom.Element lineElement)
<Line> <RmaItemId>101</RmaItemId> <!-- returnItem.setRMAItem_id() --> <RmaItemComponentId>101</RmaItemComponentId> <!-- returnItem.setData("rMAItemComponent_id") --> <LastUpdated/> <!-- returnItem.setLastUpdated() --> <OrderItemId>101</OrderItemId> <!-- returnItem.setOrderItemId() --> <OrderId>101</OrderId> <!-- returnItem.setOrderId() --> <CreditData/> <!-- returnItem.setCreditDate() --> <CatEntryId>101</CatEntryId> <!-- returnItem.setCatEntryID() --> <ProductSKU>product_sku101</ProductSKU> <!-- returnItem.setProductSKU() --> <ProductName>product name</ProductName> <!-- returnItem.setProductName() --> <Quantity>1</Quantity> <!-- returnItem.setQuantity() --> <ReturnReason>return reason</ReturnReason> <!-- returnItem.setReturnReason() --> <!-- unmarshalled by unmarshallUserData() --> <wc:UserData> <!-- optional --> <wc:UserDataField name="name">value</wc:UserDataField> . </wc:UserData> </Line>
protected void unmarshallSerialNumbers(ReturnItem returnItem, java.util.ArrayList childElements)
protected void unmarshallPhysicalReturn(ReturnItem returnItem, java.lang.String physical)
protected void setTelesalesProperties(TelesalesProperties properties)
If no value was specified under the "items" key, then the TelesalesProperties object is updated with the items found in the Return object.