Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC-BUG] Misnamed taxes property in refund line items #45924

Closed
Tracked by #243
fredrik-tveraaen-apiera opened this issue Mar 26, 2024 · 0 comments
Closed
Tracked by #243

[DOC-BUG] Misnamed taxes property in refund line items #45924

fredrik-tveraaen-apiera opened this issue Mar 26, 2024 · 0 comments
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

Comments

@fredrik-tveraaen-apiera

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 called taxes.

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 from taxes to refund_tax.

{ "amount": "30", "line_items": [ { "id": "111", "refund_total": 10, "refund_tax": [ { "id" "222", "refund_total": 20 } ] } ] }

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 the taxes property instead of refund_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.

@jonathansadowski jonathansadowski added focus: rest api Issues related to WooCommerce REST API. focus: documentation Issues and PRs related to improving documentation team: Proton WC Core development and maintenance labels Mar 27, 2024
@coreymckrill coreymckrill added the priority: normal The issue/PR is of normal priority—not many people are affected or there’s a workaround, etc. label Mar 27, 2024
@barryhughes barryhughes added the type: bug The issue is a confirmed bug. label Apr 2, 2024
@coreymckrill coreymckrill changed the title [DOC-BUG] [DOC-BUG] Misnamed taxes property in refund line items May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

4 participants