Products > Products > productsPage
Commerce APIProductsProductsproductsPage
productsPage
GET:products/page.json

Description

Get all products.

See also: Pagination.

Permission bit: "products.read"

Topic: Products

Arguments

brand_id: String

Filter output by brand


category_id: String

Filter output by product category


created_at_max: String

Filter output by creation date, upper boundary

Timestamp (RFC 3339)


created_at_min: String

Filter output by creation date, lower boundary

Timestamp (RFC 3339)


last_key: String

Key of the last item from previous page. See also: Pagination


limit: Int

Return up to N entries (pagination). See also: Pagination


offset: Int

Skip N entries (pagination). See also: Pagination


published_at_max: String

Filter output by publication date, upper boundary

Timestamp (RFC 3339)


published_at_min: String

Filter output by publication date, lower boundary

Timestamp (RFC 3339)


sales_channel_id: String

Filter output by sales channel


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


sort_by: ProductsPageSortBy

Whether to sort output in some specific way. See also: Pagination


sort_desc: Boolean

Whether to use descending sort order. See also: Pagination


status: PublishedStatus

Filter output by published status


updated_at_max: String

Filter output by last update date, upper boundary

Timestamp (RFC 3339)


updated_at_min: String

Filter output by last update date, lower boundary

Timestamp (RFC 3339)


Result

ProductPage

Preview (typescript)

Loading module