v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Products

List products

Returns a paginated list of products.

To search for products, please have a look at our Search endpoint on what is supported.

🔒 Requires: products:read scope

get/products

Query parameters

afterinteger

The lower limit for the version numbers to be included in the response.

beforeinteger

The upper limit for the version numbers to be included in the response.

deletedboolean

Indicates whether deleted items should be included in the response.

page_sizeinteger

The maximum number of items to be returned in the response.

skustring

Allows loading a product by one of its SKUs. Note that all other query params are ignored if this is provided.

namestring

Allows loading products with the name provided in this parameter. This query typically retrieves all products from the product family with the provided name. Note that all other query parameters are ignored if this is provided.

family_namestring

Alias for 'name'. Allows loading products that belong to the family with the name provided in this parameter. Note that all other query parameters are ignored if this is provided.

includes[]string[]

Side-load related entities. Supported value 'composite_products'.

include_imagesboolean

Whether to include product image fields in the response. Defaults to true.

Response