Choose a version:

CalculatedReturn

object

Requires read_returns access scope or read_marketplace_returns access scope. Also: The shop must have access to exchanges.

A calculated return.

Anchor to FieldsFields

Anchor to exchangeLineItemsexchangeLineItems •[CalculatedExchangeLineItem!]! non-null: A list of calculated exchange line items.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to returnLineItemsreturnLineItems •[CalculatedReturnLineItem!]! non-null: A list of calculated return line items.
Anchor to returnShippingFeereturnShippingFee •CalculatedReturnShippingFee: The calculated return shipping fee.

Was this section helpful?

Anchor to QueriesQueries

Anchor to returnCalculate returnCalculate

•query

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, RestockingFee charges, return shipping fees, and order-level discount adjustments based on the FulfillmentLineItem objects that customers select for return.

Learn more about building for return management.

Arguments

Anchor to inputinput

•CalculateReturnInput!

required

The input fields for calculating a return.

Was this section helpful?