`GridConfig`

The store's Grid Config JSON as stored in redis (JSON.GET on the store config key). It is a merchant-editable document; only the top-level keys observed in defaults (libs/shared/src/classes/defaults/grid.ts) and the e2e fakes are pinned, everything else is open.

RELATED (deliberately NOT merged): the admin surface's admin.GridConfig types the SAME document as the strict DB entity shape (libs/database store.entity.ts GridConfig) served/accepted by GET/POST /app/grid. This storefront view stays loose because the redis copy is merchant-edited and the storefront never validates it.

Type: object

Field Type Description

grid optional

object

The grid layout (admin grid editor).

Fields

Field Type Description

elements optional

{ [key]: any }

Fields

Field	Type	Description
`[key: string]`	any	Any further keys.

core optional

{ [key]: any }

Fields

Field	Type	Description
`[key: string]`	any	Any further keys.

breakpoints optional

object[]

Fields

Field	Type	Description
`index`	number
`label`	string
`minwidth`	number
`columns`	number
`format`	string
`[key: string]`	any	Any further keys.

currentBreakpoint optional

{ [key]: any }

Fields

Field	Type	Description
`[key: string]`	any	Any further keys.

styles optional string

[key: string]

any

Any further keys.

currency optional

string

The mapping keys storefronts and Collection Kit bundles read (kit-contract/v1 GridConfig).

locale optional string

delimiter optional string

sizeMapping optional any

colourMapping optional

{ [key]: string }

Fields

Field	Type	Description
`[key: string]`	string	Any further keys.

imageMapping optional

{ [key]: string }

Fields

Field	Type	Description
`[key: string]`	string	Any further keys.

facetMapping optional any

integrations optional any

skuSearch optional any

[key: string]

any

Any further keys.

Example (illustrative)

{
  "grid": {
    "elements": {
      "key": null
    },
    "core": {
      "key": null
    },
    "breakpoints": [
      {
        "index": 1,
        "label": "string",
        "minwidth": 1,
        "columns": 1,
        "format": "string"
      }
    ],
    "currentBreakpoint": {
      "key": null
    },
    "styles": "string"
  },
  "currency": "AUD",
  "locale": "string",
  "delimiter": "string",
  "sizeMapping": null,
  "colourMapping": {
    "key": "#1f6feb"
  },
  "imageMapping": {
    "key": "string"
  },
  "facetMapping": null,
  "integrations": null,
  "skuSearch": null
}

Used by

Declared in api-types/src/storefront/models.ts.