Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
ExplorePublic APIManagement API
Users APIOperations APIMessaging APIReporting APIML APIData API
ExplorePublic APIManagement API
Users APIOperations APIMessaging APIReporting APIML APIData API
  1. Components
  • Introduction
  • Core
    • Privacy Policy
      • Introduction
      • Show Privacy Policy
      • Update Privacy Policy
    • Community
      • Community Model
      • Show Community
      • Update Community
    • Loyalty Clubs
      • Show Loyalty Club
      • Update Loyalty Club
    • Applications
      • Application model
      • List applications
      • Create application
      • Update application
      • Show application
      • Destroy application
    • Branding
      • Show loyalty club branding
      • Show application branding
      • Update application branding
      • Duplicate application branding
      • Destroy application branding
    • Cookie Policy
      • Show Cookie Policy
      • Update Cookie Policy
    • Terms
      • Introduction
      • Show Terms
      • Update Terms
    • Domains
      • Introduction
      • List Domains
      • Show Domain
      • Create Domain
      • Destroy Domain
    • Domain Email Configs
      • Introduction
      • Show Domain Email Config
      • Create Domain Email Config
      • Destroy Domain Email Config
    • Domain Web Configs
      • Introduction
      • Show Domain Web Config
      • Create Domain Web Config
      • Destroy Domain Web Config
    • TLS Certificates
      • Introduction
      • List TLS Certificates
      • Show TLS Certificate
      • Create TLS Certificate
      • Update TLS Certificate
      • Destroy TLS Certificate
    • Links
      • Introduction
      • List Links
      • Show Link
      • Enable Link
      • Disable Link
      • Create Link
      • Delete Link
      • Generate Link
    • Fonts
      • Introduction
      • List Fonts
      • Show Font
      • Create Font
      • Enable Font
      • Disable Font
      • Update Font
      • Destroy Font
    • Subunits
      • Introduction
      • List Subunits
      • Show Subunit By External ID
      • Show Subunit
      • Create Subunit
      • Update Subunit
      • Destroy Subunit
    • Subunits Scopes
      • Introduction
      • List Subunits Scopes
      • Show Subunits Scope
      • Create Subunits Scope
      • Update Subunits Scope
      • Destroy Subunits Scope
    • Contacts
      • Introduction
      • List Customer Contacts
      • Show Customer Contact
      • Create Customer Contact
      • Update Customer Contact
      • Destroy Customer Contact
      • List Organization Contacts
      • Show Organization Contact
      • Create Organization Contact
      • Update Organization Contact
      • Destroy Organization Contact
    • Translations
      • [DRAFT] Show Loyalty Club Translations
    • Promotions Policy
      • Introduction
      • Show Promotions Policy
      • Update Promotions Policy
    • Tracker
      • Show Loyalty Club Configuration
      • Update Loyalty Club Configuration
      • List tracked links
      • Show tracked link
    • Social Logins
      • List configurations
      • Show configuration
      • Create configuration
      • Update configuration
      • Destroy configuration
    • Billing
      • Service Quotas
        • ServiceQuotasConfig Model
        • List Service quotas configs
        • Create Service quotas config
        • Show Service quotas config
        • Update Service quotas config
        • Delete Service quotas config
      • Recurring Charges
        • RecurringCharge Model
        • Archieve Recurring charge
        • Restore Recurring charge
        • List Recurring charges
        • Create Recurring charge
        • Show Recurring charge
        • Update Recurring charge
        • Delete Recurring charge
      • Service Usages
        • History
          • Show Service Usage History
        • List Service Usages
      • Customer Accoutning Configurations
        • Show customer accoutning configuration
        • Update customer accoutning configuration
      • Show billing summary
      • Show billing breakdown
      • Show billing balance
      • Show billing manual balance changes
      • Add billing manual balance changes Copy
    • SMS Sender Identities
      • Introduction
      • List Sms Sender Identities
    • Member Authentication Configuration
      • Show loyalty club member authentication configuration
      • Show application member authentication configuration
      • Update member authentication configuration
      • Duplicate application member authentication configuration
      • Destroy member authentication configuration
    • Sender Identities
      • SMS Sender Identities
        • Introduction
        • List SMS Sender Identity
        • Show SMS Sender Identity
        • Create SMS Sender Identity
        • Update SMS Sender Identity
        • Delete SMS Sender Identity
      • Email Sender Identities
        • Introduction
        • List Email Sender Identities
        • Show Email Sender Identity
        • Create Email Sender Identity
        • Update Email Sender Identity
        • Delete Email Sender Identity
  • Members
    • Listing Members
      • List Members
      • List Members By Audience
    • Member Profile
      • Public Info
        • Show Member Public Info
        • Show Member Public Info by MSISDN
        • Show Member Public Info by Email
      • Person ID
        • Show Member Person ID
        • Show Member Person ID by MSISDN
        • Show Member Person ID by Email
      • Cars
        • Introduction
        • List Member Cars
        • Create Member Car
        • Show Member Car
        • Find Member Car By LPN
        • Find Member Car By Hashed LPN
        • Update Member Car
        • Renew Member Car
        • Destroy Member Car
        • Lookup a Car
      • Children
        • MemberChild Model
        • List Member Children
        • Register Member Child
        • Show Member Child
        • Update Member Child
        • Unregister Member Child
      • Groups
        • Add Member to Group
        • Remove Member from a Group
        • List Members of a Group
        • List Groups of a Member By MSISDN
        • List Groups of a Member by Email
        • List Groups of a Member
        • Add Members to Group
        • Remove Members from Group
      • Programs
        • By Member Token
          • List Member Programs
          • Update Member Programs
          • Add Member to Program
          • Remove Member from Program
        • List Member Programs
        • Update Member Programs
        • Add Member to Program
        • Remove Member from Program
      • Benefits
        • Introduction
        • List Member Benefits
        • Show Member Benefit
        • Show Member Parking Benefit By Car LPN
        • Show Member Parking Benefit By Hashed Car LPN
      • Offers
        • Show Offers Meta
        • Show Offer
        • Encode Offer
        • List Offers
        • Use Offer
        • Like Offer
        • Unlike Offer
        • Grant Offer
      • Rewards
        • Show Member Rewards Status
        • Grant Points
        • Cancel Transaction
      • Export
        • Export Member
        • Download Member Export
      • Misc
        • Show Member Messages History
        • Show Member Profile History
        • Generate Link
      • Create Member
      • Update Member
      • Validate Member
      • Register Member App Token
      • Show Member
      • Show Member By MSISDN
      • Show Member By Email
      • Show Member By Encrypted ID
      • Show Member By User ID
      • Destroy Member
    • Imports
      • Introduction
      • Create Members Import Request
      • Show Members Import Status
      • Show Members Import Bulk Status By Request Number
      • Show Members Import Bulk Status
    • Groups
      • Introduction
      • Groups
        • List Member Groups
        • Show Member Group
        • Create Member Group
        • Update Member Group
        • Destroy Member Group
      • Types
        • List Member Groups Types
    • Programs
      • Introduction
      • Create Program
      • List Programs
      • Show Program
      • Update Program
      • Destroy Program
    • Benefits
      • Introduction
      • Create Benefit
      • List Benefits
      • Show Benefit
      • Update Benefit
      • Archive Benefit
      • Restore Benefit
      • Destroy Benefit
    • Cars
      • Show Cars Configuration
      • Update Cars Configuration
    • Webhooks
      • Introduction
      • Subscriptions Management
        • List Members Notifications Subscriptions
        • Create Members Notifications Subscription
        • Update Members Notifications Subscription
        • Destroy Members Notifications Subscription
    • Misc
      • Generate Link
    • Receipts
      • Introduction
      • List Submissions
      • Show Submission
      • Update Submission
      • Check Limits Exceeded
    • Messages
      • Send "delivered" event for push message
      • Send "open" event for push message
  • Stores
    • V4 API
      • Stores
        • Store Model
        • List Stores
        • Show Store
        • Create Store
        • Update Store
        • Archive Store
        • Restore Store
        • Destroy Store
        • Update Store receipt information
      • Retailers
        • Retailer Model
        • List Retailers
        • Show Retailer
      • Categories
        • StoreCategory Model
        • List Stores Categories
        • Show Stores Category
        • Create Stores Category
        • Update Stores Category
        • Destroy Stores Category
      • Store Categories
        • Add Store To Category
        • Remove Store From Category
        • Bulk Update Store Categories
    • V3 API
      • Stores
        • List Stores
        • Show Store By Store ID
        • Show Store
        • Create Store
        • Update Store By Store ID
        • Update Store
        • Delete Store By Store ID
        • Delete Store
        • List User Stores
      • Categories
        • List Store Categories
      • Zones
        • List Stores Zones
      • Floors
        • List Stores Floors
      • Tenant Categories
        • List Stores Tenant Categories
      • Store events
        • Create Store Event
      • Departments
        • List Store Departments
        • Show Store Department By Department ID
        • Create Store Department
        • Update Store Department by Department ID
        • Update Store Department
  • Offers
    • Introduction
    • Offers
      • Show Offer
      • List Offers
      • List Offers Groups
      • Create Offers
      • Update Offers
      • Clone Offers
      • Grant Offers
      • Archive Offers
    • Collections
      • List Collections
      • Show Collection
      • Create Collection
      • Update Collection
      • Archive Collection
      • Update Collections Order
    • Image Templates
      • Introduction
      • List Offer Image Templates
      • Show Offer Image Template
      • Preview Offer Image Template
      • Create Offer Image Template
      • Update Offer Image Template
      • Destroy Offer Image Template
    • Files
      • Introduction
      • Show File Schema
  • Rewards
    • Points expiration notifications policy
      • Introduction
      • Show Points Expiration Notifications Policy
      • Update Points Expiration Notifications Policy
  • Triggerer
    • Rules
      • Introduction
      • List Triggerer Rules
      • Show Triggerer Rule
      • Create Triggerer Rule
      • Update Triggerer Rule
      • Pause Triggerer Rule
      • Start Triggerer Rule
      • Delete Triggerer Rule
    • Event Types Schema
      • Show Event Types Schema
    • Point Multipliers
      • Introduction
      • List Point Multipliers
      • Show Point Multiplier
      • Create Point Multiplier
      • Update Point Multiplier
      • Destroy Point Multiplier
  • CMS
    • Introduction
    • Venue Info
      • Introduction
      • Show Venue Info
      • Update Venue Info
    • Pages
      • Page Model
      • Components
        • Component Model and Schema
        • System Components
        • Custom Components
          • Introduction
          • List Custom Components
          • Show Custom Component
          • Create Custom Component
          • Update Custom Component
          • Archive Custom Component
          • Restore Custom Component
          • Destroy Custom Component
        • Show Components Schema
          GET
        • Validate Component
          POST
      • List Services
        GET
      • List Pages
        GET
      • Show Page
        GET
      • Create Page
        POST
      • Update Page
        PUT
      • Archive Page
        PUT
      • Restore Page
        PUT
      • Destroy Page
        DELETE
      • List Merge Properties
        GET
    • Website
      • Website Model
      • Website Domains
        • Introduction
        • List Website Domains
        • Show Website Domain
        • Create Website Domain
        • Update Website Domain
        • Destroy Website Domain
      • Show Website
      • Update Website
    • Landing Pages
      • Introduction
      • Landing Page Templates
        • Introduction
        • Bee Templates
          • Introduction
          • List Bee Landing Page Templates
          • List Bee Landing Page Templates Tags
          • Show Bee Landing Page Templates
        • List Landing Page Templates
        • Show Landing Page Template
        • Create Landing Page Template
        • Update Landing Page Template
        • Destroy Landing Page Template
      • List Landing Pages
      • Show Landing Page
      • Create Landing Page
      • Update Landing Page
      • Archive Landing Page
      • Restore Landing Page
      • Destroy Landing Page
    • Articles
      • Article Model
      • Articles Categories
        • List Articles Categories
        • Show Articles Category
        • Create Articles Category
        • Update Articles Category
        • Destroy Articles Category
      • List Articles
      • Show Article
      • Create Article
      • Update Article
      • Archive Article
      • Restore Article
      • Destroy Article
    • Events
      • Event Model
      • Events Groups
        • Introduction
        • List Events Groups
        • Show Events Group
        • Create Events Group
        • Update Events Group
        • Destroy Events Group
      • Events Categories
        • List Events Categories
        • Show Events Category
        • Create Events Category
        • Update Events Category
        • Destroy Events Category
      • List Events
      • Show Event
      • Create Event
      • Update Event
      • Archive Event
      • Restore Event
      • Destroy Event
    • Job Postings
      • Introduction
      • List Job Postings
      • Show Job Posting
      • Create Job Posting
      • Update Job Posting
      • Archive Job Posting
      • Restore Job Posting
      • Destroy Job Posting
    • Press Releases
      • PressRelease Model
      • List Press Releases
      • Show Press Release
      • Create Press Release
      • Update Press Release
      • Archive Press Release
      • Restore Press Release
      • Destroy Press Release
    • Tags
      • Tag Model
      • List Tags
      • Show Tag
      • Create Tag
      • Update Tag
      • Destroy Tag
    • Attachments
      • Attachment Model
      • List attachments
      • Show Attachment
      • Create Attachment
      • Update Attachment
      • Destroy Attachment
    • Service Messages
      • Introduction
      • List Service Messages
      • Show Service Message
      • Create Service Message
      • Update Service Message
      • Archive Service Message
      • Restore Service Message
      • Destroy Service Message
    • Mixed Content
      • Search Mixed Content
    • Redirections
      • Redirection Model
      • List Redirections
      • Show Redirection
      • Create Redirection
      • Update Redirection
      • Archive Redirection
      • Restore Redirection
      • Destroy Redirection
  • Events
    • Events
      • List Events
      • Show Event
      • Check Member Status
    • Checkins
      • Checkin Member to the Event
      • List Checkins
    • Invitations
      • Send Invitation
    • Registration
      • List Events
      • Show Event
      • Show Calendar
      • Register Member
      • Unregister Member
      • Show Member Available Actions
  • Games
    • Add Languages to Game
    • Add Component to Game
    • Show Game Schema
    • Show Single Game Schema
    • Show Game Components
    • List Games
    • Update Game Component
    • Delete Component Data
    • Show Game Details
    • Create Game
    • Update Game
    • Delete Game
    • Show Game Languages
  • Scraper
    • Scraper
      • Run Scraper
    • Shopping mall
      • List Scraped Shopping Malls
      • Show Scraped Shopping Mall
      • Add Scraped Shopping Mall
      • Update Scraped Shopping Mall
      • Delete Scraped Shopping Mall
    • Shopping mall language
      • List Scraped Languages
      • Show Scraped Language
      • Add Scraped Language
      • Update Scraped Language
      • Delete Scraped Language
    • Menu item
      • List Scraped Menu Items
      • Show Scraped Menu Item
      • Add Scraped Menu Item
      • Update Scraped Menu Item
      • Delete Scraped Menu Item
  • Files
    • Introduction
    • Uploads
      • Start Upload
      • Upload Part
      • Finish Upload
      • Activate Uploaded File
      • Upload status
    • Upload from URL
    • List File Records
    • Destroy File Records
  • Receipts
    • Introduction
    • Loyalty Club Configuration
    • Receipt Submissions
    • Show Receipts Configuration
    • Update Receipts Configuration
    • Show Receipt Submission
    • Update Receipt Submissions
    • List Receipt Submissions
  • Messaging History
    • Messages List v2
    • Show Choosen Member Messages History v2
    • Messages List
  1. Components

