contextstring
Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view.
One ofvieweditDefault "view"
pageinteger
Current page of the collection. Default is 1.
Default 1
per_pageinteger
Maximum number of items to be returned in result set. Default is 10.
Default 10
searchstring
Limit results to those matching a string.
afterstring (date-time)
Limit response to resources published after a given ISO8601 compliant date.
beforestring (date-time)
Limit response to resources published before a given ISO8601 compliant date.
excludearray<integer>
Ensure result set excludes specific IDs.
includearray<integer>
Limit result set to specific ids.
offsetinteger
Offset the result set by a specific number of items.
orderstring
Order sort attribute ascending or descending. Options: asc and desc. Default is desc.
One ofascdescDefault "desc"
orderbystring
Sort collection by object attribute. Options: date, modified, id, include, title and slug. Default is date.
One ofdatemodifiedidincludetitleslugDefault "date"
parentarray<integer>
Limit result set to those of particular parent IDs.
parent_excludearray<integer>
Limit result set to all items except those of a particular parent ID.
slugstring
Limit result set to products with a specific slug.
statusarray<string>
Limit result set to products assigned a specific status. Options: any, draft, pending, private and publish. Default is any.
include_statusarray<string>
Limit result set to product variations with any of the specified statuses. Multiple statuses can be provided as a comma-separated list. Takes precedence over the status parameter. Options: any, future, trash, draft, pending, private, and publish.
exclude_statusarray<string>
Exclude product variations 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: future, trash, draft, pending, private, and publish.
skustring
Limit result set to products with a specific SKU.
tax_classstring
Limit result set to products with a specific tax class. Default options: standard, reduced-rate and zero-rate.
One ofstandardreduced-ratezero-rate
on_saleboolean
Limit result set to products on sale.
min_pricestring
Limit result set to products based on a minimum price.
max_pricestring
Limit result set to products based on a maximum price.
stock_statusstring
Limit result set to products with specified stock status. Options: instock, outofstock and onbackorder.
One ofinstockoutofstockonbackorder
virtualboolean
Limit result set to virtual product variations.
downloadableboolean
Limit result set to downloadable product variations.
