Learn about the Returns Financial Feed, a JSON-formatted return-wise feed generated from HotWax Commerce (HC) OMS.
Introduction
The Returns Financial Feed, generated by HotWax, is a JSON-formatted feed containing details about returns created against orders, originating from both online and in-store channels. The feed is used to post the return details to ERP systems for finanacial reconciliation. The feed is transformed - by HotWax's intermediary systems - in a way that allow integrated third-party systems, such as the ERP systems, to ingest the generated data.
Customization
The Returns Financial Feed has certain out-of-the-box parameters that allow users to generate the feed as per their requirements.
Parameter
Description
orderId
Filter return details for a specific HC order ID.
returnId
Filter return details for a specific HC return ID.
sinceReturnDate
Filter returns created in Shopify after a specific date.
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
Filter returns for for particular product store IDs to generate brand-specific feeds. For example, "WSC_STORE".
returnChannelEnumId
Filter returns made from different channels such as e-commerce returns or in-store returns.
customParametersMap
Filter returns using 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.
Creation date of the return in the E-commerce system.
returnChannelEnumId
Enum ID for the return channel.
completedDatetime
Date and time when the return was completed in Howax.
productStoreId
Identifier for the product store.
productStoreExternalId
External ID for the product store.
customerPartyId
Identifier for the customer party.
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 Header Level Attributes:
Nested Fields within returnAdjustments:
Field
Description
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:
Field
Description
partyId
Identifier for the party.
idValue
Value of the identification.
...
More fields for the customer party identifications.
Nested Fields within payments:
Field
Description
paymentMethodTypeId
Type of payment method.
paymentMethodDescription
Description of the payment method.
statusId
Identifier for the status.
...
More fields for the payments.
Nested Attributes / Fields within returnItems:
Field
Description
returnId
Identifier for the return.
returnItemSeqId
Sequence ID for the return item.
orderId
Identifier for the order.
...
More fields for the return items.
billTo
Map of billing address details
productIdentification
List of maps for the product details of the return item
returnItemAdjustments
List of maps for the adjustments against the return item
Item Level Attributes:
Nested Fields within shipTo:
Field
Description
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 billTo:
Field
Description
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 productIdentifications:
Field
Description
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:
Field
Description
customerReferenceId
Identifier for customer reference.
amount
Amount of the adjustment.
description
Description of the adjustment.
...
More fields for the return item adjustments.
NOTE: Fields like orderId, orderName, billTo and so on are stored at the item level instead of the header level as a single return can be composed of items from multiple orders of a customer. A classic example would be the case of POS returns.