System Components

article_container#

Represents container for Article

Example#

{
  "type": "article_container",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "Article" },
}

articles_list_container#

Represents container for Articles List

Example#

{
  "type": "articles_list_container",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "Articles List" },
}

carousel#

Represents slideshow of "screens" consisting of image, text and/or link.

Example#

{
  "type": "carousel",
  "visible_since": "2022-10-07T07:44:34.534Z",
  "visible_until": "2024-07-09T01:44:58.684Z",
  "title": { "en": "Carousel", "pl": "Karuzela" },
  "slides": [
    {
      "visible_since": "2023-03-08T21:07:34.372Z",
      "visible_until": "2024-01-03T20:17:01.416Z",
      "layout": "split",
      "position": "top",
      "background_color": "#FF00FF",
      "title": { "text": { "en": "Title", "pl": "Tytuł" }, "color": "#ffffff" },
      "subtitle": { "text": { "en": "Subtitle", "pl": "Subtytuł" }, "color": "#000fff" },
      "link": {
        "text": { "en": "Link", "pl": "Odnośnik" },
        "url": "https://dakotalapse.com/",
        "link_opens_new_tab": true
      },
      "image": {
        "url": "https://cdn-files.dev.placewise.com/files/cNxZL2C4-sSH8NvN3fNM2N6_rHoz1mlYY1oxcmlPaHpvTA"
      }
    }
  ]
}

