Skip to main content

shop.products.list(params?)

Returns a paginated list of visible products for the shop.

Parameters

ParamTypeDefaultDescription
limitnumber50Max products to return (max 100)
offsetnumber0Pagination offset
categorystringFilter by category name
searchstringSearch by product name
sort_by`‘created_at''name''price''sales''updated_at’`'created_at'Sort field
sort_order`‘asc''desc’`'desc'Sort direction

Response

Product type

Example — Product grid with pagination

Example — Category filter


shop.products.getBySlug(slug)

Returns a single product by its URL slug.

Parameters

ParamTypeDescription
slugstringThe product’s URL slug

Example — Product detail page

Returns ShopiError with status: 404 if the product does not exist or is not visible.