Query Parameters
Scope under which the request is made; determines fields present in response.
view
, embed
Current page of the collection.
Maximum number of items to be returned in result set.
x <= 100
Limit results to those matching a string.
Limit response to resources published after a given ISO8601 compliant date.
Limit response to resources published before a given ISO8601 compliant date.
Limit response to resources modified after a given ISO8601 compliant date.
Limit response to resources modified before a given ISO8601 compliant date.
Whether to consider GMT post dates when limiting response by published or modified date.
Ensure result set excludes specific IDs.
Limit result set to specific IDs.
Offset the result set by a specific number of items.
Order sort attribute ascending or descending.
asc
, desc
Sort collection by object attribute.
date
, id
, include
, title
, slug
, price
, popularity
, rating
, menu_order
Limit result set to those of particular parent IDs.
Limit result set to all items except those of a particular parent ID.
Limit result set to products with a specific slug.
Limit result set to products assigned a specific status.
draft
, pending
, private
, publish
Limit result set to products assigned a specific type.
simple
, grouped
, external
, variable
Limit result set to products with a specific SKU.
Limit result set to featured products.
Limit result set to products assigned a specific category ID.
Limit result set to products assigned a specific tag ID.
Limit result set to products assigned a specific shipping class ID.
Limit result set to products with a specific attribute.
Limit result set to products with a specific attribute term ID (required an assigned attribute).
Limit result set to products with a specific tax class.
Limit result set to products on sale.
Limit result set to products based on a minimum price.
Limit result set to products based on a maximum price.
Limit result set to products with specified stock status.
instock
, outofstock
, onbackorder
Response
List of products.
Unique identifier for the product.
Product name.
Product slug.
Product URL.
Date when the product was created.
Date when the product was created in GMT.
Date when the product was last modified.
Date when the product was last modified in GMT.
Product type.
Product status.
Whether the product is featured.
Product catalog visibility.
Product description.
Product short description.
Product SKU.
Product price.
Product regular price.
Product sale price.
Date when the sale price starts.
Date when the sale price starts in GMT.
Date when the sale price ends.
Date when the sale price ends in GMT.
Product price HTML.
Whether the product is on sale.
Whether the product is purchasable.
Total number of sales.
Whether the product is virtual.
Whether the product is downloadable.
Download limit.
Download expiry.
External URL.
Button text.
Tax status.
Tax class.
Whether stock management is enabled.
Stock quantity.
Stock status.
Backorders status.
Whether backorders are allowed.
Whether the product is backordered.
Whether the product is sold individually.
Product weight.
Whether shipping is required.
Whether shipping is taxable.
Shipping class.
Shipping class ID.
Whether reviews are allowed.
Average rating.
Rating count.
Related product IDs.
Upsell product IDs.
Cross-sell product IDs.
Parent product ID.
Purchase note.
Variation IDs.
Grouped product IDs.
Menu order.