connect_form#

Member enrolment form for the profile or newsletter programme (depending on which option is selected).

Example#

{

    "type": "connect_form",
    "cta": {
        "en": null,
        "fi": "Call to action",
        "pl": null
    },
    "body": {
        "en": null,
        "fi": "Blocks body",
        "pl": null
    },
	"image": {
		"url": "https://url.com"
	},
    "title": {
        "en": null,
        "fi": "Title",
        "pl": null
    },
    "sub_title": {
        "en": null,
        "fi": "Subtitle",
        "pl": null
    },
    "privacy_text": {
        "en": null,
        "fi": "Privacy text",
        "pl": null
    },
	"visible_until": "2024-09-28T11:01:00+0200",
	"visible_since": "2024-09-05T11:00:00+0200"
}

contact_form#

Section to display contact form

Example#

{
    "type": "contact_form",
    "title": { "fi": "Title", "en": null, "pl": null },
    "visible_until": "2024-09-18T11:01:00+0200",
    "visible_since": "2024-09-06T11:00:00+0200",
}

contacts#

Grid for displaying photo and contact details.

Example#

{
    "title": 'Title',
    "type": "contacts",
    "items": [
        {
            "name": {
                "fi": "First name",
                "en": null,
                "pl": null
            },
            "position": {
                "fi": "Position",
                "en": null,
                "pl": null
            },
            "department": {
                "fi": "Department",
                "en": null,
                "pl": null
            },
            "phone": {
                "fi": "+1 123-123-123",
                "en": null,
                "pl": null
            },
            "email": "email@email.com",
            "image": {
				"url": "https://url.com"
			}
        }
    ],
	"visible_until": "2024-09-28T11:01:00+0200",
	"visible_since": "2024-09-05T11:00:00+0200"
}

