Returns
Discover how returns are generated Return Header wise, with each return containing the list of returned items.
Returns feed
The feed will be generated Return Header wise, with each return containing the list of items returned.
Parameters which can be variable for the Returns Financial Feed Feed are
orderId - Parameter to fetch Return details for a specific orderId.
returnId - Parameter to fetch Return details for a specific returnId.
systemMessageTypeId - The System Message Type ID for generating Returns Financial Feed.
systemMessageRemoteId - The System Message Remote ID to send Returns Financial Feed.
sinceReturnDate - Parameter to fetch Returns after a specific Return Date. This date corresponds to the ReturnHeader.returnDate in HC.
sinceReturnCompletedDate - Parameter to fetch Returns which are completed in HC after a specific Date. This date corresponds to the ReturnStatus.completedDatetime for Return Items in HC.
sinceEntryDate - Parameter to fetch Returns created after a specific Date in HC. This date corresponds to the ReturnHeader.entryDate in HC.
productStoreIds - to set the product store ids to generate brand specific feeds. eg. WSC_STORE
returnChannelEnumId - Identify the Returns being made from different channels like Ecom Returns, In-Store etc.
customParamatersMap - This map defines custom conditions, allowing flexibility in defining new conditions. Eg. {"returnReasonId_op": "empty", "returnReasonId_not": "Y"}
Feed Generation
Views used
FinancialReturnItemsSyncQueue
ReturnItemView
In the first entity, find on the FinancialReturnItemsSyncQueue view fetches the eligible records for the feed.
The conditions on the FinancialReturnItemsSyncQueue are:
productStoreId - Support for productStoreId was added to generate brand specific feeds.
If productStoreId comes from the in-parameter productStoreIds which is a list then the productStoreId field is prepared based on the following cases:
If only one value comes in the productStoreIds list then the productStoreId field will be set from that value in the list.
If nothing is passed in the productStoreIds list or there are more than one value in the list then the productStoreId field will be a default prefix that will be set from the property added in the Moqui conf file. In this case, the default prefix will be 'HOTWAX'.
NOTE: If the view does not return any records, the Feed file of HotWax will not generate, and logs the message,
"No eligible returns to prepare Returns Financial Feed at ${nowDate}, not generating the HotWax Feed file."If FinancialReturnItemsSyncQueue has eligible returns to prepare the feed then prepare the Return level details in the service:
billTo
returnAdjustments
customerPartyIdentifications
payments
Prepared the returnItems list i.e. fetched the returns items through eligible returns:
shipTo
productIdentifications
returnItemAdjustments
Prepare the isShippingChargesSent field and fetch Return level adjustments with return adjustment type 'RET_SHIPPING_ADJ', 'RET_SALES_TAX_ADJ' to create ReturnAdjustmentHistory records:
ReturnAdjustmentAndHistory View is created for the purpose to maintain the Return level Adjustments history which are sent as part of Feed to external systems.
The condition on the view is such that it will fetch Return level adjustments which are not sent to external systems.
The ReturnAdjustmentHistory record will be created for the Shipping Charges and Shipping Sales Tax.
If for a Return some items that are completed later and are eligible to appear in the next feed, then the isShippingChargesSent value will be sent as 'Y'.
Based on the value of isShippingChargesSent, the custom transformations can be prepared.
This is done so that financials can be done in the right way and order level adjustments are not computed multiple times which may cause discrepancies in the order totals when reconciliations are done.
NOTE: For now only Shipping Charges and Shipping Sales Tax are considered as the Order level Adjustments for which we are maintaining the history.
If FinancialReturnItemsSyncQueue has eligible returns to prepare feed then to prepare values of other fields as per the Chain Drive format, for each return item fetched from the first view, entity find is done on the second view, ReturnItemView.
The Return Level Adjustments list (shipping charges, shipping sales tax, etc) for the feed is prepared in the service.
The Return Item Level Adjustments list (return item sales tax, return item discount, etc) for the feed is prepared in the service.
NOTE: The specific amount for returnAdjustmentTypeIds from the Return Header Level Adjustments list and Return Item Level Adjustments list will be prepared in the Jolt Transform.
To Prepare total amount (TENDER_AMOUNT)
Logic used -> ReturnPrice * quantity + sum of the Item Level Adjustments
For TENDER_AMOUNT, there is the scenario: If the Return has three items and two of them are completed today and eligible for today's feed then in the feed TENDER_AMOUNT will be the sum(of amounts) of only these two items + shipping charges and shipping sales tax.
Next day if the third item will be completed and eligible for the feed then in the feed TENDER_AMOUNT will be the sum(of amounts) of only this item + shipping charges and shipping sales tax.
Note - This is part of special handling used the ReturnItemAndAdjustment view to prepare the TENDER_AMOUNT using the formula ReturnPrice * quantity + sum of the Item Level Adjustments(sum function used on the amounts in the view).
For preparing ShipToAddress, PostalAddressView is used with the condition on shipToContactMechId from ReturnItemView.
For preparing BillToAddress, first OrderContactMech is used to get contactMechId for the contactMechPurposeTypeId = 'BILLING_LOCATION'. Then PostalAddressView is used with a condition on contactMechId from OrderContactMech.
For maintaining the history of records sent as part of the Financial feed, the entity record for FinancialReturnHistory is created in the service itself.
Sample generated for the HotWax Financial Feed JSON
Last updated