Skip to content

Add docs for /products endpoint new parameters #256

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jan 21, 2025
Merged

Add docs for /products endpoint new parameters #256

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5782a75
Add docs for `/products` endpoint new parameters
albarin Dec 11, 2024
bd4a237
Add info about how to specify multiple values
albarin Dec 11, 2024
6039647
Improve copy
albarin Dec 12, 2024
4c9449b
Add note about precedence
albarin Dec 12, 2024
9afb2bb
Add future option to status params
albarin Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion source/includes/wp-api-v3/_products.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1481,7 +1481,11 @@ woocommerce.get("products").parsed_response
| `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. |
| `status` | string | Limit result set to products assigned a specific status. Options: `any`, `draft`, `pending`, `private` and `publish`. Default is `any`. |
| `type` | string | Limit result set to products assigned a specific type. Options: `simple`, `grouped`, `external` and `variable`. |
| `include_status` | string | Limit result set to products with any of the specified statuses. Multiple statuses can be provided as a comma-separated list. Takes precedence over the `status` parameter. Options: `any`, `trash`, `draft`, `pending`, `private`, and `publish`.|
| `exclude_status` | string | Exclude products from result set with any of the specified statuses. Multiple statuses can be provided as a comma-separated list. Takes precedence over the `include_status` parameter. Options: `trash`, `draft`, `pending`, `private`, and `publish`.|
| `type` | string | Limit result set to products assigned a specific type. Options: `simple`, `grouped`, `external` and `variable`. |
| `include_types` | string | Limit result set to products with any of the types. Multiple statuses can be provided as a comma-separated list. Takes precedence over the `type` parameter. Options: `simple`, `grouped`, `external` and `variable`. |
| `exclude_types` | string | Exclude products from result set with any of the specified types. Multiple statuses can be provided as a comma-separated list. Takes precedence over the `include_types` parameter. Options: `simple`, `grouped`, `external` and `variable`. |
| `sku` | string | Limit result set to products with a specific SKU. |
| `featured` | boolean | Limit result set to featured products. |
| `category` | string | Limit result set to products assigned a specific category ID. |
Expand All @@ -1494,6 +1498,8 @@ woocommerce.get("products").parsed_response
| `min_price` | string | Limit result set to products based on a minimum price. |
| `max_price` | string | Limit result set to products based on a maximum price. |
| `stock_status` | string | Limit result set to products with specified stock status. Options: `instock`, `outofstock` and `onbackorder`. |
| `virtual` | boolean | Limit result set to virtual products. |
| `downloadable` | boolean | Limit result set to downloadable products. |

## Duplicate product ##

Expand Down