Skip to content

Commit 1a81bbb

Browse files
coreymckrillcoreymckrill
committed
Update enums for orderby params
Fixes woocommerce/woocommerce#35619
1 parent 9288ae0 commit 1a81bbb

File tree

7 files changed

+72
-72
lines changed

7 files changed

+72
-72
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ woocommerce.get("coupons").parsed_response
393393
#### Available parameters ####
394394

395395
| Parameter | Type | Description |
396-
| ----------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
396+
| ----------------- | ------- |------------------------------------------------------------------------------------------------------------------------------|
397397
| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`. |
398398
| `page` | integer | Current page of the collection. Default is `1`. |
399399
| `per_page` | integer | Maximum number of items to be returned in result set. Default is `10`. |
@@ -407,7 +407,7 @@ woocommerce.get("coupons").parsed_response
407407
| `include` | array | Limit result set to specific ids. |
408408
| `offset` | integer | Offset the result set by a specific number of items. |
409409
| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. |
410-
| `orderby` | string | Sort collection by object attribute. Options: `date`, `id`, `include`, `title` and `slug`. Default is `date`. |
410+
| `orderby` | string | Sort collection by object attribute. Options: `date`, `modified`, `id`, `include`, `title` and `slug`. Default is `date`. |
411411
| `code` | string | Limit result set to resources with a specific code. |
412412

413413
## Update a coupon ##

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ woocommerce.get("orders/723/refunds").parsed_response
484484
| `include` | array | Limit result set to specific ids. |
485485
| `offset` | integer | Offset the result set by a specific number of items. |
486486
| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. |
487-
| `orderby` | string | Sort collection by object attribute. Options: `date`, `id`, `include`, `title` and `slug`. Default is `date`. |
487+
| `orderby` | string | Sort collection by object attribute. Options: `date`, `modified`, `id`, `include`, `title` and `slug`. Default is `date`. |
488488
| `parent` | array | Limit result set to those of particular parent IDs. |
489489
| `parent_exclude` | array | Limit result set to all items except those of a particular parent ID. |
490490
| `dp` | integer | Number of decimal points to use in each resource. Default is `2`. |

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

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1174,28 +1174,28 @@ woocommerce.get("orders").parsed_response
11741174

11751175
#### Available parameters ####
11761176

1177-
| Parameter | Type | Description |
1178-
|-------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------|
1179-
| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`. |
1180-
| `page` | integer | Current page of the collection. Default is `1`. |
1181-
| `per_page` | integer | Maximum number of items to be returned in result set. Default is `10`. |
1182-
| `search` | string | Limit results to those matching a string. |
1183-
| `after` | string | Limit response to resources published after a given ISO8601 compliant date. |
1184-
| `before` | string | Limit response to resources published before a given ISO8601 compliant date. |
1185-
| `modified_after` | string | Limit response to resources modified after a given ISO8601 compliant date. |
1186-
| `modified_before` | string | Limit response to resources modified after a given ISO8601 compliant date. |
1187-
| `dates_are_gmt` | boolean | Whether to consider GMT post dates when limiting response by published or modified date. |
1188-
| `exclude` | array | Ensure result set excludes specific IDs. |
1189-
| `include` | array | Limit result set to specific ids. |
1190-
| `offset` | integer | Offset the result set by a specific number of items. |
1191-
| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. |
1192-
| `orderby` | string | Sort collection by object attribute. Options: `date`, `id`, `include`, `title` and `slug`. Default is `date`. |
1193-
| `parent` | array | Limit result set to those of particular parent IDs. |
1194-
| `parent_exclude` | array | Limit result set to all items except those of a particular parent ID. |
1177+
| Parameter | Type | Description |
1178+
|-------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1179+
| `context` | string | Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`. |
1180+
| `page` | integer | Current page of the collection. Default is `1`. |
1181+
| `per_page` | integer | Maximum number of items to be returned in result set. Default is `10`. |
1182+
| `search` | string | Limit results to those matching a string. |
1183+
| `after` | string | Limit response to resources published after a given ISO8601 compliant date. |
1184+
| `before` | string | Limit response to resources published before a given ISO8601 compliant date. |
1185+
| `modified_after` | string | Limit response to resources modified after a given ISO8601 compliant date. |
1186+
| `modified_before` | string | Limit response to resources modified after a given ISO8601 compliant date. |
1187+
| `dates_are_gmt` | boolean | Whether to consider GMT post dates when limiting response by published or modified date. |
1188+
| `exclude` | array | Ensure result set excludes specific IDs. |
1189+
| `include` | array | Limit result set to specific ids. |
1190+
| `offset` | integer | Offset the result set by a specific number of items. |
1191+
| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. |
1192+
| `orderby` | string | Sort collection by object attribute. Options: `date`, `modified`, `id`, `include`, `title` and `slug`. Default is `date`. |
1193+
| `parent` | array | Limit result set to those of particular parent IDs. |
1194+
| `parent_exclude` | array | Limit result set to all items except those of a particular parent ID. |
11951195
| `status` | array | Limit result set to orders assigned a specific status. Options: `any`, `pending`, `processing`, `on-hold`, `completed`, `cancelled`, `refunded`, `failed` and `trash`. Default is `any`. |
1196-
| `customer` | integer | Limit result set to orders assigned a specific customer. |
1197-
| `product` | integer | Limit result set to orders assigned a specific product. |
1198-
| `dp` | integer | Number of decimal points to use in each resource. Default is `2`. |
1196+
| `customer` | integer | Limit result set to orders assigned a specific customer. |
1197+
| `product` | integer | Limit result set to orders assigned a specific product. |
1198+
| `dp` | integer | Number of decimal points to use in each resource. Default is `2`. |
11991199

12001200
## Update an Order ##
12011201

‎source/includes/wp-api-v3/_product-variations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -619,7 +619,7 @@ woocommerce.get("products/22/variations").parsed_response
619619
| `include` | array | Limit result set to specific ids. |
620620
| `offset` | integer | Offset the result set by a specific number of items. |
621621
| `order` | string | Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`. |
622-
| `orderby` | string | Sort collection by object attribute. Options: `date`, `id`, `include`, `title` and `slug`. Default is `date`. |
622+
| `orderby` | string | Sort collection by object attribute. Options: `date`, `modified`, `id`, `include`, `title` and `slug`. Default is `date`. |
623623
| `parent` | array | Limit result set to those of particular parent IDs. |
624624
| `parent_exclude` | array | Limit result set to all items except those of a particular parent ID. |
625625
| `slug` | string | Limit result set to products with a specific slug. |

0 commit comments

Comments
 (0)