cta_section#

Banner with formated text, optionally with dark-coloured buttons.

Example#

{
    "title": null,
    "type": "cta_section",
    "sub_title": {
        "fi": "Subtitle",
        "en": null,
        "pl": null
    },
    "body": {
        "fi": "Body",
        "en": null,
        "pl": null
    },
    "background": {
		"url": "https://url.com"
	},
    "links": [
        {
            "link": {
                "text": {
                    "fi": "Cta on the button",
                    "en": null,
                    "pl": null
                },
                "url": "https://google.com",
                "target": "blank"
            }
        }
    ],
	"visible_until": "2024-09-28T11:01:00+0200",
	"visible_since": "2024-09-05T11:00:00+0200"
}

cta_with_buttons#

Image with header, text and optional buttons.

Example#

{
	"title": {
	    "fi": "title",
	    "en": null,
	    "pl": null
	},
	"visible_until": "2024-09-27T11:01:00+0200",
	"visible_since": "2024-09-04T11:00:00+0200",
	"type": "cta_with_buttons",
	"header": "Header",
	"content": "Content",
	"image": {
		"url": "https://url.com"
	},
	"buttons": [
	    {
	        "link": {
	            "text": {
	                "fi": "Button CTA",
	                "en": null,
	                "pl": null
	            },
	            "url": "http://google.com",
	            "target": "blank"
	        }
	    }
	]
}

