WebstoreModuleDto

Represents a module on a webstore: a self-contained block of content or functionality the template renders.

idFlakeIdRequired

created_atstringRequired

The date and time the module was created.

enabledbooleanRequired

Indicates whether the module is rendered. A disabled module keeps its settings but is not shown to customers.

sort_orderintegerRequired

The position of the module among the webstore's modules, lowest first.

typestringRequired

The kind of module. Decides which 'settings' it accepts and how the template renders it.

updated_atstringRequired

The date and time the module was last updated.

webstore_idFlakeIdRequired

ends_atstringOptional

The date and time the module stops being shown, or null to show it indefinitely.

settingsnullOptional

The module's type-specific configuration as a JSON object, or null when it has none.

starts_atstringOptional

The date and time the module starts being shown, or null to show it as soon as it is enabled.

Example

{
  "id": "411486491630370816",
  "created_at": "2024-01-01T00:00:00Z",
  "enabled": true,
  "sort_order": 0,
  "type": "string",
  "updated_at": "2024-01-01T00:00:00Z",
  "webstore_id": "411486491630370816",
  "ends_at": "2024-01-01T00:00:00Z",
  "settings": {},
  "starts_at": "2024-01-01T00:00:00Z"
}