DEV

Type.

OrderReturnEligibility

A snapshot of what can be returned on an order, as of this read. Values are computed live from shipment data, so they can change between reads (for example, voiding a shipment reduces returnableQuantity). Always treat this as advisory for enabling UI and let orderReturnCreate be the authority.

Fields

eligible

Boolean!

Required

Whether a return can be created on this order at all. When false, every item's returnableQuantity is 0.

ineligibleReason

OrderReturnIneligibleReason

Why the order is ineligible. Null when eligible is true.

Required

One entry per item on the order, including items with nothing returnable.
Book a demo

Was this page helpful?