data_points#

Section to display statistics, allows to display label and value.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-18T11:01:00+0200",
    "visible_since": "2024-09-06T11:00:00+0200",
    "type": "data_points",
    "items": [
        {
            "label": {
                "fi": "Label",
                "en": null,
                "pl": null
            },
            "value": {
                "fi": "Value %",
                "en": null,
                "pl": null
            }
        }
    ]
}

directions#

Location of the venue on the map with description and a button.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-20T11:01:00+0200",
    "visible_since": "2024-09-11T11:00:00+0200",
    "type": "directions",
    "description": {
        "fi": "Description",
        "en": null,
        "pl": null
    },
    "cta": {
        "fi": "CTA",
        "en": null,
        "pl": null
    }
}

directory_preview#

Displays CMS stores in the grid layout, can include categories.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-20T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "directory_preview",
    "categories_count": 2,
    "categories_order": [
        {
            "category": "shopping"
        },
        {
            "category": "dining"
        }
    ]
}

diumvirate#

Two linked images, placed in a side-by-side view.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-26T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "diumvirate",
    "items": [
        {
            "title": {
                "fi": "Title",
                "en": null,
                "pl": null
            },
            "sub_title": {
                "fi": "Subtitle",
                "en": null,
                "pl": null
            },
            "image": {
				"url": "https://url.com"
			},
            "link": {
                "text": {
                    "fi": "CTA",
                    "en": null,
                    "pl": null
                },
                "url": "https://google.com",
                "target": "blank"
            }
        },

        {
            "title": {
                "fi": "Title",
                "en": null,
                "pl": null
            },
            "sub_title": {
                "fi": "Subtitle",
                "en": null,
                "pl": null
            },
            "image": {
				"url": "https://url.com"
			},
            "link": {
                "text": {
                    "fi": "CTA",
                    "en": null,
                    "pl": null
                },
                "url": "https://google.com",
                "target": "blank"
            }
        }
    ]
}

