Akinon Release Notes (05/12/2025) are now live! Click here to learn what's new.
LogoLogo
API Reference
  • Home
  • Quick Start
  • Tutorials
  • Technical Guides
  • Release Notes
  • Glossary
  • Welcome to Akinon Tutorials
  • ACC
    • How to Manage Projects and Services?
    • How to Use Demo Projects with ARC?
    • How to Move Apps into ACC?
    • How To Configure Database Connection in ACC?
    • How to Configure Your ACC Application with akinon.json and Procfile?
    • How to Create, Manage, Build, and Deploy Applications in ACC?
    • How to Install Applications from the App Store in ACC?
    • How to Add and Manage Domains in ACC?
    • How to Generate and Add Public Keys in ACC?
    • How to Monitor Application Resources in ACC?
    • How to Manage Users and Roles in ACC?
    • How to Integrate a BI Tool with Your Project in ACC?
  • Omnitron
    • Products & Catalogs
      • How to Add and Bulk Update Products in Omnitron?
      • How to Create Product Attributes and Attribute Sets in Omnitron?
      • How to Manage Catalogs in Omnitron?
      • How to Create and Update Price Lists in Omnitron?
      • How to Create and Update Stock Lists in Omnitron?
      • How to Create and Manage Collections in Omnitron?
    • Orders
      • How to Manage Orders in Omnitron?
      • How to Manage Cancellation and Return Requests in Omnitron?
    • Sales Channels
      • How to Manage Products in Omnitron?
      • How to Manage Registered Users Based on Sales Channel?
      • How to Create and Update Customer Groups in Omnitron?
      • Marketing
        • How to Create and Manage Campaigns in Omnitron
        • How to Create and Manage Coupons in Omnitron?
        • How to Create and Manage Bulk Coupons in Omnitron?
        • How to Create and Manage Discount Codes in Omnitron?
        • How to Configure SEO Settings in Omnitron?
        • How to Configure URL Redirects and Settings in Omnitron?​
        • How to Manage Promotions in Omnitron?
      • Content Management
        • How to Manage Widgets in Omnitron?
        • How to Manage Widget Schema in Omnitron?
        • How to Manage Flat Pages in Omnitron?
        • How to Manage Custom/Campaign Pages in Omnitron?
        • How to Manage Navigations/Menus in Omnitron?
        • How to Manage Mailing Templates in Omnitron?
      • Store Management
        • How to Manage Stores in Omnitron?
        • How to Manage Instore Store Employees in Omnitron?
        • How to Manage Instore Store from Omnitron?
        • How to Manage Store Delivery Points in Omnitron?
        • How to Manage Slots and Retail Store Groups?
      • Payment Management
        • How to Manage POS Integrations in Omnitron?
        • How to Manage Banks in Omnitron?
        • How to Manage Card Types in Omnitron?
        • How to Manage Card Settings in Omnitron?
        • How to Manage Checkout Providers in Omnitron?
        • How to Manage Payment Options in Omnitron?
      • Category Management
        • How to Automatically Assign Category Mapping Rules in Omnitron?
      • Sales Channel Settings
        • How to Configure Marketplace Attribute Mapping in Omnitron?
        • How to Manage Marketplace Mapping in Omnitron?
        • How to Manage Marketplace Operations?
        • How to Manage Address Mapping in Omnitron?
        • How to Manage Social Accounts in Omnitron?
        • How to Manage Loyalty Integration Settings?
        • How to Manage Store Stock Settings?
        • How to Manage Product List Filter Settings?
        • How to Manage Instore Settings in Omnitron?
        • How to Manage General Sorting Settings?
        • How to Manage Shipping Options in Omnitron?
        • How to Manage Delivery Options in Omnitron?
        • How to Manage Easy Return Shipping Options in Omnitron?
    • Integration
      • How to Manage Pending Products in Omnitron?
      • How to Manage City/District Mapping Error Logs in Omnitron?
    • Reports
      • How to Create and Download Reports in Omnitron?
    • Settings
      • How to Add and Configure a New Sales Channel in Omnitron?
      • How to Add and Configure a Shipping Company in Omnitron?
      • How to Create and Manage Sorting Algorithms in Omnitron?
      • How to Create and Manage Users in Omnitron?
      • How to Manage Reasons for Cancellation and Return in Omnitron?
      • How to Manage Authority Groups in Omnitron?
      • How to Manage Advanced Permission Policies and Items?
      • How to Log in to Omnitron Using OAuth2 (SSO)?
  • OMS
    • How to Set Up and Manage Locations in OMS?
    • How to Set Up Basic Configurations in OMS?
    • How to Manage Application Settings in OMS?
    • How to Add and Edit Stock Locations in OMS?
    • How to Create or Edit Distribution Scenarios in OMS?
    • How to Create or Edit Transfer Scenarios in OMS ?
    • How to Perform a Product Search in OMS?
    • How to Add or Edit a Product Stock Integration Engine in OMS?
    • How to Add or Edit Shipping Details in OMS?
    • How to Add or Edit a Webhook in OMS?
    • How to Add or Edit a State Transition in OMS?
    • How to Add or Edit a Packaging Refusal Reason in OMS?
    • How to Pull Orders from Omnitron to OMS?
    • How to Add or Edit Translatable Models in OMS?
    • How to Manage Scheduled Operations in OMS?
    • Working Logic of Scenarios
  • Instore
    • How to Install the Instore Service on an ACC Project?
    • How to Create Customer Account?
    • How to Manage Store & Staff?
    • How to Manage Instore Settings?
    • How to Create Instore Settings Via Omnitron Panel?
    • How to Customize Instore Widgets?
    • How to Configure Payment Methods in Instore?
    • Instore User Manual
      • Selling Through Instore
      • Order Refund/Cancellation Processes
      • Click & Collect Order Management (For Brands without an OMS)
      • Package Orders
      • Transfer Orders
      • Customer Profile
      • Settings
  • Integrator
    • How to Update S3 Bucket?
    • How to Manage Users in Integrator?
    • How to Create and Manage Integration Flow?
    • How to Monitor Integration Logs in Integrator?
    • How to Use the Flow Testing Screen in Integrator?
    • How to Use Alarm Services in Integrator?
    • How to Monitor Flow Performance in Integrator?
    • How to Create a Version Service in Integrator?
    • Flows
      • Login Flow
      • Product Flow
      • Stock Flow
      • Full Stock Flow
      • Price Flow
      • Full Price Flow
      • Order Flow
      • Order Status Flow
      • Order Cancel Flow
      • OMS Stock Flow
      • Whippy Stock Flow
      • Generic Proxy Flow
      • Image S3 Flow
      • Video S3 Flow
      • JOLT Mapping
      • Scripting in Flows
  • Project Zero
    • How to Configure Mini Basket?
    • How to Optimize Menu Performance?
    • How to Implement the Quickly Add to Cart Feature?
    • How to Implement Product Image Slider?
    • How to Create and Integrate a Custom Payment Option View in Checkout?
  • Marketplace Dashboard
    • How to Monitor Integration Logs in the Marketplace Dashboard?
    • How to Monitor Integration Reports in Marketplace Dashboard?
    • How to Create Alarms and Notifications in Marketplace Dashboard?
  • Akifast
    • Akifast Admin Dashboard
    • Akifast Merchant Dashboard
  • Seller Center
    • Seller
      • Settings
        • How to Manage Users in Seller Center?
        • How to Generate and Revoke Access Tokens in Seller Center?
        • How to Manage Delivery Settings in Seller Center?
      • Products
        • How to Use Offer Actions in Seller Center?
        • How to Add Single Product in Seller Center?
        • How to Add Product Offers Using Bulk Actions in Seller Center?
        • How to Manage Offers via Marketplace Catalog?
        • How to Create Revison Requests?
        • How to Use Bulk Actions in Seller Center?
        • Inventory Management
          • How to Manage Stock List in Seller Center?
          • How to Manage Price List in Seller Center?
      • Orders
        • How to Manage Orders in Seller Center?
        • How to Manage Packages in Seller Center?
        • How to Manage Cancellation & Returns in Seller Center?
      • Finance
        • Account Management
        • How to Manage Reconciliations in Seller Center?
      • Store Management
      • Messages
      • Support
    • Marketplace Owner
      • Settings
        • How to Manage Users in Seller Center?
        • How to Manage Delivery Settings in Seller Center?
        • How to Manage Offer Reject Reasons in Seller Center?
        • How to Manage Attribute Set & Category Mapping?
      • Products
        • How to Manage Offers via Marketplace Catalog?
        • How to Use Offer Actions in Seller Center?
      • Orders
        • How to Manage Orders in Seller Center?
        • How to Manage Packages in Seller Center?
        • How to Cancel or Return an Order in Seller Center?
      • Finance
        • How to Manage Reconciliations?
        • Seller Management
      • Support
      • Messages
  • Whippy Ware
    • Whippy Ware
  • Dynamic Price
    • Dynamic Price
  • How to Use Offer Reject Reasons?
