Skip to Content
BannersLocationsArchiveBanner

LocationsArchiveBanner

Archive/listing of locations, optionally with filters.

Includes the common banner props.

Locations archive preview

Props

id
string
required

CMS id.

hideFilters
boolean
required

If true, filters UI is hidden.

query
string
required

Backend query string used to fetch the listing.

URL filtering behavior

This archive currently does not sync filters to the URL (disableUrlSync: true in frontend).

  • No f= URL filter state is restored on page load.
  • CMS defaults from query are applied during initialization.
  • hideFilters only controls filter UI visibility for this archive type.

Supported query params

The query prop accepts a standard URL query string. Multiple params are combined via &. Repeating the same key applies a list filter.

ID

Filters by location id.

  • Key: ID
  • Type: string (repeatable)
  • Note: If at least one ID is present, all other archive filters are ignored. sort, order, and page-based load-more behavior still apply.

Examples:

ID=loc_123 ID=loc_123&ID=loc_456

ZIP code

Filters by locations zip code.

  • Key: ZIP_CODE
  • Type: string (repeatable)
  • Matching rule: zipCode in [values]

Examples:

ZIP_CODE=10115 ZIP_CODE=20095 ZIP_CODE=10115&ZIP_CODE=20095

Foreign Id

Filters by locations foreign id.

  • Key: FOREIGN_ID
  • Type: string (repeatable)
  • Matching rule: foreignId in [values] (case-insensitive)

Examples:

FOREIGN_ID=dealer_berlin FOREIGN_ID=DEALER_HAMBURG FOREIGN_ID=dealer_berlin&FOREIGN_ID=DEALER_HAMBURG

Combined examples

ZIP_CODE=10115
ZIP_CODE=10115&ZIP_CODE=20095&FOREIGN_ID=dealer_berlin

Sort options

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

Name

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

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

Address

  • Adresse (A–Z) sort=ADDRESS&order=ASC

  • Adresse (Z–A) sort=ADDRESS&order=DESC

ZIP Code

  • PLZ (A–Z) sort=ZIP_CODE&order=ASC

  • PLZ (Z–A) sort=ZIP_CODE&order=DESC

const banner: LocationsArchiveBanner = { typename: BannerTypename.LocationsArchiveBanner, id: 'b_123', title: 'Locations', titleTag: 'h2', titleAlign: 'left', cssId: null, cssClasses: null, hideFilters: false, query: 'ZIP_CODE=10115&FOREIGN_ID=dealer_berlin' };
Last updated on