event_container#

Represents container for Event

Example#

{
  "type": "event_container",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "Event" },
}

events_list_container#

Represents container for Events List

Example#

{
  "type": "events_list_container",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "Events List" },
}

featured_articles_carousel#

Displays CMS articles as slides in the carousel layout.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "featured_articles_carousel"
}

featured_elements#

Displays CMS events and manually added elements.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "featured_elements",
    "elements": [
        {
            "title": {
                "fi": "Title",
                "en": null,
                "pl": null
            },
            "sub_title": {
                "fi": "Subtitle",
                "en": null,
                "pl": null
            },
            "location": {
                "fi": "Location",
                "en": null,
                "pl": null
            },
            "description": {
                "fi": "\u003cp\u003eDescription\u003c/p\u003e",
                "en": null,
                "pl": null
            },
            "image": null,
            "link": {
                "text": {
                    "fi": "CTA",
                    "en": null,
                    "pl": null
                },
                "url": "http://google.com",
                "target": "blank"
            }
        }
    ]
}

featured_events#

Displays latest or related CMS events.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "featured_events"
}

featured_events_carousel#

Displays CMS events as scrolling carousel slides.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "featured_events_carousel"
}

featured_stores#

For the Store page.
Displays related Stores.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "featured_stores"
}

footer_1#

Represents footer variant for layout.

Example#

{
  "type": "footer_1",
  "links_1": {
    "children": [
      { "label": { "text": { "en": "Home" }, "url": "website://service_page?service=home_page" } },
      { "label": { "text": { "en": "Deals" }, "url": "website://service_page?service=promotions_list" } },
    ]
  },
  "links_2": {
    "children": [
      { "label": { "text": { "en": "About" }, "url": "website://page?id=15" } },
      { "label": { "text": { "en": "Download the App" }, "url": "https://play-store.com/app" } }
    ]
  },
  "social_media": true,
  "call_to_action_1": {
    "target": "self",
    "text": { "en":  "Register" },
    "url": "website://page?id=24"
  },
  "call_to_action_2": {
    "target": "blank",
    "text": { "en":  "Promotions" },
    "url": "https://example.com/promotions"
  }
}

gallery#

A photo grid that allows to download a photo or display it in a modal.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "gallery",
    "download": null,
    "images": [
        {
            "image": {
                "url": "https://url.com"
            }
        }
    ]
}

header_1#

Represents header variant for layout.

Example#

{
  "type": "header_1",
  "opening_hours": false,
  "weather_forecast": true,
  "logo": { "url": "https://placewise.com/image-90949191.jpg" },
  "site_menu": {
    "children": [
      { "label": { "text": "Home", "url": "website://service_page?service=home_page" } },
      { "label": { "text": "Deals", "url": "website://service_page?service=promotions_list" } },
      { "label": { "text": "About", "url": "website://page?id=15" } },
      { "label": { "text": "Download the App", "url": "https://play-store.com/app" } },
      {
        "label": { "text": "News" },
        "children": [
          { "label": { "text": "Events", "url": "website://service_page?service=events" } },
          { "label": { "text": "Articles", "url": "website://service_page?service=articles" } }
        ]
      }
    ]
  }
}

home_hero#

Displays home hero carousel.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "home_hero"
}

hours_calendar#

Opening hours of the venue on particular days, from Venue info.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "hours_calendar"
}

html_block#

Represents simple block of HTML content.

Example#

{
  "type": "html_block",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "Hi there!", "pl": "Cześć!" },
  "body": { "en": "<p>What's up?</p>", "pl": "<p>Jak leci?</p>" }
}

iframe#

