Anchor to returnCalculatereturn
queryreturn
Requires access scope or access scope. Also: The shop must have access to exchanges.
Calculates the financial outcome of a Return without creating it. Use this query to preview return costs before initiating the actual return process.
The calculation provides detailed breakdowns of refund amounts, taxes, charges, return shipping fees, and order-level discount adjustments based on the objects that customers select for return.
Learn more about building for return management.
Anchor to Arguments
Arguments
- input (CalculateReturnInput!)
- Anchor to inputinput•Calculate
Return Input! required The input fields for calculating a return.
Was this section helpful?
Anchor to Possible returnsPossible returns
- CalculatedReturn (CalculatedReturn)
- Anchor to CalculatedReturnCalculated•Calculated
Return Return A calculated return.
- Anchor to exchangeLineItemsexchange•[Calculated
Line Items Exchange Line Item!]! non-null A list of calculated exchange line items.
- •ID!non-null
A globally-unique ID.
- Anchor to returnLineItemsreturn•[Calculated
Line Items Return Line Item!]! non-null A list of calculated return line items.
- Anchor to returnShippingFeereturn•Calculated
Shipping Fee Return Shipping Fee The calculated return shipping fee.
Was this section helpful?