CollectionArchiveBanner

Archive/listing of Shopify collections, optionally with filters.

Includes the common banner props.

Collection archive banner

Props

id●

string

required

CMS id.

hideFilters●

boolean

required

If true, filter controls are hidden while the archive list remains visible.

query●

Array<QueryFilter>

required

CMS default filters applied on first render (depending on URL precedence rules).

Common filter origins

SHOP_COLLECTION (collection id)

URL filtering behavior

With hideFilters = false, URL filter state has priority over CMS defaults.
CMS defaults are used only when URL contains no filter state.
With hideFilters = true, URL filter state is ignored and CMS defaults are enforced.

Sort options

Use the serialized enum values from @haendlerapp/types/src/enums/SortOption.ts and OrderOption.ts when configuring CMS query params.

Name (A–Z) sort=NAME&order=ASC
Name (Z–A) sort=NAME&order=DESC

Example

const banner: CollectionArchiveBanner = {
  typename: BannerTypename.CollectionArchiveBanner,
  id: 'b_123',
  title: 'Collections',
  titleTag: 'h2',
  titleAlign: 'left',
  cssId: null,
  cssClasses: null,
  hideFilters: false,
  query: [{ origin: FilterOption.ShopifyCollection, value: 'gid://shopify/Collection/123' }]
};

ProductArchiveBanner UpsellBlockBanner