Powered by GitBook

© 2025 Akinon. All rights reserved.

On this page
  • Defining Widget Schema​
  • Adding Widget Schema​

Was this helpful?

  1. Instore

How to Customize Instore Widgets?

PreviousHow to Create Instore Settings Via Omnitron Panel?NextHow to Configure Payment Methods in Instore?

Last updated 22 days ago

Was this helpful?

To enable customization of the images and the inclusion of user agreements for display in Instore, the Widget structure present in Omnitron needs to be utilized. For this purpose, appropriate Widget Schemas should be defined as a priority, followed by adding the content to these Widgets.

Defining Widget Schema​

To enable customization of the homepage and login screens in the Instore application, as well as to add sales agreements that customers need to approve when the online sales feature is active, Widget Schema definition should be performed in Omnitron.

Navigate to Content Management > Widget Schema Management screen within Omnitron.

On the opened screen, all the previously added Widgets in Omnitron will be listed. If a Widget Schema has not been added for Instore before, click on the New Widget Schema button.

Four Widget Schemas can be defined under the names Instore Home Banner, Instore Login Banner, Instore Widgets Widget Type, and Instore Agreements. These schema names are not customizable and must be entered in the Widget Type field.

After entering the schema names into the Widget Type field, the script that contains the schema content must be entered into the Schema field. Once these two pieces of information required to create the schema are added to the Add/Edit Widget Schema page, click on the Save button to define the desired schema.

