-
Notifications
You must be signed in to change notification settings - Fork 147
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
Updates based on issues in the WooCommerce repo #243
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
ba4a081
Add missing properties to Order refunds
coreymckrill c65de56
Add docs for the new refunds endpoint
coreymckrill bb9b213
Update order refund > line item > tax_class
coreymckrill f103223
Change wc_version to version in system_status
coreymckrill b392434
Update rate_id type in tax_lines to integer
coreymckrill 8421caa
Add line item parameters for "Create a refund"
coreymckrill 9288ae0
Clarifications about adding images to products
coreymckrill 1a81bbb
Update enums for orderby params
coreymckrill 849b306
Fix grammar in compound tax rate descriptions
coreymckrill File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| # Refunds # | ||
|
|
||
| The refunds API is a simple, read-only endpoint that allows you to retrieve a list of refunds outside the context of an existing order. To create, view, and delete individual refunds, check out the [order refunds API](#order-refunds). | ||
|
|
||
| ## Refund properties ## | ||
|
|
||
| All properties are the same as those in the [order refunds endpoint](#order-refund-properties), but with one additional property: | ||
|
|
||
| | Attribute | Type | Description | | ||
| |-------------|---------|----------------------------------------------------| | ||
| | `parent_id` | integer | The ID of the order the refund is associated with. | | ||
|
|
||
| ## Retrieve a list of refunds ## | ||
|
|
||
| This API lets you retrieve and view refunds from your store, regardless of which order they are associated with. | ||
|
|
||
| ### HTTP request ### | ||
|
|
||
| <div class="api-endpoint"> | ||
| <div class="endpoint-data"> | ||
| <i class="label label-get">GET</i> | ||
| <h6>/wp-json/wc/v3/refunds</h6> | ||
| </div> | ||
| </div> | ||
|
|
||
| ```shell | ||
| curl https://example.com/wp-json/wc/v3/refunds \ | ||
| -u consumer_key:consumer_secret | ||
| ``` | ||
|
|
||
| ```javascript | ||
| WooCommerce.get("refunds") | ||
| .then((response) => { | ||
| console.log(response.data); | ||
| }) | ||
| .catch((error) => { | ||
| console.log(error.response.data); | ||
| }); | ||
| ``` | ||
|
|
||
| ```php | ||
| <?php print_r($woocommerce->get('refunds')); ?> | ||
| ``` | ||
|
|
||
| ```python | ||
| print(wcapi.get("refunds").json()) | ||
| ``` | ||
|
|
||
| ```ruby | ||
| woocommerce.get("refunds").parsed_response | ||
| ``` | ||
|
|
||
| > JSON response example: | ||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "id": 726, | ||
| "parent_id": 124, | ||
| "date_created": "2017-03-21T17:07:11", | ||
| "date_created_gmt": "2017-03-21T20:07:11", | ||
| "amount": "10.00", | ||
| "reason": "", | ||
| "refunded_by": 1, | ||
| "refunded_payment": false, | ||
| "meta_data": [], | ||
| "line_items": [], | ||
| "_links": { | ||
| "self": [ | ||
| { | ||
| "href": "https://example.com/wp-json/wc/v3/orders/723/refunds/726" | ||
| } | ||
| ], | ||
| "collection": [ | ||
| { | ||
| "href": "https://example.com/wp-json/wc/v3/orders/723/refunds" | ||
| } | ||
| ], | ||
| "up": [ | ||
| { | ||
| "href": "https://example.com/wp-json/wc/v3/orders/723" | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| { | ||
| "id": 724, | ||
| "parent_id": 63, | ||
| "date_created": "2017-03-21T16:55:37", | ||
| "date_created_gmt": "2017-03-21T19:55:37", | ||
| "amount": "9.00", | ||
| "reason": "", | ||
| "refunded_by": 1, | ||
| "refunded_payment": false, | ||
| "meta_data": [], | ||
| "line_items": [ | ||
| { | ||
| "id": 314, | ||
| "name": "Woo Album #2", | ||
| "product_id": 87, | ||
| "variation_id": 0, | ||
| "quantity": -1, | ||
| "tax_class": "", | ||
| "subtotal": "-9.00", | ||
| "subtotal_tax": "0.00", | ||
| "total": "-9.00", | ||
| "total_tax": "0.00", | ||
| "taxes": [], | ||
| "meta_data": [ | ||
| { | ||
| "id": 2076, | ||
| "key": "_refunded_item_id", | ||
| "value": "311" | ||
| } | ||
| ], | ||
| "sku": "", | ||
| "price": -9 | ||
| } | ||
| ], | ||
| "_links": { | ||
| "self": [ | ||
| { | ||
| "href": "https://example.com/wp-json/wc/v3/orders/723/refunds/724" | ||
| } | ||
| ], | ||
| "collection": [ | ||
| { | ||
| "href": "https://example.com/wp-json/wc/v3/orders/723/refunds" | ||
| } | ||
| ], | ||
| "up": [ | ||
| { | ||
| "href": "https://example.com/wp-json/wc/v3/orders/723" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| #### Available parameters #### | ||
|
|
||
| | Parameter | Type | Description | | ||
| |------------------|---------|------------------------------------------------------------------------------------------------------------------------------| | ||
| | `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`. | | ||
| | `page` | integer | Current page of the collection. Default is `1`. | | ||
| | `per_page` | integer | Maximum number of items to be returned in result set. Default is `10`. | | ||
| | `search` | string | Limit results to those matching a string. | | ||
| | `after` | string | Limit response to resources published after a given ISO8601 compliant date. | | ||
| | `before` | string | Limit response to resources published before a given ISO8601 compliant date. | | ||
| | `exclude` | array | Ensure result set excludes specific IDs. | | ||
| | `include` | array | Limit result set to specific ids. | | ||
| | `offset` | integer | Offset the result set by a specific number of items. | | ||
| | `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. | | ||
| | `orderby` | string | Sort collection by object attribute. Options: `date`, `modified`, `id`, `include`, `title` and `slug`. Default is `date`. | | ||
| | `parent` | array | Limit result set to those of particular parent IDs. | | ||
| | `parent_exclude` | array | Limit result set to all items except those of a particular parent ID. | | ||
| | `dp` | integer | Number of decimal points to use in each resource. Default is `2`. | | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Side note: should we perhaps use the full name
decimal_pointsinstead of the abbreviation here?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dpis the name of the parameter used in the REST API, so if we changed it in the docs, we'd need to update the endpoint as well. Replacingdpwithdecimal_pointswould be backwards-incompatible, but I guess we could adddecimal_pointsas an alias ofdp.I agree
decimal_pointswould have been a better name from the start, though. For now I think we should keep the docs and the endpoint as they are.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