Return Order Integration Event
Return Order Integration Event publishes the state of a return order, including:
Return order header (status, return type/mode/method)
Returned items, reasons, disposition, pricing and weight
Shipping and carrier details (including manifests and drop-off locations)
Return-level charges and credit breakdowns
Other Definitions
ReturnType Describes the business outcome of the return from the shopper’s perspective, such as:
Refund– shopper will be refundedReplacement– shopper will receive a replacement itemStoreCredit– shopper will receive credit or voucher
ReturnMode Defines how the shopper returns the goods, e.g.:
CourierPickup– a courier collects from the shopper’s addressCourierDropOff– shopper drops off at a PUDO/parcel shopPostal– shopper uses a postal network
ReturnMethod Represents the return product or channel, for example:
PrepaidLabel– shopper prints a prepaid labelPaperless– shopper uses a QR/paperless returnCustomerPaid– shopper pays for shipping directly
IsFirstReturnOrder vs IsTotalReturn
IsFirstReturnOrder–trueif this is the first return raised against the original order.IsTotalReturn–trueif all articles from the original order are being returned in this event.
These flags help determine:
Whether additional partial returns are expected in future.
Whether full-order business rules apply (e.g. full duty/tax refunds, free return promotions).
CreditBreakdowns
The CreditBreakdowns collection provides fine-grained visibility on how refunds or credits were calculated for each article, aligned to ESW credit rules. Each entry links:
OrderArticleId– the original order articleCreditTypeId/CreditRuleId– the type and rule usedCreditsInCurrency– the monetary values by charge type and currency
Last updated
Was this helpful?