The following are the Widget Schema contents that allow customization of Instore's homepage and login screens and the addition of customer agreements:

  • Instore Widgets Widget Type: The "Instore Widgets Widget Type" schema is the schema required for adding any schema to Instore. (If any Widget Schema is to be added, this schema must be added first.)

Widget Type: Instore Widgets Widget Type

Schema:

{"element":{"multi":true,"schema":{"widget_type":{"data_type":"text","key":"widget_type","label":"Widget Types"},"widget_slug":{"data_type":"text","key":"widget_slug","label":"Widget Slug"}},"data_type":"nested","key":"element","label":"Instore Widgets"}}
  • Instore Agreements: The "Instore Agreements" schema is the schema that allows the addition of agreements that customers will approve during online sales made through the Instore application.

Widget Type: Instore Agreements

Schema:

{"instore_agreements":{"data_type":"area","is_localizable":true,"display":"html-editor","key":"instore_agreements","label":"Instore Agreements"}}
  • Instore Login Banner: The "Instore Login Banner" schema is the schema that adds the image displayed at the top of the password screens during login to the Instore application.

Widget Type: Instore Login Banner

Schema:

{"url":{"required":false,"data_type":"text","key":"url","label":"URL"},"mobile_image":{"data_type":"image","key":"mobile_image","label":"Mobile Image"},"image":{"data_type":"image","key":"image","label":"Image"},"title":{"required":false,"data_type":"text","key":"title","label":"Title"}}
  • Instore Home Banner: The "Instore Home Banner" schema is the schema that allows the addition of widget images that enable easy access to product categories in the Instore application when the online sales function is used.

Widget Type: Instore Home Banner

Schema:

{"items":{"multi":true,"schema":{"url":{"required":false,"data_type":"text","key":"url","label":"Url"},"image":{"data_type":"image","key":"image","label":"Image"},"label":{"required":false,"data_type":"text","key":"label","label":"Title"},"desc":{"required":false,"data_type":"area","key":"desc","label":"Description"}},"data_type":"nested","key":"items","label":"Banner"},"grid":{"required":false,"choices":[{"value":"1","label":"1"},{"value":"2","label":"2"},{"value":"3","label":"3"},{"value":"4","label":"4"}],"data_type":"dropdown","key":"grid","label":"View"},"title":{"required":false,"data_type":"text","key":"title","label":"Title"}}

