Refunding orders with multiple shipping lines returns accurate data
API
Effective July 18, 2024
Orders with multiple shipping lines may be refunded. You can refund shipping amounts using the refundCreate
GraphQL mutation, the returnRefund
GraphQL mutation, or the Refunds REST API.
As of July 18, 2024, all Admin GraphQL API versions return accurate refunds data for orders with multiple shipping lines.
- Shipping refunds will be included in the
refundShippingLines
connection, in addition to shipping lines removed via an order edit. - For each refunded shipping line, there will be an
OrderAdjustment
with kindSHIPPING_REFUND
. Previously, there would be a singleOrderAdjustment
with kindSHIPPING_REFUND
regardless of how many shipping lines were present on the order. - The
RefundAgreement
has multiple shipping line sales. EachShippingLineSale
corresponds to exactly one shipping line that was refunded. TheShippingLineSale.shippingLine
is now populated for all API versions for theRETURN
action type.
As of July 18, 2024, all REST API versions return accurate refunds data for orders with multiple shipping lines.
- For each refunded shipping line, there will be an order adjustment with kind =
shipping_refund
in theorder_adjustments
property. Previously, there would be a single order adjustment with kind =shipping_refund
, regardless of how many shipping lines were present on the order.
Please note that Refund.refundShippingLines
and RefundAgreement.sales
are only available in the Admin GraphQL API. They are not present in the Admin REST API.
Opens in a new window