v2

latestOpenAPI 3.0.32026-08-04181201819.2 KB
Products

Retrieve Products filtered by status.

get/products/status/{status}.json

Path parameters

status'available' | 'not-available' | 'disabled' required

Status of the Product used as filter

Query parameters

localestring string

Locale code of the translation

fieldsstring string

Comma separated values of the fields to return for the Product. Allowed values: id, name, page_title, description, meta_description, price, cost_per_item, compare_at_price, weight, stock, stock_unlimited, stock_threshold, stock_notification, back_in_stock_enabled, sku, brand, barcode, featured, reviews_enabled, status, shipping_required, type, days_to_expire, created_at, updated_at, package_format, length, width, height, diameter, google_product_category, google_product_category_text, quotable, permalink, discount, categories, images, variants, fields, currency.

Response

OK