Exposing the order adjustments connection on a Refund

API

As of the 2024-10 Admin GraphQL API, you can use the Refund.orderAdjustments connection to query for the difference between calculated and actual refund amounts. The REFUNDS_CREATE webhook topic will include order adjustments too. As of 2024-10, the webhook payload for REFUNDS_CREATE will not include the kind field.

Please note that the OrderAdjustment.kind field is now deprecated in the Admin GraphQL API. It is also deprecated in the legacy refund.order_adjustments resource in the Admin REST API.

For this reason, refunded shipping costs will not be included in the Refund.orderAdjustments connection. To query for refunded shipping costs, use the Refund.refundShippingLines connection instead. This connection has been updated as of July 18, 2024 to include refunded shipping costs; more info here. Refunded shipping costs will not be present in the webhook payload for REFUNDS_CREATE as of 2024-10 for the same reason.

The OrderAdjustment.kind field will be present on the unstable API version for 6 months to allow apps to migrate to the 2024-10 API version.