Products

The published catalog, as the shop's own storefront lists it: search, filter and sort products, and read one in full.

Reach them through $storefront->products. A publishable or a secret key reads them.

List products

$storefront->products->list(array $query = []): array

One numbered page of the products the storefront lists, filtered and sorted as its own catalog is. 20 per page by default, at most 50.

taxonomy takes term ids from any classifications, from taxonomies->terms(). Within a classification any chosen term matches, and every classification chosen must match.

Parameters

Query fields

Returns

An array with data (a list of ProductSummary), links and meta:

Errors

Example

$page = $storefront->products->list([
    'taxonomy' => [4],
    'inStock' => true,
    'sort' => 'price_asc',
    'page' => 2,
]);

foreach ($page['data'] as $product) {
    echo $product['name'], PHP_EOL;
}

Get a product

$storefront->products->get(string $slug): array

One published product in full, by its slug: its description, images, stock, categories, specifications, reviews and variants.

Parameters

Returns

A ProductDetail array:

Errors

Example

$product = $storefront->products->get('ceramic-mug');