Banners
LocationsArchiveBanner

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.

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.

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

active=true&ZIP_CODE=10115
active=true&ZIP_CODE=10115&ZIP_CODE=20095&FOREIGN_ID=dealer_berlin

Sort options

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=zipCode&order=asc

  • PLZ (Z–A) sort=zipCode&order=desc

Banner example

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