Adding Widget Schema​

After defining the schemas on the Widget Schema Management screen, the desired widgets must be added using the Widget Management screen for the features to be available.

Widgets for Instore are added by clicking on the Add New Widget button in the Widget Management screen according to the defined schemas.

The widget contents that can be added for the Widget Schemas defined in the previous section are listed below:

  • Instore Home Banner: The form that opens for adding home page widget images must be filled with appropriate information. A maximum of 4 banner images can be added to this field. To add multiple home page widget images, click on the + Add Subcontent button.

The information that needs to be entered in the "Instore Home Banner" form, shown in the images above, is listed below:

Field Name

Status

Description

Example Value

Widget Name

Required

Widget Name

instore-home-banner-1

Widget Slug

Required

Widget Slug

instore-home-banner-1

Widget Type

Required

Widget type to be selected according to the defined scheme.

Instore Home Banner

Template

Required

A draft link, if available

/

Banner

Required

Field with subtitle consisting of URL and image

URL

Required

Category name when you click on the image

/clothing

Image

Required

Image desired to appear in Instore

.png

View

Not Required

Default entered as 1

1

Title

Not Required

Brand’s name

Lorem Impulse Store

  • Instore Login Banner: To add widget images to the login page, the form that appears should be filled out with the appropriate information. In this field, a maximum of 1 banner image can be added. The size of the image to be added for the widget should be 1024x215 pixels.

The information to be entered in the "Instore Login Banner" form shown in the image above is as follows:

Field Name

Status

Description

Example Value

Widget Name

Required

Widget Name

instore-login-banner-1

Widget Slug

Required

Widget Slug

instore-login-banner-1

Widget Type

Required

Widget type to be selected according to the defined scheme

Instore Login Banner

Template

Not Required

A draft link, if available

/

URL

Not Required

Instore page link when you click on the image

Image

Required

Image desired to appear in Instore

.png

  • Instore Agreements: The "Electronic Message Confirmation," "User Agreement," "Privacy Policy," and "Express Written Consent" agreements that are obtained during the creation of a new customer account on the Instore application must be created from the Widget Management screen. The name and slug information to be used for the documents are as follows:

Privacy Policy: instore-privacy-policy

Electronic Message Confirmation: electronic-message-confirmation

User Agreement: user-agreement

Express Consent Text: express-consent-text

The necessary information to be entered into the "Instore Agreements" form shown above is listed below:

Field Name

Status

Description

Example Value

Widget Name

Required

Widget name

electronic-message-confirmation

Widget Slug

Required

Widget slug

electronic-message-confirmation

Widget Type

Required

Widget type to be selected according to the defined scheme

Instore Agreements

Template

Not Required

A draft link, if available

/

Instore Agreements

Required

Document content is entered

  • Instore Widgets Widget Type: In order to complete the installation process after the above-mentioned addition procedures of Instore Agreements, Instore Login Banner, and Instore Home Banner widgets that are desired to be displayed in Instore, they also need to be added to Instore Widgets Widget Type. Widgets that are not added to Instore do not have to be added to Instore Widgets Widget Type. To complete the widget addition process, the form that is opened must be filled out with appropriate information. Up to 3 Instore widgets can be added to this area. If multiple widgets are desired to be added, they can be added by clicking the + Instore Widgets button.

The information to be entered in the "Instore Widgets Widget Type" form shown above is listed below:

Field Name

Status

Description

Example Value

Widget Name

Required

Widget name

instore-widgets

Widget Slug

Required

Widget slug

instore-widgets

Widget Type

Required

Widget type to be selected according to the defined scheme

Instore Widgets Widget Type

Template

Not Required

A draft link, if available

/

Instore Widget

Required

Widgets that are requested to be forwarded to the Instore are added

Widget Type

Required

Widget type to be selected according to the defined scheme

Widget Slug

Required

Widget slug

alt_text