v1

latestOpenAPI 3.0.02026-07-226950132.6 KB
products

Get products

Gets a list of products with optional filtering and pagination.

get/products

Query parameters

pageinteger

Current page of the collection.

per_pageinteger

Maximum number of items to return per page.

searchstring

Limit results to those matching a search string.

categorystring

Limit results to products in specific categories.

tagstring

Limit results to products with specific tags.

type'simple' | 'grouped' | 'external' | 'variable'

Limit results to products of specific type.

featuredboolean

Limit results to featured products.

on_saleboolean

Limit results to products on sale.

min_pricestring

Limit results to products with price greater than or equal to this value.

max_pricestring

Limit results to products with price less than or equal to this value.

stock_status'instock' | 'outofstock' | 'onbackorder'

Limit results to products with specified stock status.

orderby'date' | 'id' | 'include' | 'title' | 'slug' | 'price' | 'popularity' | 'rating' | 'menu_order' | 'alphabetical' | 'reverse_alpha' | 'relevance' | 'rand' | 'by_stock' | 'review_count' | 'on_sale_first' | 'featured_first' | 'price_asc' | 'price_desc' | 'sales'

Sort products by field.

order'ASC' | 'DESC'

Sort order.

slugstring

Limit result set to products with a specific slug.

afterstring date-time

Limit response to products created after a given ISO8601 compliant date.

beforestring date-time

Limit response to products created before a given ISO8601 compliant date.

skustring

Limit result set to products with specific SKU(s). Use commas to separate.

hide_freeboolean

Limit result set to hide free products.

category_operator'in' | 'not_in' | 'and'

Operator to compare product category terms.

tag_operator'in' | 'not_in' | 'and'

Operator to compare product tags.

brandstring

Limit result set to products assigned a set of brand IDs or slugs, separated by commas.

brand_operator'in' | 'not_in' | 'and'

Operator to compare product brand terms.

show_reviewsboolean

Returns product reviews for all products or an individual product.

return_variationsboolean

Returns all variations for variable products.

attribute_relation'in' | 'and'

The logical relationship between attributes when filtering across multiple at once.

catalog_visibility'any' | 'visible' | 'catalog' | 'search' | 'hidden'

Determines if hidden or visible catalog products are shown.

ratinginteger[]

Limit result set to products with a certain average rating.

offsetinteger

Offset the result set by a specific number of items.

includeinteger[]

Limit result set to specific IDs.

excludeinteger[]

Ensure result set excludes specific IDs.

parentinteger[]

Limit result set to those of particular parent IDs.

parent_excludeinteger[]

Limit result set to exclude particular parent IDs.

Response

Products retrieved successfully.

pageinteger

Current page number

total_pagesinteger

Total number of pages

total_productsinteger

Total number of products