Skip to content

Commit

Permalink
Update enums for orderby params
Browse files Browse the repository at this point in the history 
Fixes woocommerce/woocommerce#35619
  • Loading branch information
@coreymckrill
coreymckrill committed Jul 9, 2024
1 parent 9288ae0 commit 1a81bbb
Show file tree
Hide file tree
Showing 7 changed files with 72 additions and 72 deletions.
4 changes: 2 additions & 2 deletions source/includes/wp-api-v3/_coupons.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ woocommerce.get("coupons").parsed_response
#### 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`. |
Expand All @@ -407,7 +407,7 @@ woocommerce.get("coupons").parsed_response
| `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`, `id`, `include`, `title` and `slug`. Default is `date`. |
| `orderby` | string | Sort collection by object attribute. Options: `date`, `modified`, `id`, `include`, `title` and `slug`. Default is `date`. |
| `code` | string | Limit result set to resources with a specific code. |

## Update a coupon ##
Expand Down
2 changes: 1 addition & 1 deletion source/includes/wp-api-v3/_order-refunds.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ woocommerce.get("orders/723/refunds").parsed_response
| `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`, `id`, `include`, `title` and `slug`. Default is `date`. |
| `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`. |
Expand Down
42 changes: 21 additions & 21 deletions source/includes/wp-api-v3/_orders.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1174,28 +1174,28 @@ woocommerce.get("orders").parsed_response

#### 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. |
| `modified_after` | string | Limit response to resources modified after a given ISO8601 compliant date. |
| `modified_before` | string | Limit response to resources modified after a given ISO8601 compliant date. |
| `dates_are_gmt` | boolean | Whether to consider GMT post dates when limiting response by published or modified 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`, `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. |
| 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. |
| `modified_after` | string | Limit response to resources modified after a given ISO8601 compliant date. |
| `modified_before` | string | Limit response to resources modified after a given ISO8601 compliant date. |
| `dates_are_gmt` | boolean | Whether to consider GMT post dates when limiting response by published or modified 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. |
| `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`. |
| `customer` | integer | Limit result set to orders assigned a specific customer. |
| `product` | integer | Limit result set to orders assigned a specific product. |
| `dp` | integer | Number of decimal points to use in each resource. Default is `2`. |
| `customer` | integer | Limit result set to orders assigned a specific customer. |
| `product` | integer | Limit result set to orders assigned a specific product. |
| `dp` | integer | Number of decimal points to use in each resource. Default is `2`. |

## Update an Order ##

Expand Down
2 changes: 1 addition & 1 deletion source/includes/wp-api-v3/_product-variations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -619,7 +619,7 @@ woocommerce.get("products/22/variations").parsed_response
| `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`, `id`, `include`, `title` and `slug`. Default is `date`. |
| `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. |
| `slug` | string | Limit result set to products with a specific slug. |
Expand Down
Loading

0 comments on commit 1a81bbb

Please sign in to comment.