Products > Brands > storefrontBrandsPage
Storefront APIProductsBrandsstorefrontBrandsPage
storefrontBrandsPage
GET:storefront/brands/page.json

Description

Get all brands.

See also: Pagination.

Topic: Brands

Arguments

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)


featured: Boolean

If set, show only featured brands


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)


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


sort_by: BrandsPageSortBy

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


sort_desc: Boolean

Whether to use descending sort order. See also: Pagination


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

StorefrontBrandPage

Preview (typescript)

Loading module