Skip to content

Commit d93a0c4

Browse files
KonamimanKonamiman
authored
Merge pull request #203 from woocommerce/update/for-enhancement-28132
2 parents 93f8685 + 9315664 commit d93a0c4

18 files changed

+120
-105
lines changed

‎source/includes/wp-api-v1/_coupons.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -365,20 +365,21 @@ woocommerce.get("coupons").parsed_response
365365

366366
#### Available parameters ####
367367

368-
| Parameter | Type | Description |
369-
|------------|---------|---------------------------------------------------------------------------------------------------------------|
370-
| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. |
371-
| `page` | integer | Current page of the collection. |
372-
| `per_page` | integer | Maximum number of items to be returned in result set. |
373-
| `search` | string | Limit results to those matching a string. |
374-
| `after` | string | Limit response to resources published after a given ISO8601 compliant date. |
375-
| `before` | string | Limit response to resources published before a given ISO8601 compliant date. |
376-
| `exclude` | string | Ensure result set excludes specific ids. |
377-
| `include` | string | Limit result set to specific ids. |
378-
| `offset` | integer | Offset the result set by a specific number of items. |
379-
| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. |
380-
| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. |
381-
| `code` | string | Limit result set to resources with a specific code. |
368+
| Parameter | Type | Description |
369+
|-----------------|---------|---------------------------------------------------------------------------------------------------------------|
370+
| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. |
371+
| `page` | integer | Current page of the collection. |
372+
| `per_page` | integer | Maximum number of items to be returned in result set. |
373+
| `search` | string | Limit results to those matching a string. |
374+
| `after` | string | Limit response to resources published after a given ISO8601 compliant date. |
375+
| `before` | string | Limit response to resources published before a given ISO8601 compliant date. |
376+
| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. |
377+
| `exclude` | string | Ensure result set excludes specific ids. |
378+
| `include` | string | Limit result set to specific ids. |
379+
| `offset` | integer | Offset the result set by a specific number of items. |
380+
| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. |
381+
| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. |
382+
| `code` | string | Limit result set to resources with a specific code. |
382383

383384
## Update a coupon ##
384385

‎source/includes/wp-api-v1/_order-refunds.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -311,20 +311,21 @@ woocommerce.get("orders/116/refunds").parsed_response
311311

312312
#### Available parameters ####
313313

314-
| Parameter | Type | Description |
315-
|------------|---------|---------------------------------------------------------------------------------------------------------------|
316-
| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. |
317-
| `page` | integer | Current page of the collection. |
318-
| `per_page` | integer | Maximum number of items to be returned in result set. |
319-
| `search` | string | Limit results to those matching a string. |
320-
| `after` | string | Limit response to resources published after a given ISO8601 compliant date. |
321-
| `before` | string | Limit response to resources published before a given ISO8601 compliant date. |
322-
| `exclude` | string | Ensure result set excludes specific ids. |
323-
| `include` | string | Limit result set to specific ids. |
324-
| `offset` | integer | Offset the result set by a specific number of items. |
325-
| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. |
326-
| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. |
327-
| `dp` | string | Number of decimal points to use in each resource. |
314+
| Parameter | Type | Description |
315+
|-----------------|---------|---------------------------------------------------------------------------------------------------------------|
316+
| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. |
317+
| `page` | integer | Current page of the collection. |
318+
| `per_page` | integer | Maximum number of items to be returned in result set. |
319+
| `search` | string | Limit results to those matching a string. |
320+
| `after` | string | Limit response to resources published after a given ISO8601 compliant date. |
321+
| `before` | string | Limit response to resources published before a given ISO8601 compliant date. |
322+
| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. |
323+
| `exclude` | string | Ensure result set excludes specific ids. |
324+
| `include` | string | Limit result set to specific ids. |
325+
| `offset` | integer | Offset the result set by a specific number of items. |
326+
| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. |
327+
| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. |
328+
| `dp` | string | Number of decimal points to use in each resource. |
328329

329330
## Delete a refund ##
330331

‎source/includes/wp-api-v1/_orders.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1023,23 +1023,24 @@ woocommerce.get("orders").parsed_response
10231023

10241024
#### Available parameters ####
10251025

1026-
| Parameter | Type | Description |
1027-
|------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1028-
| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. |
1029-
| `page` | integer | Current page of the collection. |
1030-
| `per_page` | integer | Maximum number of items to be returned in result set. |
1031-
| `search` | string | Limit results to those matching a string. |
1032-
| `after` | string | Limit response to resources published after a given ISO8601 compliant date. |
1033-
| `before` | string | Limit response to resources published before a given ISO8601 compliant date. |
1034-
| `exclude` | string | Ensure result set excludes specific ids. |
1035-
| `include` | string | Limit result set to specific ids. |
1036-
| `offset` | integer | Offset the result set by a specific number of items. |
1037-
| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. |
1038-
| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. |
1039-
| `status` | string | Limit result set to orders assigned a specific status. Default is `any`. Options (plugins may add new status): `any`, `pending`, `processing`, `on-hold`, `completed`, `cancelled`, `refunded` and `failed`. |
1040-
| `customer` | string | Limit result set to orders assigned a specific customer. |
1041-
| `product` | string | Limit result set to orders assigned a specific product. |
1042-
| `dp` | string | Number of decimal points to use in each resource. |
1026+
| Parameter | Type | Description |
1027+
|-----------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1028+
| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. |
1029+
| `page` | integer | Current page of the collection. |
1030+
| `per_page` | integer | Maximum number of items to be returned in result set. |
1031+
| `search` | string | Limit results to those matching a string. |
1032+
| `after` | string | Limit response to resources published after a given ISO8601 compliant date. |
1033+
| `before` | string | Limit response to resources published before a given ISO8601 compliant date. |
1034+
| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. |
1035+
| `exclude` | string | Ensure result set excludes specific ids. |
1036+
| `include` | string | Limit result set to specific ids. |
1037+
| `offset` | integer | Offset the result set by a specific number of items. |
1038+
| `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. |
1039+
| `orderby` | string | Sort collection by object attribute. Default is `date`, Options: `date`, `id`, `include`, `title` and `slug`. |
1040+
| `status` | string | Limit result set to orders assigned a specific status. Default is `any`. Options (plugins may add new status): `any`, `pending`, `processing`, `on-hold`, `completed`, `cancelled`, `refunded` and `failed`. |
1041+
| `customer` | string | Limit result set to orders assigned a specific customer. |
1042+
| `product` | string | Limit result set to orders assigned a specific product. |
1043+
| `dp` | string | Number of decimal points to use in each resource. |
10431044

10441045
## Update an Order ##
10451046

‎source/includes/wp-api-v1/_products.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1913,6 +1913,7 @@ woocommerce.get("products").parsed_response
19131913
| `search` | string | Limit results to those matching a string. |
19141914
| `after` | string | Limit response to resources published after a given ISO8601 compliant date. |
19151915
| `before` | string | Limit response to resources published before a given ISO8601 compliant date. |
1916+
| `dates_are_gmt` | boolean | Interpret `after` and `before` as UTC dates when `true`. |
19161917
| `exclude` | string | Ensure result set excludes specific ids. |
19171918
| `include` | string | Limit result set to specific ids. |
19181919
| `offset` | integer | Offset the result set by a specific number of items. |

0 commit comments

Comments
 (0)