An inline frame displaying another website.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "iframe",
    "url": "http://google.com",
    "width": "full",
    "height": 500
}

job_container#

Represents container for Job

Example#

{
  "type": "job_container",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "Job" },
}

jobs_list_container#

Represents container for Jobs List

Example#

{
  "type": "jobs_list_container",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "Jobs List" },
}

map#

Standalone map of the venue.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "map"
}

movies_browser#

Movies feed

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "movies_browser"
}

movies_carousel#

For movie page
Movies feed as a carousel with one item selected.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "movies_carousel"
}

page_content#

Represents dummy page in layout.

Example#

{
  "type": "page_content"
}

popup_image#

Represents slideshow of informational notices consisting of text and/or link.

Example#

{
  "type": "popup_image",
  "title": { "en": "Popup" },
  "image": { "url": "https://example.com" },
  "link": {
    "url": "https://example.com",
    "text": { "en": "Click me" },
    "target": "self"
  }
}

press_browser#

Press releases feed

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "press_browser"
}

press_browser#

For press releases page
Press releases feed - same as press_releases_list_container

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "press_details"
}

press_details#

For press release page
Press releases details - same as press_release_container

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "press_details"
}

press_release_container#

Represents container for Press Release

Example#

{
  "type": "press_release_container",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "Press Release" }
}

press_releases_list_container#

Represents container for Press Releases List

Example#

{
  "type": "press_releases_list_container",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "List" }
}

promotion_container#

Represents container for Promotion

Example#

{
  "type": "promotion_container",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "Promotion" },
}

promotions#

Banner, with several links

Example#

{
    "title": {
        "fi": "Title",
        "en": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "promotions",
    "sub_title": {
        "fi": "Subtitle",
        "en": null
    },
    "background": null,
    "links": [
        {
            "link": {
                "text": {
                    "fi": "CTA",
                    "en": null
                },
                "url": "https://google.com",
                "target": "blank"
            }
        }
    ]
}

promotions_list_container#

Represents container for Promotions List

Example#

{
  "type": "promotions_list_container",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "Promotions List" },
}

search_results#

Displays search results.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "search_results"
}

service_messages_list#

WIP

Example#

{
  "type": "service_messages_list"
}

site_map#

Displays site map.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "site_map"
}

social_feed#

Displays social media feed from Curator.
api_key, feed_id, container_id - Curator config values

Example#

{
    "title": {
        "fi": "Title",
        "en": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "social_feed",
    "sub_title": {
        "fi": "Subtitle",
        "en": null
    },
    "api_key": "123123",
    "feed_id": "123123",
    "container_id": "123123"
}

store_container#

Represents container for Store

Example#

{
  "type": "store_container",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "Store" }
}

store_deals#

For the Store page.
Displays Deals related to the Store.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "store_deals"
}

store_deals_carousel#

For the Deal page.
Displays Deals as scrolling carousel slides.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "store_deals_carousel"
}

store_map#

For the Deal page.
Displays Deals as scrolling carousel slides.

Example#

{
    "title": {
        "fi": "Title",
        "en": null,
        "pl": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "store_map"
}

store_description#

For the Deal and Event page.
Shows details of the attached Store in simplified form.

Example#

{
    "title": {
        "fi": "Title",
        "en": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "store_description",
    "store_id": 123
}

store_movies_browser#

For the Store page.
Mvoies feed. Will render only on the store marked as a cinema.

Example#

{
    "title": {
        "fi": "Title",
        "en": null
    },
    "visible_until": "2024-09-19T11:01:00+0200",
    "visible_since": "2024-09-12T11:00:00+0200",
    "type": "store_movies_browser"
}

stores_list_container#

Represents container for Stores List

Example#

{
  "type": "stores_list_container",
  "visible_since": "2022-04-11T13:49:51.729401Z",
  "visible_until": "2024-04-10T12:54:27.609Z",
  "title": { "en": "Stores List" },
}

ticker#

Represents slideshow of informational notices consisting of text and/or link.

Example#

{

  "type": "ticker",
  "title": { "en": "Ticker", "pl": "Pasel" },
  "items": [
    {
      "text": { "en": "Very important notice", "pl":  "Ważna informacja. Będzie dobrze."},
      "url": "https://example.com",
      "target": "blank"
    }
  ]
}
Previous
Component Model and Schema
Next
Introduction
Built with