[DOC-BUG] Misnamed taxes property in refund line items #45924
Labels
focus: documentation
Issues and PRs related to improving documentation
focus: rest api
Issues related to WooCommerce REST API.
priority: normal
The issue/PR is of normal priority—not many people are affected or there’s a workaround, etc.
team: Proton
WC Core development and maintenance
type: bug
The issue is a confirmed bug.
type: community contribution
Link to the Page/Section
Order Refund - Line Items Properties
Description of the Suggestion
In the current documentation for the WooCommerce REST API - Order Refund properties, the
line_items
section refers to a property calledtaxes
.However, in the provided example, the property used is
refund_tax
. There appears to be a discrepancy between the documented property and the example provided in the documentation.I recommend updating the text for the
line_items
properties fromtaxes
torefund_tax
.Reason for the Suggestion
The current explanation for
line_items
properties can lead to confusion as it does not match the example provided in the documentation. Developers may use thetaxes
property instead ofrefund_tax
, leading to improper use of the API.By correcting this discrepancy and aligning documentation with the provided example, future misunderstandings can be avoided, leading to more accurate implementation of the API by developers.
Additional Context
This correction in the documentation aligns it with the provided example, thereby mitigating potential confusion among developers who rely on the documentation. It will ensure the correct use of
refund_tax
when a need arises to refund taxes on line items in an order.The text was updated successfully, but these errors were encountered: