Learn about the Returns Financial Feed, a JSON-formatted return-wise feed generated from HotWax Commerce OMS.
The Returns Financial Feed, generated from HotWax Commerce OMS, is a JSON-formatted feed containing details about returns created against orders, originating from both online and in-store channels. This feed facilitates financial reconciliation, particularly when integrating with third-party systems such as ERP.
The Returns financial feed is useful for retailers who use ERP for their accounting purposes and requires financial reconciliation during specific cycles. This feed provides the out-of-the-box data available from OMS, and retailers can use it as is or after transformation to ingest into external systems through file-based integration.
The Returns Financial Feeed Order Items feed has certain out-of-the-box customizations that allow users to generate the feed as per the requirements.
Parameter
Description
orderId
Filter return details for a specific order ID.
returnId
Filter return details for a specific return ID.
sinceReturnDate
Filter returns after a specific return date. Corresponds to the return date in HotWax Commerce.
sinceReturnCompletedDate
Filter returns completed in HotWax Commerce after a specific date. Corresponds to the completion date for return items in HotWax Commerce.
sinceEntryDate
Filter returns created after a specific date in HotWax Commerce. Corresponds to the entry date in HotWax Commerce.
productStoreIds
Sets the product store IDs to generate brand-specific feeds. For example, "WSC_STORE".
returnChannelEnumId
Identifies returns made from different channels such as e-commerce returns or in-store returns.
customParametersMap
Defines custom conditions, allowing flexibility in specifying new conditions. For example, {"returnReasonId_op": "empty", "returnReasonId_not": "Y"}.
optimize
Optimize the query or process for better performance.
The following attributes have been prepared in the feed:
returnId
Identifier for the return.
returnItemSeqId
Sequence ID for the return item.
entryDate
Date of entry for the return.
returnDate
Date of the return.
orderSalesChannelEnumId
Enum ID for the order sales channel.
orderSalesChannel
Sales channel for the order.
returnChannelEnumId
Enum ID for the return channel.
orderId
Identifier for the order.
orderItemSeqId
Sequence ID for the order item.
returnItemAmountTotal
Total amount for the return item.
statusId
Identifier for the status.
completedDatetime
Date and time when the return was completed.
productStoreId
Identifier for the product store.
orderName
Name of the order.
productStoreExternalId
External ID for the product store.
customerPartyId
Identifier for the customer party.
billTo
Object containing billing address information.
isShippingChargesSent
Flag indicating if shipping charges were sent.
returnAdjustments
Array of adjustments related to the return.
customerPartyIdentifications
Array of identifications for the customer party.
tenderAmount
Amount tendered for the return.
payments
Array of payments related to the return.
returnItems
Array of items being returned.
Nested Fields within billTo:
houseNumberExt
Extension for the house number.
address2
Additional address information.
postalCode
Postal code of the address.
...
More fields for the billing address.
Nested Fields within returnAdjustments:
customerReferenceId
Identifier for customer reference.
amount
Amount of the adjustment.
description
Description of the adjustment.
...
More fields for the return adjustments.
Nested Fields within customerPartyIdentifications:
partyId
Identifier for the party.
idValue
Value of the identification.
...
More fields for the customer party identifications.
Nested Fields within payments:
paymentMethodTypeId
Type of payment method.
paymentMethodDescription
Description of the payment method.
statusId
Identifier for the status.
...
More fields for the payments.
Nested Fields within returnItems:
returnId
Identifier for the return.
returnItemSeqId
Sequence ID for the return item.
orderId
Identifier for the order.
...
More fields for the return items.
Nested Fields within shipTo:
houseNumberExt
Extension for the house number.
contactMechId
Identifier for the contact mechanism.
postalCode
Postal code of the address.
...
More fields for the shipping address.
Nested Fields within productIdentifications:
productId
Identifier for the product.
goodIdentificationTypeId
Type of good identification.
idValue
Value of the identification.
...
More fields for the product identifications.
Nested Fields within returnItemAdjustments:
customerReferenceId
Identifier for customer reference.
amount
Amount of the adjustment.
description
Description of the adjustment.
...
More fields for the return item adjustments.