# Welcome to Akinon Documentation ## From Quick Start to Custom Frontends - Connect It All Explore practical guides to launch your Akinon project, make Project Zero your own, and connect your own storefront — faster than ever.


Quick Start: Launch Akinon in Minutes Set up your Akinon project with essential configurations.	Launch Your Akinon in Just 6 Steps	Frame 16.png
Customize Project Zero to Fit Your Brand Update styling, structure, and components.	Project Zero	Frame 12 (2).png
Connect and Bring Your Storefront to Akinon Connect your existing storefront to Akinon.		Frame 15.png

*** ## Flows Connect and configure essential business flows.

Start shipments, update addresses, and manage returns

Create new shipments, update delivery or return addresses, schedule delivery or pickup dates, and initiate return processes. [Learn more](https://apidocs.akinon.com/flows/shipment-flows)

Start payments, finalize transactions, and manage void and refunds

Start a new payment session, redirect the customer, handle return URLs, confirm transactions, and take post-payment actions like refunds or cancellations. [Learn more](https://apidocs.akinon.com/flows/payment-flows)

Attach SMS alerts to your flows

Send real-time SMS notifications as part of your Shipment or Payment Flows. Keep customers informed about their order or payment status. [Learn more](https://apidocs.akinon.com/flows/sms-flows)

Integrate dynamic discount engines with your checkout

Connect third-party systems to evaluate and apply real-time discount offers to a customer's basket. [Learn more](https://apidocs.akinon.com/flows/basket-offer-flows)

*** ## Get to Know Akinon Products Browse Akinon’s products designed to help you launch, manage, and scale your e-commerce operations.


Akinon Commerce Cloud (ACC)	Screenshot 2025-04-28 at 17.24.47.png	ACC
Omnitron	Screenshot 2025-04-28 at 17.22.52.png	Omnitron
Commerce	Screenshot 2025-04-28 at 17.30.08.png	Commerce
Order Management System (OMS)	Screenshot 2025-04-28 at 17.31.12.png	Order Management System (OMS)
Instore	Screenshot 2025-04-28 at 17.32.35.png	Instore
Integrator	Screenshot 2025-04-28 at 17.34.44.png	Integrator
Marketplace Dashboard (MPD)	Screenshot 2025-04-28 at 17.35.10.png	Marketplace Dashboard (MPD)
Project Zero (PZ)	Screenshot 2025-04-28 at 17.37.30.png	Project Zero (PZ)
Seller Center	Screenshot 2025-04-28 at 17.39.05.png	Seller Center
Akifast	Screenshot 2025-04-28 at 17.39.35.png	Broken link
App Maker	Screenshot 2025-04-28 at 17.39.49.png	App Maker

*** ## **Native AppBuilder** — Build Mobile Apps, Fast Create production-ready mobile apps with React Native. Customize, extend, and deploy with full control. {% tabs %} {% tab title="Setup Essentials" %} Set up your development environment and launch your first project with ease. From installing the CLI to deploying your app, covers all the essentials.

[Learn more](/technical-guides/app-maker) {% endtab %} {% tab title="Build and Customize Your App" %} Learn the core framework and how it functions, managing and customizing pages and data containers, integrating and configuring plugins to extend app capabilities.

[Learn more](/technical-guides/app-maker/mobile/mobile-app-framework) {% endtab %} {% tab title="Publishing App to Stores" %} Ready to go live? Learn how to publish your mobile app on Apple App Store and Google Play with step-by-step instructions.

[Learn more](/tutorials/app-maker/create-app-on-stores/creating-app-on-apple-app-store) {% endtab %} {% endtabs %} # ACC ACC is a cloud-native SaaS solution that provides a flexible and scalable digital commerce platform. It offers a comprehensive set of services and tools to build, deploy, and manage digital commerce applications. Leveraging a headless architecture and API-first approach, it allows for easy creation and management of applications and gives flexibility to customize and extend e-commerce applications according to specific requirements. ACC follows cloud-native principles and supports the 12-Factor methodology, enabling the creation of modern cloud-native applications effortlessly. It offers a single-tenant SaaS architecture, ensuring enhanced security, scalability, and control. With ACC, you can benefit from horizontal auto-scaling mechanisms, enabling efficient resource allocation through automated application deployment. ## ACC Capabilities At the core of ACC is Flora, a robust cloud orchestration tool developed by Akinon to address your diverse cloud requirements. Flora acts as a centralized hub for managing and automating various aspects of your cloud infrastructure. It simplifies application building, SSL certificate management, scalability across availability zones, DNS configuration management, and database provisioning. By abstracting the complexities of the underlying infrastructure, Flora allows you to focus on developing and enhancing digital commerce solutions. In conjunction with Flora, ACC offers additional tools and interfaces such as APIs, a CLI (Command Line Interface) tool, monitoring and management screens. These resources provide you with complete control over your applications, empowering you to rapidly manage and optimize your cloud-based infrastructure with heightened security and scalability. The architecture of ACC creates a reliable and isolated environment, allowing users to concentrate on their specific requirements and operate with confidence. By leveraging the combined capabilities of Flora and ACC, you can streamline your operations, reduce complexities, and maximize the efficiency of your digital commerce ecosystem. This includes integrating Akinon's services, applications, and desired extensions seamlessly, allowing for a cohesive and optimized user experience.

## API-First Integration Akinon API-first design philosophy enables you to build and customize digital commerce experiences with ease. The comprehensive set of RESTful and REST APIs allows integration with existing systems, third-party applications, and external services. Akinon offers a wide range of APIs that provide developers with the necessary tools to integrate, extend, and customize the platform's digital commerce capabilities. These APIs enable seamless interaction with ACC's core functionalities, applications and services. ACC streamlines tasks, such as discovering available extensions and provisioning them for projects, which makes it easy to add new extensions without disrupting existing services. Additionally, each API is well-documented, with clear specifications, endpoints, and data structures, making it easier for developers to understand and integrate applications and services operating on the ACC. Akinon also offers the option to subscribe to webhooks or utilize APIs within your extensions. These self-contained modules operate with their own dependencies and can be easily published, loaded, and managed. This opens up possibilities for implementing notifications, sales channels, data synchronization, and integration with other tools or services. ACC empowers you to decouple the front-end presentation layer from the underlying commerce functionality. This approach provides unparalleled flexibility, enabling developers to leverage their preferred front-end frameworks and technologies while connecting with ACC's Commerce capabilities via APIs. ## CI/CD Tools ACC integrates continuous integration and continuous delivery (CI/CD) tools to automate the application development process. By utilizing these tools, you can create and manage consistent and reliable CI/CD pipelines. ACC ensures that pipelines are developed consistently, allowing swift deployment of new applications across multiple projects. To facilitate efficient troubleshooting during the CI/CD process, ACC offers comprehensive logs and metrics through Flora. These insights play a vital role in quickly identifying and resolving issues, ensuring the timely delivery of high-quality applications. ### Continuous Inspection ACC involves automatically analyzing code quality and identifying potential issues or vulnerabilities throughout the software development process via continuous inspection. This analysis is performed on source code, bytecode, or compiled binaries to identify bugs, vulnerabilities, code smells, and other code quality concerns. It provides a wide range of built-in rules and checks. The reports generated as part of CI/CD pipelines in ACC include valuable metrics such as code coverage, complexity, duplication, and adherence to coding standards, providing essential insights for improving software quality. Each issue is categorized and prioritized based on severity, allowing developers to focus on the most critical problems first. If the code does not meet the quality gate criterias, you can consider the versions as unstable and see what improvements could be made. By regularly monitoring these metrics, teams can identify areas for improvement, set goals, and track their progress. This integration on ACC helps teams deliver higher-quality code, improve software maintainability, and mitigate security risks throughout the development lifecycle. # Omnitron Omnitron stands as a **centralized operational hub** in Akinon, adeptly managing omnichannel operations **within a single center**. Users can easily control web sales channels and marketplaces using only Omnitron. It's the main product, and other products work together with it. While other tools rely on Omnitron to function, **Omnitron can also work on its own.** Integrating with existing ERP applications, Omnitron empowers business partners to digitally transform their product. Through its advanced catalog management system, along with integrated price and stock modules, products can be **managed across all digital channels**. Moreover, Omnitron functions as a **dynamic operational hub**, providing business partners with the capacity to efficiently monitor and analyze customer interactions and orders across diverse digital sales platforms—ranging from websites and mobile apps to in-store e-commerce setups. This, in turn, equips them with the tools needed to effectively steer their omni-channel sales strategies.

## Omnitron Capabilities #### **Dashboard** Omnitron Dashboard provides users with extensive business statistics based on sales channels. It offers the option to filter by start and end dates along with sales channels to visualize business metrics. The dashboard presents an order table by time zone, showcasing top 5 products, cities, and categories. #### **Product Information Management** Omnitron streamlines product management across multiple sales channels. Enhance product information through a user-friendly interface, covering addition, editing, and enrichment. This includes product attributes, attribute sets, types, and dynamic collections based on attributes. #### **Catalog Management** Users utilize catalog management to build a structured catalog and category tree, adding products and linking them to prices, stock lists, and sales channels. Relevant products are placed within their corresponding category in the tree. Products are sorted within categories or collections using algorithms or manual arrangement, ensuring optimal frontend display. #### **Order Management** Omnitron enables order management across all sales channels, including cancellations, pending approvals, and transaction details. Omnitron periodically executes tasks to fetch and update order information for each sales channel. #### **Content Management** Omnitron empowers dynamic website creation through content management. Widgets, flat pages, navigation menus, recommendation systems, custom campaigns, and mailing templates can be configured for enriched online experiences. #### **Campaign Management** Digital campaigns and online marketing are oversaw for selected web sales channels using Omnitron. Campaigns, bulk coupons, and customized discount codes with specific customer conditions can be managed through campaign management. #### **Payment and Shipping Options** Omnitron simplifies payment management by enabling POS integrations, bank and card management, and more for the selected sales channel. It also streamlines shipping options, allowing customization of fees, discounts, and shipping companies based on regional limits or product attributes. ## Key Features * **Unified Data Integration:** Omnitron offers a unified platform for integrating data from diverse sources, including databases, APIs, cloud services, and more. * **Data Transformation:** Omnitron's intuitive mapping features effortlessly convert between diverse formats and structures for smooth data flow across applications. * **Real-time Data Exchange:** Real-time data exchange between connected systems ensures critical information is always up-to-date and readily available. * **Scalability and Performance:** Omnitron is engineered to handle large volumes of data and complex integration scenarios. Its scalable architecture ensures that the data integration processes remain smooth and responsive. * **Security and Compliance:** Akinon places great importance on data security and compliance. Omnitron incorporates robust security measures, such as encryption and access controls, to safeguard sensitive information and adhere to industry regulations. * **Monitoring and Analytics:** Omnitron's built-in monitoring and analytics tools provide valuable insight into data integration processes. * **Seamless Integration with Akinon Ecosystem:** Omnitron seamlessly integrates with other Akinon products and services, expanding its capabilities and providing a comprehensive ecosystem for end-to-end data management. # Commerce Online shopping sites are one of the most popular internet components today. Thanks to the increasing sense of security and easy access in the recent years, its area of use has expanded and it has attracted larger audience groups. Many new companies and members of the traditional commerce industry who wish to respond to this interest and demand now take an interest in e-commerce. Various technologies and systems are developed to help the development of e-commerce platforms in line with user experience. One of such systems is the platform model called “Headless E-commerce”. In the simplest terms, “Headless E-commerce” refers to e-commerce platforms where front-end and back-end codes are designed, constructed and developed individually and separately. In shopping sites serving on Headless E-commerce platforms, these two ends are designed separately. While back-end is used for content and application management, front-end is responsible for visuals and design. In traditional e-commerce models, back-end and front-end layers are intertwined and interdependent. However, those models slow down adaptation of the system to changing business models and rapidly evolving industrial developments. Therefore, companies have started to opt for Headless E-commerce model.

APIs are one of the main components of Headless E-commerce system. When users interact with the front-end components of an online shopping website (such as clicking on an item to go to the product details page), API (Application Programming Interface) sends a request to the server, which is a back-end component. The server reads the request and in response, sends required data to the API link. This data is processed by a browser and the interaction launched on the site is performed. While the back-end platforms such as CMS, CRM and OMS run products, content and orders, front-end functions serve as a shopfront. The Headless E-commerce structure allows you to use the same infrastructure to design your shopfront individually and uniquely to suit your products, brand and customers. {% hint style="warning" %} For brands using Akinon, appending `?format=json` to the end of their shop URLs allows them to access their shop data in JSON format. Alternatively, the same result can be achieved by sending the `Accept: application/json` header in the request. This functionality provides a structured and standardized way to retrieve information such as product details, categories, basket details, and more. {% endhint %} # Order Management System (OMS) Order management system (OMS) is the **orchestration tool that manages the process of preparing and shipping the order** conducted by the supplier. It coordinates the **selection of warehouses for order packaging** and **manages the necessary transfers on a warehouse-specific basis**. After the packaging phase is completed, OMS also handles the **delivery of packages to customers and ensures order owners are promptly informed**, regardless of the sales channel. OMS is a highly **integrated system that connects within Akinon Infrastructure and third-party systems**, including cargo companies and ERP systems. Its operation is closely tied to **Omnitron**, as orders from various sales channels are channeled through Omnitron. When an order reaches Omnitron, OMS duplicates the order using **webhooks and celery tasks**, capturing all order specifications for processing. The **Instore backend** relies on OMS API endpoints for managing packages, transfers, and associated commands. Essentially, it acts as a front-end interface for store and warehouse personnel, providing them direct access to OMS functionalities. Furthermore, OMS can be integrated into an **Integrator flow** for tasks such as invoice processing and stock management. This integration streamlines and automates these crucial aspects. In the context of tracking shipment statuses, OMS maintains multiple **integrations with various cargo companies**. These integrations enable real-time queries into the current status of shipments.

## OMS Capabilities OMS allows businesses the capability to consolidate inventory data from diverse global locations, consolidating it into a singular, easily accessible platform. Moreover, it enables the streamlined processing of orders that originate from different sales channels, presenting a unified overview and control over the entire order management process from a single, centralized interface. This not only simplifies operations but also enhances efficiency and accuracy when it comes to inventory management and fulfilling customer orders. ### **Scenarios** Scenarios are predefined process workflows within the OMS that dictate how orders are managed and processed. Each scenario is configured with specific rules and conditions that guide the system on how to handle different order types, considering their unique characteristics and demands. When an order is placed through any of your sales channels, Akinon OMS activates the appropriate scenario to determine how the order should be fulfilled. This scenario evaluates the order's attributes, such as the items in the order, customer preferences, delivery location, and other relevant factors. ### **Fulfillment** The OMS fulfillment process starts when a customer places an order. Then, based on scenarios and stock integration with Inventory Locations, the OMS determines the sourcing of items, packing methods, and the shipping route for the order. Once the order reaches the customer successfully, the OMS concludes the process and updates relevant records. ### **Package and Transfer Commands** Commands act as the drivers of actions within the order fulfillment process. They consist of a set of predefined instructions that dictate how packages and transfers are to be managed at various stages. When an order is received, the system generates one or more packages that contain the purchased items. These packages are then prepared for shipping and delivering them to the customer by using these commands. ### **Inventory Locations & Engine** Inventory Locations in Akinon OMS represent physical locations where products are stored within your business's supply chain. These locations can include retail stores, warehouses, or distribution centers. Each Inventory Location holds details about available products, like quantities and variations. During the fulfillment process, the OMS utilizes the rules defined within the predefined scenarios to determine how to fulfill the products specified in an order. It checks the Inventory Engine to understand the current stock levels across the diverse inventory locations in your supply chain. ### **Event Listeners and Webhooks** Event Listeners and Webhooks serve as a bridge for communication between OMS and external systems or services. Within the context of the OMS, Webhooks provide a way for external applications to receive real-time updates about specific events that occur within the OMS. When a particular event, such as order fulfillment, takes place in the OMS, a Webhook is triggered to send a secure notification to an external endpoint specified by the receiving system. ### **Package and Transfer Services** Services refer to the collection of programming interfaces or endpoints within Akinon OMS that allow external applications or systems to interact with the packaging, transfering and shipping processes. These APIs enable businesses to programmatically generate packaging and transferring instructions, create packages and transfers, and retrieve shipping information. Through Packages API Services, developers can integrate external systems with Akinon OMS to automate packaging and transfer commands, and track the movement of packages. ## General Order Flow When a customer places an order through any sales channel, Akinon's (OMS) initiates a flow. It transforms this incoming order into a structured **Work Order**. To guide this transformation process, the OMS relies on a set of predefined rules called **Packaging** and **Transfer Rules**, which are configured within the system's **Scenarios**. These rules are essentially a set of instructions that dictate how the Work Order should be handled. Once these rules are applied, the Work Order is divided into two distinct types: **Packaging Orders** and **Transfer Orders**. This categorization is not random; it adheres to the rules defined earlier. Packaging Orders deal with products that will be packed and shipped from the same location, while Transfer Orders deal with items that need to be moved from one store to another before shipping. Now comes the next step: assigning these categorized orders to the right place for further processing. The OMS excels at this task, using its knowledge of your inventory and locations to make the best possible decisions. **Packaging Orders** are sent to appropriate **Packaging Locations**, where items are prepared for shipment, while **Transfer Orders** are assigned to **Stock Locations**, ensuring that the required products are in the right place for efficient shipping. The following flowchart is provided for a better understanding of the order flow within OMS.

# Instore The Akinon Instore application is a **versatile web application compatible with mobile and tablet devices**. It facilitates Instore users' swift access to and **management of customer profiles, product stocks, packaging, and transfer processes**, with the overarching goal of creating a flawless omnichannel customer experience.

Integrated with Commerce, Omnitron BE, Omnitron FE, and OMS, the Instore application empowers **store and warehouse employees to efficiently utilize Akinon applications** and their functionalities. The subsequent section provides an in-depth exploration of the capabilities and concepts inherent in the Akinon Instore application. ## Instore Capabilities #### Customer Management Akinon Instore is a dynamic application enabling brands to generate new customer profiles and place orders for customers directly within the store. #### Product Management The Instore application compiles a list of products entered through the Omnitron channel. Store employees can check the listed products, filtering, sorting, and searching according to specific criteria. Instore facilitates sales transactions for the designated customer. #### Completing an Order The Instore application interacts with Commerce APIs, streamlining order transactions. By selecting a customer through the Instore app, basket information becomes accessible. This basket serves as the foundation for completing payment transactions and converting in-store orders. During checkout, various transactions, such as creating a new customer address, selecting a shipping company, and choosing a payment method, can be effortlessly executed. Instore provides diverse payment options, including Pay with QR, Cash, and IVR, ensuring a swift and efficient payment process. #### Order Management * **Order Returns** Order returns involve cancellation/return requests initiated for orders or products through the Instore platform. Requests received via the Akinon Instore application are transferred to Omnitron. * **Click & Collect Orders** The Click & Collect system empowers store employees to manage package and order operations, even if the OMS system is not fully integrated into the Instore app. * **Click & Collect Acceptance** Click & Collect Acceptance involves the transfer of prepared orders from one store to another, particularly if the order contains out-of-stock products. Customers are notified via email once the product reaches the store where the order originated. * **Click & Collect Delivery** This process allows for the delivery of in-store pickup orders directly to the customer by the store using the assigned order number. #### Package Management * **Package Orders** Managing the packaging operation of an order is facilitated through Package Orders, employing defined scenarios. Instore utilizes Akinon OMS functionalities to list, filter, print, and sort packages based on their status. Operations such as shipping, preparing for customer delivery, marking a package as out of stock, and rescheduling the package transfer can be executed. * **Transfer Orders** Transfer Orders manage the transfer processes of orders between stores, also managed through Akinon OMS functionalities. The Transfer Orders page allows for listing, filtering, printing, and sorting transfers based on desired statuses, simplifying brand-wide transfer operations. #### Settings Management The Instore application allows for the definition of special settings for individual stores. This includes tasks such as adding a logo, changing language preferences, adjusting font styles, and defining general color schemes. Additionally, stores have the flexibility to customize layouts and functionalities according to their specific preferences. # Integrator Integrator offers a suite of integration services for **synchronizing pricing, stock, product information, image handling** (including Image and ImageS3), and **optimizing order-related operations** (including Order, Order Status, and Order Cancellation). It provides a robust and flexible solution to meet all your integration needs. **The data originating from the ERP system** (including stock, pricing, product information, image, order status, etc.) is **processed and written into Omnitron**. In the case of order data, Integrator efficiently reads it from Omnitron and securely writes it back into the ERP systems. Once brands upload product images to S3 Buckets, Integrator **reads and writes these images into Omnitron** using the Image S3 flow within the Integrator. Integrator also includes a built-in **logging system as part of its internal logging mechanisms**. It retains logs for **up to 15 days** before automatically deleting them. These logs hold a record of data transmitted through the Integrator. Moreover, Integrator allows for the integration of [OMS](/products/order-management-system-oms) (Order Management System) into its flow, enabling streamlined tasks such as invoice processing and stock management.

## Main Functionalities of Integrator #### **1. User-Friendly Integration Flow Designer:** * Integrator offers an intuitive integration flow designer interface. * It comes equipped with a library of pre-defined flow components developed by Akinon, making it effortless for partners to configure every step of an integration flow. * This includes tasks like reading data from a source, defining transformation maps, and sending data to the target system. #### **2. Alert Configuration:** * Integrator provides the capability to set up and configure multiple alerts to proactively handle potential errors or issues in the integration process. * These alerts ensure that any anomalies or disruptions are promptly addressed, minimizing downtime and data discrepancies. #### **3. Comprehensive Log Monitoring:** * The platform boasts a comprehensive log monitoring functionality that serves as an invaluable tool for identifying errors and diagnosing issues in the integration processes. * This robust monitoring system allows for efficient troubleshooting, ensuring that problems are quickly resolved to maintain data integrity and system reliability. #### **4. Web-Accessible Performance Monitoring** * Integrator offers a web-accessible performance monitoring interface based on predefined performance metrics. * Users can assess the efficiency and effectiveness of their integration flows using metrics such as success rates and average flow times. * These insights into the system's overall performance allow for continuous optimization and fine-tuning of integration processes. Integrator is a robust platform that facilitates data integration while prioritizing reliability, stability, and performance of essential processes. It offers technical tools and extensive functionalities for configuring intricate integration flows and monitoring system performance. # Marketplace Dashboard (MPD) **Marketplace Dashboard** is a centralized management tool that enables brands to integrate and manage their product listings, orders, and operations across multiple third-party marketplaces—such as **Trendyol, Hepsiburada, Amazon, n11**, and others. In today’s ecommerce landscape, selling through marketplaces is essential for reaching a wider customer base. However, each marketplace has its own set of rules, operational workflows, and data requirements. Managing them individually can be time-consuming, error-prone, and inefficient. Marketplace Dashboard solves this problem by acting as a **unified control panel** for marketplace operations. It connects with **Omnitron**—the brand’s central data hub—and ensures that product data, stock levels, order statuses, shipment details, and returns are all synchronized between the brand and each marketplace in real time. Instead of building a separate integration for each marketplace, brands can use Marketplace Dashboard to: * Configure each marketplace channel individually * Adapt to marketplace-specific capabilities * Track and resolve operational issues * Maintain consistent and up-to-date product information * Automate complex workflows like partial cancellations, returns, and package splits By simplifying the technical complexity of multi-channel e-commerce, Marketplace Dashboard helps brands scale their marketplace presence efficiently and reliably. ## Marketplace Dashboard Capabilities ### **Marketplace-Specific Setup and Management** Each Marketplace Dashboard instance is deployed and configured independently for every marketplace platform. This modular approach allows brands to tailor configurations based on the specific requirements, and operational structures of each marketplace. While **Omnitron** acts as the central data source, each dashboard operates as an isolated unit, enabling marketplace-specific workflows and integrations. ### **Smart Channel Compatibility** Marketplace Dashboard intelligently adapts to the supported capabilities of each marketplace. Only the available and relevant functions are activated for use—ensuring a clean, efficient, and compliant integration setup. This eliminates unnecessary configuration overhead and guarantees operational alignment with the marketplace's native capabilities. ### **Real-Time Order Synchronization** Orders generated on marketplaces are instantly transferred to Omnitron. In return, updates made in Omnitron—such as order statuses, shipping details, or invoice data—are transmitted back to the respective marketplaces. This **real-time, bidirectional sync** ensures seamless and uninterrupted order lifecycle management. ### **Advanced Logging and Monitoring** Marketplace Dashboard includes a powerful logging system that retains data for up to 15 days. These logs provide complete traceability for all data transactions, helping teams to track integration flows, monitor success and error logs, and quickly identify and resolve potential issues during synchronization or operational processes. ### **Flexible Operational Workflows** The platform supports a wide range of marketplace-specific operational scenarios such as **package splitting**, **return approval**, **return rejection**, and **partial cancellations**. This flexibility allows brands to easily manage complex operations that may arise from diverse marketplace rules and customer behaviors. ### **Full Integration for Media and Product Data** Product images, price lists, and descriptions are fully synchronized from Omnitron to connected marketplaces. This ensures that all product data is **always accurate, up to date, and complete** across all platforms. Marketplace Dashboard eliminates manual updates and provides confidence in consistent data presentation. # Project Zero (PZ) Project Zero is a foundational framework designed to **create scalable, user-friendly, and feature-rich e-commerce websites**. This project is built with consideration for both developers and end-users, **serving as a storefront project that caters to the needs of both**. Project Zero conducts its operations **through continuous communication with Commerce**. Commerce, functioning as a bridge, facilitates integration with other Akinon products, enhancing Project Zero's efficiency.

## Technological Advancements In the development of Project Zero, we are committed to **staying at the forefront of the latest technologies** and seamlessly integrating these cutting-edge advancements into our project's development process. At Akinon, we don't just keep a watchful eye on technological innovations; we **actively participate in the integration and testing of these technologies** within the project. This approach ensures that our project is continually **open to refinement**, with the goal of **enhancing the user experience, boosting performance**, and **meeting the evolving needs of the future**, all while being built on the following latest technologies.

## Project Zero Capabilities #### **Multi-Language Support** Project Zero offers multi-language support to meet users’ needs. This feature simplifies the transition between different languages, aiming to deliver a user-friendly experience. #### **Multi-Currency Support** Project Zero also provides support for multiple currencies, allowing for the display of product prices in the preferred currency and enabling payments in that currency. #### **Theme System** Project Zero enables users to create customizable themes, providing the flexibility to create themes tailored to specific needs with different color palettes, layouts, and style options. #### **Plugin System** One of the key features of Project Zero is its modular plugin system, offering flexibility and extensibility. This system allows for the integration of various plugins stored in separate repositories, each serving specific functions. The active list of plugins includes: * **Masterpass:** This package allows users to make payments with cards registered with Masterpass on the payment page. It also enables actions such as listing registered cards, adding new cards, and removing cards. * **GPAY:** This package facilitates payments with 'Garanti Pay' on the payment page. * **OTP:** This package provides SMS verification (OTP) support for processes like registration and updating profile information. * **Click & Collect:** This package activates the in-store pickup option. * **Basket Gift Pack:** This package allows for the addition of gift wrapping and gift notes to products on the cart page, or simply the inclusion of gift notes. * **Checkout Gift Pack:** This package enables the addition of gift wrapping for products on the payment page. * **Checkout Providers:** This package is used to incorporate various payment methods, including the Akifast payment method. * **Redirection Payment:** This package is used to enable payment options involving redirection on the payment page. # Seller Center Seller Center is Akinon’s dedicated interface designed to empower marketplace owners (MPOs) and third-party vendors (marketplace sellers) by enabling seamless integration and management of their operations within the Akinon ecosystem. While Omnitron serves as the operational hub for brands and retailers, Seller Center provides MPOs with a streamlined portal to manage their products, orders, and campaigns for the marketplace. By offering a modular and intuitive platform, Seller Center enables Sellers to onboard easily, update their product catalogs, track inventory, monitor order status — all within a secure, role-based access environment. With its native integration to Omnitron and Akinon Commerce Cloud, Seller Center ensures real-time synchronization of key business data, enhancing operational efficiency for marketplaces and contributing to a unified omnichannel experience for end customers. ## Seller Center Capabilities #### **Product Onboarding & Management** Sellers can effortlessly add and manage product information, including titles, descriptions, images, stock levels, and pricing. Bulk uploads and dynamic editing options enable seamless catalog updates. These actions constitute as “offers” and are subject to approval by MPOs. MPOs’s role enables them to either approve or reject such changes or additions before publishing them through the marketplace. #### **Order Tracking & Fulfillment** Seller Center offers full visibility into order lifecycle from placement to shipment. Sellers and MPO’s based on their authorization can manage cancellations, shipment details, shipment vendors and returns directly through the interface. #### **Campaign Participation & Reconciliations** Sellers can join platform-wide marketing campaigns, apply discount rules, and create personalized offers with predefined approval flows. Such campaigns are created by MPOs with the help of Omnitron and visible in Seller Center for further participation and control.Also Reconciliations tab allows MPOs to adjust payable amounts to the sellers based on the agreements made through the system between MPOs and Sellers. #### **Inventory & Pricing Sync** Sellers can define their own inventory and pricing as they are the ones who are selling their products in the marketplace. Automatic synchronization with Omnitron ensures accurate stock and price data, minimizing overselling or inconsistencies. #### **Role-Based Access** Different capabilities and authorizations are given to the role of MPOs and Sellers to ensure operational clarity and efficiency. As the overall control of the platform is given to the MPOs, they are responsible for approving or rejecting any changes or additions made in the system. #### **Reporting & Analytics** Seller Center provides sellers and MPOs with insights into product performance, order trends, and campaign effectiveness through dashboards and downloadable reports. ## **Key Features** * Secure Seller Environment: Isolated workspaces for vendors with user-based access controls. * Real-Time Sync: Ensures consistency of data across Seller Center and Omnitron. * Performance Insights: Track key KPIs including top-selling products, order volumes, and customer locations. * Quick Onboarding: Guided flows and API-based integrations for seamless seller setup. * Collaboration-Ready: Designed for being the bridge between MPOs and Sellers in a marketplace environment. # App Maker **App Maker** is a powerful and flexible mobile application framework designed to help partners and customers build feature-rich, user-focused e-commerce apps. Built with **React Native**, it offers reliability, cross-platform compatibility, and a robust development ecosystem. App Maker delivers smooth shopping experiences for users and efficient workflows for developers. Integrated with the **Akinon ecosystem** via Commerce, App Maker enables seamless collaboration with other Akinon products. It allows partners to easily create, customize, and deploy e-commerce apps. This introduction gives you a clear overview of App Maker’s capabilities, technology stack, and the value it brings to businesses, developers, and technology providers. ## Technologies Used * **React** * **React Native** * **JavaScript** * **Node.js** ## App Maker Capabilities ### **Reusable Components** App Maker includes a library of pre-built components to speed up development and maintain consistency across your app. These cover essential ecommerce functionalities like: * Add to basket * Checkout * Order tracking All components are fully integrated with **Akinon Commerce endpoints** to ensure reliable performance. ### **Customizable Configurations** Manage native app settings—such as splash screens, logos, app name, notifications, and versioning—using the `akinon.json` file. This JSON-based configuration acts as a **single source of truth**, allowing you to declaratively define how your app behaves on both iOS and Android. These settings are applied during the build, runtime, and deployment phases for consistent app behavior across environments. ### **Plugin Ecosystem** App Maker supports a stable mobile development environment where you can integrate custom modules or third-party services like: * Analytics * Push notifications * Product recommendations etc. This is where plugins come in. They enable you to incorporate necessary modules and write integrations. Plugins follow a two-step process: 1. **Installation** – Scripts (written in Node.js) modify platform files (e.g., `AndroidManifest.xml`, `Info.plist`). 2. **Integration** – Components and services used in the app are developed and connected. ### **Organization Management** With the App Maker platform, easily manage your organization by: * Creating user accounts * Assigning roles (e.g., developer, release manager) * Controlling access permissions This ensures secure and streamlined collaboration across your teams. ### **App Maker CLI** The **App Maker CLI** simplifies development with tools for: * Project setup * Plugin management * Local deployment It supports multiple platforms including iOS, Android, and Huawei. You can initialize new projects from default templates and integrate third-party services like analytics and notifications. Additional features include: * Seamless Git integration * Efficient build and release management ### **Deployment Workflow** App Maker’s deployment process includes: * Preparing credentials * Building app binaries (IPA, APK, AAB) * Testing builds * Submitting to the **App Store** and **Google Play** It also supports **over-the-air (OTA) updates**, which allow you to instantly deliver new features, bug fixes, and content changes directly to users—without requiring a new version to be submitted to the App Store or Google Play. You can enforce critical updates by redirecting users to the latest app version, ensuring a consistent, secure, and up-to-date user experience. # Launch Your Akinon in Just 6 Steps This section serves as a **Quick Start guide for users who are setting up a project on Akinon for the first time**. Its primary goal is to walk you through all the necessary configurations and deployments required to complete a successful order on the system. ACC is a scalable, cloud-native platform based on microservice architecture. To ensure that all systems work seamlessly, a set of core services—especially **Omnitron** (for product and configuration management) and **Commerce** (for order processing and sales channel management)—must be deployed and correctly configured. This guide outlines, step by step, the essential actions users need to take after logging into ACC for the first time. It covers: * Creating a new project * Deploying core services like Omnitron, Commerce, and Project Zero * Setting up language and currency configurations * Defining phone number validation rules * Creating catalogs, products, attributes, stock, and pricing data in Omnitron * Setting up payment and shipping options * Integrating with Project Zero for storefront development and deployment The document is designed to help technical teams and project stakeholders bring a new Akinon project to life in the shortest time possible, with minimal friction and dependency on support teams. By following this guide, you will have a fully functioning project environment capable of handling real product data, processing orders, and supporting a frontend application through Project Zero. Whether you're a developer, integrator, or product manager, this Quick Start guide ensures that your first steps into the Akinon ecosystem are clear, structured, and complete. **Let’s get started and complete the six essential steps ahead to launch your project with confidence.** # 1. Start Your Journey with ACC The very first step in this Quick Start journey is to **create a new project in** [**ACC**](https://apidocs.akinon.com/products/acc). This project will serve as the foundation for all other services and configurations that follow. Here’s how to set up your project: {% stepper %} {% step %} ### Log in to ACC * Visit * Use the credentials provided to you by Akinon. {% hint style="warning" %} To kick-start your project, your ACC account must already be set up.\ If you haven’t received your login info yet, please reach out to Akinon.\ Alternatively, you can try the **Reset Password** option on the login page using your registered email. {% endhint %} * ACC uses email-based One-Time Password (OTP) for authentication. An OTP will be sent to your authorized email address—use it to log in securely.

{% endstep %} {% step %} ### Create a New Project * Once logged in, navigate to the **"Projects"** page. * Click the **+ NEW PROJECT** button to start creating a new project.

{% endstep %} {% step %} ### Fill in the Project Information * A form will appear asking for the project details. * **Project Name**: Enter a clear and descriptive name (e.g., your brand name). * **Project Slug**: This is a unique identifier used internally and across services. For example, the slug is required when creating a dedicated Sentry account for monitoring. * After filling out the information, click the **APPLY** button. You will then be redirected to the plan selection screen.

{% endstep %} {% step %} ### Choose a Plan * The “Choose a Plan” screen is currently under development. * Simply click **CHOOSE PLAN** to proceed.

{% endstep %} {% step %} ### Accept the Licence Agreement * The “License” step is also under development. * Just click **ACCEPT & COMPLETE** to finalize the license agreement and complete your project setup.

{% endstep %} {% step %} ### Welcome Page * Once the project is successfully created, you will be greeted with a **Welcome Page**. * From here, you can follow provided links to visit the project overview or view its applications.

{% endstep %} {% step %} ### Access Your Project Detail Page * You can either: use the shortcut on the welcome page, or find your project in the left-hand navigation menu and click on it to open its detail page.

{% endstep %} {% step %} ### Omnitron Deployment Begin Automatically * As noted on the welcome page, the **Omnitron and Omnitron Frontend** services will automatically start deploying as soon as the project is created. > * **Omnitron** is the core backend service used for managing product data, catalogs, and essential commerce configurations. > * **Omnitron Frontend (FE)** provides the admin interface where you can interact with this data through a user-friendly UI. There’s no manual action needed at this stage—just give it a moment to finish deploying in the background.

{% endstep %} {% step %} ### Check Deployment Status * When the installations are complete, both services will show their setup deployment status as **Deployed**.

Different deployment statuses may be displayed depending on the current state of the deployment process. Below is a list of possible statuses and the actions that need to be taken for each:

Status	Description	Action Required
Deploy Needed	The service has been added, but a version has not been deployed yet.	A new deployment must be initiated.
Pending	The deployment is queued and waiting to be processed.	No action required. Wait for it to progress.
Initializing Setup	Add-ons are currently being installed.	No action required. Wait for initialization to complete.
Addon Failed	An error occurred during the installation of one or more add-ons.	Akinon support must investigate and resolve the issue.
Deploying	A version is currently being deployed.	No action required. Wait for the deployment to complete.
Failed	The deployment process failed.	Review the Deployment Logs to identify and fix the issue, then redeploy.
Deployed	The deployment was successful and the service is up and running.	No action needed.

> * If the status is **Addon Failed**, Akinon needs to take action to resolve the issue. > * If the status is **Failed**, review the **Deployment Logs**, fix the root cause, and trigger a new deployment. > {% endstep %} {% step %} ### Accessing Omnitron * After the deployment is successful, you will receive an email with: * The **URL** to access Omnitron Frontend, and * A link to **set your password** via "Update Password". * Use these credentials to log into Omnitron.

{% endstep %} {% step %} ### Add Additional Services to Your Project * Depending on your contract, you may need to add additional services. * Common services within the Akinon ecosystem include: * Seller Center * Instore * OMS * Commerce {% endstep %} {% step %} ### Adding the Commerce Service * One of the most commonly used services is **Commerce**. * To add it: * Go to your project’s detail page. * Click the **+ NEW SERVICE** button in the upper-right corner. * Select **Commerce** from the list.

{% endstep %} {% step %} ### Confirm the Deployment * A validation popup will appear. * Click **YES, PROCEED** to begin the deployment.

{% hint style="danger" %} If the Omnitron deployment is not yet complete, you will see a warning message.\ You must wait for Omnitron to be deployed before you can add any new services. {% endhint %}

{% endstep %} {% step %} ### Deployment of Commerce Service * The Commerce service will begin deploying immediately after confirmation.

{% endstep %} {% step %} ### Deployment Status Update * Once completed, the status will be updated to **Deployed**, indicating it is ready for use.

Different deployment statuses may be displayed depending on the current state of the deployment process. Below is a list of possible statuses and the actions that need to be taken for each:

Status	Description	Action Required
Deploy Needed	The service has been added, but a version has not been deployed yet.	A new deployment must be initiated.
Pending	The deployment is queued and waiting to be processed.	No action required. Wait for it to progress.
Initializing Setup	Add-ons are currently being installed.	No action required. Wait for initialization to complete.
Addon Failed	An error occurred during the installation of one or more add-ons.	Akinon support must investigate and resolve the issue.
Deploying	A version is currently being deployed.	No action required. Wait for the deployment to complete.
Failed	The deployment process failed.	Review the Deployment Logs to identify and fix the issue, then redeploy.
Deployed	The deployment was successful and the service is up and running.	No action needed.

> * If the status is **Addon Failed**, Akinon needs to take action to resolve the issue. > * If the status is **Failed**, review the **Deployment Logs**, fix the root cause, and trigger a new deployment. > {% endstep %} > {% endstepper %} # 2. Set Up Language & Locale Once the initial ACC deployments are completed, the next essential step before proceeding with other configurations is setting the **project locales** and defining the **default language**. ### What Are Locales? **Locales** determine how language-specific content is managed and presented throughout the project. They control: * How product attribute values and other localizable data are stored and displayed, * Which languages are available for input and output in Omnitron and Commerce, * The localization of content across multiple channels and regions. The locales you define will appear at the top of the Omnitron interface and serve as the basis for content management. For example, you can set `tr-tr` for Turkish and `en-us` for English, enabling you to manage product names, descriptions, or other translatable fields in both languages. {% hint style="warning" %} Locales must be defined *before* entering any data into Omnitron. If content is entered before locales are properly configured, re-entry may be required. {% endhint %} ### What Is the Default Language? The **default language** determines which locale is used in requests and API responses when no specific language is provided by the client. For example, if no `Accept-Language` header is specified in a request, the system will respond using the default language. This ensures consistency in responses and provides a fallback option for multilingual setups. It also affects system messages, validation errors, and user interface language when a specific language is not explicitly selected. By default, English is set as the default locale.

If you plan to use a locale other than English or change the default language, this must be configured through **environment variables** in both the **Commerce** and **Omnitron** services. {% hint style="danger" %} The language settings defined via environment variables **must be identical** in both Commerce and Omnitron services. These settings must be applied **immediately after the services are deployed and before any other configuration begins**. Otherwise, language-related issues may arise later during your project setup or runtime. {% endhint %} ### Supported Languages in the System Below is the list of ISO language codes currently supported by the system: ```ini ar ➡ Arabic 🇸🇦 el ➡ Greek 🇬🇷 kk ➡ Kazakh 🇰🇿 nl ➡ Dutch 🇳🇱 pl ➡ Polish 🇵🇱 ro ➡ Romanian 🇷🇴 ru ➡ Russian 🇷🇺 sr ➡ Serbian 🇷🇸 tr-tr ➡ Turkish 🇹🇷 uk ➡ Ukrainian 🇺🇦 ``` {% hint style="warning" %} If you require support for a language not listed above, please contact the Akinon team to discuss availability and integration options. {% endhint %} ### Setting Language Environment Variables To set a default language and supported locales (e.g., Turkish as default along with English), follow the steps below: {% stepper %} {% step %} ### Configure Language for Omnitron Service * Navigate to the **Project Details** page. * Click on the **Omnitron** service.

* Click the **VIEW ENVIRONMENT VARIABLES** button.

* Add the following two variables using the **+ NEW ENVIRONMENT VARIABLE** button:\ \ ***For locales:*** * `Name`: `LANGUAGES` * `Value`: `tr-tr=Turkish,en-us=English`

***For default language:*** * `Name`: `LANGUAGE_CODE` * `Value`: `tr-tr`

{% endstep %} {% step %} ### Configure Language for Commerce Service * Return to the **Project Details** page. * Click on the **Commerce** service.

* Click the **VIEW ENVIRONMENT VARIABLES** button.

* Again, add the **same two variables** as configured for Omnitron:\ \ ***For locales:*** * `Name`: `LANGUAGES` * `Value`: `tr-tr=Turkish,en-us=English`

***For default language:*** * `Name`: `LANGUAGE_CODE` * `Value`: `tr-tr`

{% endstep %} {% step %} ### Final Step: Redeploy to Apply Language Settings After adding the language environment variables, the new language settings will only take effect **after a new version is deployed** for both Commerce and Omnitron services. > 📩 **Please contact the Akinon team** to request a new deployment version for each service. Once deployment is complete, the newly added locales will become available and selectable within the **Locales** section in **Omnitron Frontend**.

{% endstep %} {% endstepper %} # 3. Define Store Currencies In addition to language settings, it is essential to configure the **currencies** your project will support. By default, the system is configured to use the Turkish Lira (`try`). If you wish to use a different currency, follow the steps below to ensure proper setup. {% stepper %} {% step %} ### Define Supported Currencies \[`AVAILABLE_CURRENCIES`] To use a currency other than the default, it must first be added to the system via the `AVAILABLE_CURRENCIES` dynamic setting. * Navigate to **Omnitron > Sales Channels > Sales Channel Settings > Dynamic Settings**. * Locate the `AVAILABLE_CURRENCIES` setting. * Click on the **+ Add Field** button. * From the dropdown menu, select the currency (e.g., `usd`, `eur`, etc.) you want to enable. * Click **Save** to apply the change.

⚠️ If a currency is not defined in `AVAILABLE_CURRENCIES`, attempting to use it in the next step as the default currency will result in an error. {% endstep %} {% step %} ### Set the Default Currency \[`DEFAULT_CURRENCY`] After defining the available currencies, you must designate one of them as the default currency. * In the same location (**Omnitron > Sales Channels > Sales Channel Settings > Dynamic Settings**), locate the `DEFAULT_CURRENCY` setting. * In the **Value** field, enter the code of the currency you previously added via `AVAILABLE_CURRENCIES`. * Click **Save**.

{% endstep %} {% step %} ### Supported Currency Codes The system currently supports the following currency codes: ``` try ➡ Turkish Lira 🇹🇷 eur ➡ Euro 🏦 usd ➡ US Dollar 🇺🇸 egp ➡ Egyptian Pound 🇪🇬 gbp ➡ British Pound 🇬🇧 mad ➡ Moroccan Dirham 🇲🇦 pln ➡ Polish Zloty 🇵🇱 sar ➡ Saudi Riyal 🇸🇦 ron ➡ Romanian Leu 🇷🇴 uah ➡ Ukrainian Hryvnia 🇺🇦 czk ➡ Czech Koruna 🇨🇿 huf ➡ Hungarian Forint 🇭🇺 rub ➡ Russian Ruble 🇷🇺 bgn ➡ Bulgarian Lev 🇧🇬 iqd ➡ Iraqi Dinar 🇮🇶 kwd ➡ Kuwaiti Dinar 🇰🇼 bhd ➡ Bahraini Dinar 🇧🇭 omr ➡ Omani Rial 🇴🇲 qar ➡ Qatari Rial 🇶🇦 aed ➡ UAE Dirham 🇦🇪 ngn ➡ Nigerian Naira 🇳🇬 inr ➡ Indian Rupee 🇮🇳 lei ➡ Romanian Leu 🇷🇴 kzt ➡ Kazakhstani Tenge 🇰🇿 jod ➡ Jordanian Dinar 🇯🇴 rsd ➡ Serbian Dinar 🇷🇸 ``` {% endstep %} {% endstepper %} # 4. Format Phone Numbers If your customers are located outside of Turkey, it's essential to configure phone number validation and formatting rules appropriately. By default, Akinon systems are configured to validate Turkish mobile numbers. To ensure accurate data collection for international numbers, you must adjust two dynamic settings.
{% stepper %} {% step %} ### Define the Validation Rule with Regex \[`USER_PHONE_REGEX`] The `USER_PHONE_REGEX` dynamic setting defines the validation rule for user phone numbers using a regular expression (regex). **To configure this setting:** * Go to **Omnitron > Sales Channels > Sales Channel Settings > Dynamic Settings**. * Locate the `USER_PHONE_REGEX` setting. By default, this setting is configured for Turkish phone numbers: ```regex ^(05)\d{9}$ ``` **Breakdown of the default pattern:** * `^` — Anchors the match to the beginning of the string * `(05)` — The number must start with “05” * `\d{9}` — Followed by exactly 9 digits * `$` — Anchors the match to the end of the string This pattern matches exactly 11-digit Turkish mobile numbers (e.g., 05xxxxxxxxx). If your store serves users in other countries, you should **replace this pattern with a valid regex** for your desired format. Need help with regex? [Here's a great resource](https://regex101.com/) for building patterns. Once entered, **click Save** to apply the setting.

{% endstep %} {% step %} ### Define the Display Format \[`USER_PHONE_FORMAT`] The `USER_PHONE_FORMAT` dynamic setting controls the **human-readable** format for displaying user phone numbers. **To configure this setting:** * Stay in the **Dynamic Settings** section of the same Sales Channel. * Locate the `USER_PHONE_FORMAT` setting. * Enter the display format for phone numbers based on your country’s format (e.g., `+44XXXXXXXXXX` or `XXXXXXXXXX`). * Click **Save** to apply the setting.

> ⚠️ The format you define in `USER_PHONE_FORMAT` **must be consistent** with the validation rule defined in `USER_PHONE_REGEX`. > > If they conflict, warning messages will be shown to users when inputting their phone numbers. > {% endstep %} > {% endstepper %} # 5. Integrate Omnitron & Integrator Before products can appear on your live site, you must first configure the catalog, product details, prices, stock information, payment, and shipping options in **Omnitron**. These configurations also enable data exchange between your ERP and Omnitron via **Integrator Flows**, ensuring real-time updates. This section outlines the complete setup process—starting from catalog creation to address mapping—to ensure your products are ready for storefront. ### 1. Creating a Catalog A **Catalog** is the foundational structure for managing products in Omnitron. It acts as a container that groups together product data, stock and price lists, and channel assignments. Every product you create, as well as its related configurations, must be assigned to a catalog to be published to the storefront.

Once the catalog is created: * Products should be linked to this catalog. * Price and stock lists should be associated. * Sales channels should be assigned to this catalog to ensure proper product visibility. {% hint style="success" %} For step-by-step instructions on creating and configuring a catalog, refer to the [Catalogs](/tutorials/omnitron/products-and-catalogs/how-to-manage-catalogs-in-omnitron) tutorial. {% endhint %} Once the catalog is created, you can proceed with defining **Attributes** and **Attribute Sets** to describe your products in detail. *** ### 2. Creating Attributes and Attribute Sets Before creating products, you need to define their characteristics. This is done through **Attributes**, which are specific properties like color, size, or material.

Once you have several attributes that logically belong together (e.g., size and color for clothing), you can bundle them into an **Attribute Set**. Attribute Sets make it easier to manage product structures and apply them consistently across similar product types or categories.

These elements not only help define your products clearly but also enable filtering and categorization in your storefront. {% hint style="success" %} For step-by-step instructions on creating and configuring attributes and attribute sets, refer to the [Attributes and Attribute Sets](/tutorials/omnitron/products-and-catalogs/how-to-create-product-attributes-and-attribute-sets-in-omnitron) tutorial. {% endhint %} *** ### 3. Creating Products With your catalog and attributes and attribute sets in place, you can now begin creating products. Each product must be associated with a catalog and assigned an attribute set that reflects its characteristics. To get started quickly, creating a **Simple** product type is enough for now. For detailed, step-by-step instructions on how to create and configure all product types, refer to the [**Product Types**](/technical-guides/omnitron/product-types) tutorial. When creating a product, you will: * Enter basic product information (name, SKU, base code, etc.). * Select the appropriate attribute set.

* After entering basic product details and saving, a **Product Pictures** section will appear—upload at least one image. Images are mandatory for product visibility in storefront.

* **Image Requirements & Limitations** To ensure proper display and performance across all devices and channels, product images must meet the following requirements: * **Accepted file formats:** `jpeg`, `jpg`, `png`, `gif`, `webp` * **Minimum requirement:** At least one image must be uploaded per product. * **Maximum dimensions:**\ Image size is controlled by a dynamic configuration setting called `MAX_IMAGE_DIMENSIONS`, which ensures uploaded images do not exceed certain dimensions for performance and quality purposes. **Default limits:** ```json MAX_IMAGE_DIMENSIONS = { "WIDTH": 2000, "HEIGHT": 2000 } ``` If an uploaded image exceeds these dimensions, it may be automatically rejected or resized depending on system behavior and configuration.\\

* This way, the product you created will be listed in the Product Pool.

{% hint style="info" %} **Alternative: Using Integrator Product Flow** While it’s possible to create and manage products manually, it’s strongly recommended to automate the process using the **Integrator** [**Product Flow**](/tutorials/integrator/flows/product-flow). This ensures real-time synchronization between your ERP system and Omnitron. {% endhint %} *** ### 4. Creating a Price List Every product must be assigned a price. To manage this, you first need to create a **Price List** in Omnitron. A price list can include multiple products, and each can have its own price within that list. Key steps: * Create a price list.

* Add product entries and define the selling price for each product.

{% hint style="success" %} For step-by-step instructions on creating and configuring price lists, refer to the [**Price Lists**](/tutorials/omnitron/products-and-catalogs/how-to-create-and-update-price-lists-in-omnitron) tutorial. {% endhint %} {% hint style="info" %} **Alternative: Using Integrator Price Flow** While this can be done manually, it's more efficient to use the **Integrator** [**Price Flow**](/tutorials/integrator/flows/price-flow), which pulls pricing information directly from your ERP. {% endhint %} *** ### 5. Creating a Stock List Just like pricing, stock availability is essential for product visibility and order processing. A **Stock List** defines the stock quantity of products and links them to a specific catalog and sales channel. Key steps: * Create a stock list.

* Add product entries and their available stock quantities.

{% hint style="success" %} For step-by-step instructions on creating and configuring stock lists, refer to the [**Stock Lists**](/tutorials/omnitron/products-and-catalogs/how-to-create-and-update-stock-lists-in-omnitron) tutorial. {% endhint %} {% hint style="info" %} **Alternative: Using Integrator Stock Flow** Use the **Integrator** [**Stock Flow**](/tutorials/integrator/flows/stock-flow) to automate stock updates based on your ERP system. This avoids inconsistencies and ensures up-to-date inventory data. {% endhint %} *** ### 6. Catalog Control and Assignments The catalog configuration process includes multiple detailed steps—**each of which must be followed carefully to ensure your products are correctly displayed in the storefront**. From assigning products to catalogs, linking price and stock lists, setting categories, to final catalog validation and sorting—each task plays a critical role and must be completed carefully and thoroughly. Otherwise, even if your product configurations are technically correct, they may not be visible in the storefront. {% stepper %} {% step %} #### **Add Products to Catalog** On the **Product List** step, products are added to the catalog from the product pool. * Products can be added individually or in bulk. * If the **Showing Added Products** checkbox is selected, only unassigned products will be displayed. * This step links products with the catalog.

{% endstep %} {% step %} #### Assign a Price List From the **Price List** step, a relevant price list must be assigned. * Without a price list, products won’t have pricing information and cannot be sold.

{% endstep %} {% step %} #### Assign a Stock List Navigate to the **Stock List** step to assign a stock list to the catalog. * Without stock data, products are considered unavailable.

{% endstep %} {% step %} #### Categorize Products On the **Categories** step, the category tree is created, and products are assigned to categories. * Category structure improves product discoverability and enhances product organization. * For additional flexibility, product categorization can be done automatically using **Auto Assign Rules**, which allow bulk category assignments based on defined conditions. Explore more in the [**Product Categorization**](/technical-guides/omnitron/product-categorization) documentation.

{% endstep %} {% step %} #### Catalog Control (💡 The Most Critical Step) The **Catalog Control** page is your final checkpoint to verify that all assignments are correctly made. * After all assignments are made, apply the following filters on the product list section. * ***Catalog View: Only products with Catalog***\ Filters and displays only the products that are linked to a catalog. This ensures that the product is part of a defined catalog structure and can be routed through sales channels. * ***Category View: Only products with Category***\ Filters products that are assigned to a category. Products must belong to at least one category to be properly browsed and displayed on the storefront. * ***Price List View: Only products with Price List***\ Displays products with a price defined via a price list. Without pricing, products cannot be purchased or shown with their price details. * ***Stock List View: Only products with Stock List***\ Filters for products that have stock entries in the stock list. Products with no stock won’t be purchasable, even if visible. * ***Image: Exist***\ Filters for products that have at least one image uploaded. As product images are mandatory for storefront visibility, this filter helps confirm visual completeness.

* After applying filters, if products do not appear in the product list, they will not show up in the storefront, even if all configurations are technically correct. It's essential to verify that everything is properly assigned to the correct catalog for products to be visible in the storefront. {% endstep %} {% step %} #### Sorting From the **Sorting** step, define how products should appear in each category or collection.

{% endstep %} {% step %} #### Assign Sales Channels On the **Sales Channels** step, connect your catalog to the appropriate sales channels. * Without a sales channel assignment, your catalog cannot go live in any store.

{% endstep %} {% step %} #### Configure Settings In the **Settings** step, you can rename your catalog.

{% endstep %} {% endstepper %} **In summary**, your catalog setup is only complete once all steps have been carefully followed and verified—especially via the **Catalog Control** page. Each configuration depends on the others, and skipping even one can result in products not appearing on the live site. *** ### **7. Creating a Payment Option** To enable order placement, at least one **Payment Option** must be configured in Omnitron. For a quick setup, we can define a **Funds Transfer** payment type. {% hint style="success" %} For step-by-step instructions on creating and configuring a payment option, refer to the [**Payment Options** ](/tutorials/omnitron/sales-channels/payment-management/how-to-manage-payment-options-in-omnitron)tutorial. {% endhint %} As part of the configuration, a JSON config must be provided: ```json {"initial_order_status": "300"} ``` **What does `"initial_order_status": "300"` mean?** This parameter defines the initial status the order will have **immediately after it is created** via this payment option. * **300 → `payment_waiting`**:\ The order has been received, but payment is still pending. The order remains on hold until the customer completes the payment process. {% hint style="success" %} For a complete list of available order status codes and their meanings, please refer to the [**Order Status Codes documentation**](https://apidocs.akinon.com/omnitron/integration/order/order-status-codes-and-cancellation-statuses)**.** {% endhint %}

Then, define a bank account to be associated with Funds Transfer payment option: * Create a bank * Add an IBAN

This setup ensures that the payment method appears as an option during checkout. {% hint style="success" %} Detailed instructions are available in the [**Banks**](/tutorials/omnitron/sales-channels/payment-management/how-to-manage-banks-in-omnitron) documentation. {% endhint %} *** ### **8. Creating a Shipping Option** Shipping management requires defining both a **Shipping Company** and corresponding **Shipping Options**. Steps include: * Creating a shipping company with the correct ERP code (used as the slug in defining shipping option step).

* Defining a shipping option that references the company and includes calculator and rule, delivery time, etc.

These options determine how deliveries are calculated and presented to customers. {% hint style="success" %} See the [**Shipping Company**](/tutorials/omnitron/settings/how-to-add-and-configure-a-shipping-company-in-omnitron) and [**Shipping Options**](/tutorials/omnitron/sales-channels/sales-channel-settings/how-to-manage-shipping-options-in-omnitron) documentation for full setup guidance. {% endhint %} *** ### **9. Creating a Delivery Option** **Delivery Options** define where products will be delivered, based on the customer's address, a retail store, or a pickup location. These options are crucial for managing the logistics flow, ensuring products are delivered to the correct destination. You can configure delivery rules for: * Customer's address * Retail store delivery * Pickup locations

{% hint style="success" %} Follow the steps in the [**Delivery Options**](/tutorials/omnitron/sales-channels/sales-channel-settings/how-to-manage-delivery-options-in-omnitron) documentation to set up these delivery options based on the type of destination chosen. {% endhint %} *** ### **10. Address Mapping** The final step before your products go live is configuring **Address Mapping**. This ensures that the geographical data from your ERP matches the address structure required by Omnitron. By default, mappings for **Turkey** are preloaded. If you're operating in another country, you’ll need to manually map those addresses. {% hint style="success" %} Use the [**Address Mapping**](/tutorials/omnitron/sales-channels/sales-channel-settings/how-to-manage-address-mapping-in-omnitron) documentation to perform this task correctly. {% endhint %} With these essential setups in place, you can now proceed with launching Project Zero to bring your products live and start selling. # 6. Set Up Project Zero Project Zero is Akinon's customizable frontend framework built on Next.js, designed to provide brands with a fast, modern, and flexible storefront experience. Once your products, prices, inventory, and channel settings are successfully configured in Omnitron, setting up Project Zero is the final step to bring your storefront to life. This setup process connects your backend data to a fully functional frontend, enabling users to browse products, add them to cart, and complete orders using defined payment and shipping methods. Below is a step-by-step guide to setting up, configuring, and deploying your Project Zero application within the ACC platform. Follow these instructions to: * Create a new Project Zero app in ACC * Configure environment variables and Git access * Deploy your app and connect it to your project * Go live with a fully integrated storefront experience Let’s begin. *** ### 1. Creating a New Project Zero Application To begin, you need to create a new Project Zero application in ACC: {% stepper %} {% step %} Navigate to the **ACC Dashboard** and open the **My Applications** page. {% endstep %} {% step %} Click on the **+ NEW APPLICATION** button.

{% endstep %} {% step %} Fill in the form for Project Zero: * **Application Type**: Select `Zero NextJS` * **Product Images**: Upload at least 4 images.

{% endstep %} {% step %} After completing the form, click **APPLY** to create your application. Your application will now appear on the **My Applications** page.

{% endstep %} {% endstepper %} *** ### 2. CLI Setup and Project Initialization To set up your Project Zero storefront, begin by installing the required package manager and initializing the project using the Project Zero CLI tool. {% stepper %} {% step %} ### Install Yarn It is recommended to use **Yarn** as the package manager. Depending on your operating system, follow the appropriate installation method: **For macOS users:** ```bash brew install yarn ``` **For non-macOS users:** ```bash npm i -g yarn ``` {% endstep %} {% step %} ### Initialize the Project with CLI Use the CLI to generate your storefront project: ```bash npx @akinon/projectzero@latest --create ``` When prompted, provide the following information: * **Brand name (required):** Enter the name of your storefront (e.g., `Project Zero`). * **Project description (optional):** Add an optional description for your project. * **Commerce URL (optional):** Provide the URL to connect to Omnitron. This value can also be edited later in the environment configuration file. {% endstep %} {% step %} ### Navigate the Project Directory Once the setup is complete, move into the generated project directory: ```bash cd project-path/project-name ``` {% endstep %} {% endstepper %} *** ### 3. Adding Your SSH Key To enable build and deploy operations via Git: {% stepper %} {% step %} Generate your SSH public key and copy it to the clipboard: ```bash cat ~/.ssh/id_rsa.pub | pbcopy ``` {% endstep %} {% step %} In ACC, navigate to **Settings > Public Keys**.

{% endstep %} {% step %} Click **+ NEW PUBLIC KEY**, enter a label and paste your copied key. Click **SAVE**.

{% endstep %} {% endstepper %} *** ### **4. Add the Remote Repository** Connect your local directory to the repository ACC generated for your app: {% stepper %} {% step %} In **My Applications**, locate your app and copy the **Repository URL**.

{% endstep %} {% step %} In your local project directory: ```bash git init git remote add acc git remote -v ``` {% endstep %} {% endstepper %} *** ### **5. Commit and Tag the Application** {% stepper %} {% step %} Ensure all changes are committed and tag your version for deployment: ```bash git add . git commit -m "Initial Project Zero commit" git tag git push acc ``` Use a meaningful tag name that reflects your build version. {% endstep %} {% endstepper %} *** ### **6. Build from ACC** To build your application: {% stepper %} {% step %} Go to **My Applications**, and click on your Project Zero app. {% endstep %} {% step %} In the **Versions** section, click the **BUILD** button. {% endstep %} {% step %} Enter: * The **tag name** you pushed * An optional **description** {% endstep %} {% step %} Click **BUILD**.

{% endstep %} {% step %} Once the build status changes to **Completed**, mark it as the **Stable Version**.

{% endstep %} {% endstepper %} ### **7. Add App to Project via App Store** To link the application to your ACC project: {% stepper %} {% step %} Open the **App Store** in ACC. Locate your Project Zero application and click on it.

{% endstep %} {% step %} Choose the project to install the app into. Select `Commerce` as the **Connected Service.** Click **NEXT.**

{% endstep %} {% step %} Then **INSTALL** on the approval page.

{% endstep %} {% step %} Once the installation is complete, you’ll see a success message.

{% endstep %} {% step %} Your app is now listed under the **Applications** tab in your **Project Detail Page**.

{% endstep %} {% endstepper %} *** ### 8. Add Environment Variables In your application settings on ACC, add the following environment variables: | Variable Name | Description | Example URL / Value | | --------------------- | ---------------------------------------------------------------------------- | -------------------------------------------------- | | `NEXTAUTH_URL` | Project Zero URL | `https://your-zero-app.lb.akinoncloud.com` | | `NEXTAUTH_SECRET` |

Auth secret, run in terminal:
openssl rand -base64 32

| `iHBeNJAOVWvFZL4PmyHVA7b6y28Tvc47NJi4zdX2sPI=` | | `NEXT_PUBLIC_URL` | Same as `NEXTAUTH_URL` | `https://your-zero-app.lb.akinoncloud.com` | | `SERVICE_BACKEND_URL` | Commerce service URL | `https://your-commerce-service.lb.akinoncloud.com` | To add them: {% stepper %} {% step %} Go to **Project Detail > Project Zero Application Detail** page. {% endstep %} {% step %} Open the **Environment Variables** tab.

{% endstep %} {% step %} Click **+ NEW ENVIRONMENT VARIABLE** for each entry.

{% endstep %} {% endstepper %} ### **9. Deploy to Project** To apply your changes and reflect the Project Zero layout on the storefront: {% stepper %} {% step %} In **My Applications**, open your Project Zero app. {% endstep %} {% step %} In the **Installed Projects** section, choose your project. Click **DEPLOY SELECTED PROJECTS.**

{% endstep %} {% step %} In the pop-up: * Enter the **tag name** of your last successful build. * Start the deployment.

{% endstep %} {% step %} Once complete, the deployment status will update to `Deployed`.

{% endstep %} {% endstepper %} *** ### **10. Access the Storefront** You’re all set! To access your storefront: {% stepper %} {% step %} Go to the **Project Detail** page. Click into the **Project Zero app details**. {% endstep %} {% step %} Find the **Project Zero URL.**

{% endstep %} {% step %} Open the link in your browser with `/list` at the end, e.g.: ``` https://your-zero-app.lb.akinoncloud.com/list ``` {% endstep %} {% step %} You should see your listed products, which means your setup was successful.

***

***

{% endstep %} {% endstepper %} With your Project Zero storefront live and fully integrated, your commerce environment is now ready for action. Customers can browse your catalog, add products to their cart, choose from your configured shipping options, and complete their orders using the defined payment methods. All backend configurations—from product data to pricing and logistics—are now perfectly aligned with the frontend experience. Congratulations! Your shop is officially open for business. Time to welcome your first customers and start selling! :rocket: # Launch Your Marketplace with Seller Center The **Seller Center** allows Akinon customers to build and manage marketplaces through a single platform. Designed as an add-on, it works in conjunction with **Omnitron** to provide seamless integration and functionality. This guide walks you through the steps to connect your Omnitron with the Seller Center, enabling you to set up and configure your marketplace within the **ACC**. This guide will help you: * Create a Seller Center in ACC * Complete essential configurations * Create and manage Sellers * Manage offers and products as both Seller and Marketplace Owner * Manage orders and packages as a Seller **Below are the steps to get started and successfully complete the setup process.** ## 1. Create a Seller Center in ACC To get started: * Log in to your **ACC Dashboard** and navigate to the **Projects** page. * Select the project where you want to create the Seller Center. * Click **+ NEW SERVICE** and select **Seller Center** from the list. ![](https://164766933-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FszVHHD4skw8SftKawRsw%2Fuploads%2FiiLU01Ld7rBeXAVH3u3K%2F0.png?alt=media\&token=0377d020-2d04-4bc2-8d58-c0264d1660bd) After selection, you’ll see a list of environment settings required to configure the application under the **"Configure Seller Center Application Values"** section. Here’s what each setting means:

Settings	Description
OMNITRON_CATALOG_ID	This dynamic setting represents the Omnitron Catalog ID used in the Seller Center. It is required when sellers create collections or retrieve category nodes during the offer creation process. The Catalog ID can be obtained from the relevant Omnitron.
OMNITRON_CHANNEL_ID	This setting defines the Omnitron Channel ID used in the Seller Center to access Commerce-related services. The value corresponds to the Sales Channel ID in Omnitron and can be retrieved from the appropriate Omnitron.
OMNITRON_FAILED_CANCELLATION_REASON_ID	This setting refers to the Cancellation Reason ID from Omnitron, used when a package delivery fails and the seller initiates a cancellation request for a refund. These IDs can be created and retrieved via Omnitron > Settings > Reasons for Cancellation / Return.
OMNITRON_ALLOWED_CANCELLATION_REASON_IDS	This setting includes the list of Cancellation Reason IDs from Omnitron that sellers are permitted to use when rejecting an order item in the Seller Center. These IDs can be created and managed through Omnitron > Settings > Reasons for Cancellation / Return.
OMNITRON_REJECTED_CANCELLATION_REASON_ID	This setting defines the default rejection reason used when a seller rejects an order item without providing any of the IDs listed in OMNITRON_ALLOWED_CANCELLATION_REASON_IDS. Cancellation reasons can be configured via Omnitron > Settings > Reasons for Cancellation / Return.
COMMERCE_STORE_PAGE_DATA_WIDGET_ID	This setting represents the Widget Type ID used on the Store Management page in the Seller Center. Sellers use this widget to design their storefront homepages on the marketplace. Widget Types can be created in Omnitron. For more details, see: How to manage widget schema in Omnitron
COMMERCE_PRODUCT_RECOMMENDATION_WIDGET_ID	This setting indicates the Widget Type ID for the Product Collection widget, used on the Store Management page in the Seller Center. Widget Types can be created in Omnitron. For more details, refer to: How to manage widget schema in Omnitron

Click **SAVE AND CONTINUE** to install the Seller Center BE and FE applications into your selected project.

## 2. Complete Seller Center Configurations After the installation is complete and the necessary configurations are made in ACC, all relevant data—such as the Catalog, Category Tree, Sales Channel, Attributes, Attribute Values, Attribute Sets, Order Cancellation Reasons, Cities, Townships, Districts, and more—will be automatically transferred from Omnitron to the Seller Center. The Seller Center has two main user roles: **Marketplace Owners (MPOs)** and **Sellers**. By default, Omnitron Super Users are assigned the role of MPO in the Seller Center. Therefore, once the installation is complete, you can log in to the Seller Center **using the Omnitron Super User credentials for the installed project as an MPO**. To ensure the Seller Center functions correctly, there are both **mandatory** and **optional** configurations that need to be completed. These configurations must be created and managed by MPOs, and will be explained in detail in the following sections. ### Mandatory Configurations #### **Attribute Set & Category Mapping** To allow Sellers to create offers for specific categories, **Attribute Sets** must be mapped to **Categories**. This mapping ensures that Sellers are aware of the required attribute configurations for each category. As mentioned earlier, Attribute Set and Category Tree data are retrieved from Omnitron. To perform the mapping: {% stepper %} {% step %} Go to **Settings** in the Seller Center. {% endstep %} {% step %} Open the **Attribute Set & Category Mapping** page. {% endstep %} {% step %} You will see the category tree displayed in a hierarchical format. Each leaf category will have a dropdown menu. {% endstep %} {% step %} These dropdowns contain the Attribute Sets created in Omnitron. {% endstep %} {% step %} Select the most appropriate Attribute Set for each category and click **SAVE**. {% endstep %} {% endstepper %}

{% hint style="warning" %} Once the Attribute Set & Category Mapping is complete, the attributes defined within the mapped Attribute Sets will be activated and appear as filters in the application. {% endhint %} {% hint style="success" %} For a step-by-step tutorial, please visit: [How to manage attribute set and category mapping](https://docs.akinon.com/tutorials/seller-center/marketplace-owner/settings/how-to-manage-attribute-set-and-category-mapping) {% endhint %} #### **Delivery Settings** This configuration allows Sellers to choose from different shipping options as defined by the MPOs depending on various scenarios. To configure delivery settings: {% stepper %} {% step %} Select the most appropriate Attribute Set for each category and click **SAVE**. {% endstep %} {% step %} Navigate to **Settings** in the Seller Center. {% endstep %} {% step %} Open the **Delivery Settings** page. {% endstep %} {% step %} Click on the **+ Add New Delivery Setting** button. {% endstep %} {% step %} Fill in the required fields and save. {% endstep %} {% endstepper %} ![](https://164766933-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FszVHHD4skw8SftKawRsw%2Fuploads%2FhXwVzQDLyMpb2oLmZ1Td%2F3.png?alt=media\&token=f56c1061-ff5e-43e2-9428-92ade7131a64)

{% hint style="warning" %} All created delivery settings will be visible to every Seller. {% endhint %} {% hint style="warning" %} If you intend to include a contracted shipping company as a Delivery Setting, the relevant Cargo Extension Application must be linked to the project in ACC. {% endhint %} {% hint style="warning" %} A default callback delivery setting—displayed as "Other - Other"—is automatically created when the Seller Center is set up. {% endhint %} {% hint style="success" %} For detailed guidance, refer to: [How to manage delivery settings in Seller Center](https://docs.akinon.com/tutorials/seller-center/marketplace-owner/settings/how-to-manage-delivery-settings-in-seller-center) {% endhint %} {% hint style="success" %} Additional information about shipping rules and calculations is available at: [Shipping Rules Calculator](https://docs.akinon.com/technical-guides/commerce/shipping-rules-calculator) {% endhint %} #### **Offer Reject Reasons** This configuration allows MPOs to select reasons for rejecting Seller-created offers. These reasons will be visible on the corresponding marketplace product pages. To create Offer Reject Reasons: {% stepper %} {% step %} Go to **Settings** in the Seller Center. {% endstep %} {% step %} Open the **Offer Reject Reasons** page. {% endstep %} {% step %} Click on the **+ Add New Offer Rejection Reason** button. {% endstep %} {% step %} Complete the necessary fields and save. {% endstep %} {% endstepper %}

{% hint style="success" %} For more details, visit: [How to manage offer reject reasons in Seller Center](https://docs.akinon.com/tutorials/seller-center/marketplace-owner/settings/how-to-manage-offer-reject-reasons-in-seller-center) {% endhint %} ### Optional Configurations #### **Mail Configurations** The Seller Center sends email notifications to users (both Sellers and MPOs) on specific occasions—such as when a new order is received, a password reset is requested, or Seller documents are updated. MPOs can customize the **brand name**, **sender email address**, and **Contact Us** URL for these emails. To configure email settings: {% stepper %} {% step %} Navigate to **Settings** in the Seller Center. {% endstep %} {% step %} Open the **Dynamic Settings** page. {% endstep %} {% step %} Configure the following dynamic settings based on your brand’s needs:

Parameter	Description	Default Value
EMAIL_BRAND_TEXT	Sender name to appear in outgoing emails.	Akinon
DEFAULT_FROM_EMAIL	Email address from which emails will be sent.	noreply@akinon.com
EMAIL_CONTACT_URL	URL that opens when the “Contact Us” link in the email is clicked.	akinon.com

{% endstep %} {% endstepper %} #### **Seller Performance Metrics** Seller performance in the application can be evaluated based on specific metrics, helping to maintain high marketplace standards. The following metrics are available:

Metric	Description
Seller Cancel Rate	Percentage of orders canceled by the seller. Lower rates indicate higher reliability.
Customer Cancel Rate	Percentage of orders canceled by customers. High rates may point to product/service issues.
Shipment in Target Duration	Percentage of orders delivered within the expected delivery window. Timely deliveries enhance customer satisfaction.
Seller-Related Delivery Problems	Percentage of delivery issues caused by the seller. Lower rates indicate fewer problems.

To configure performance metrics and assign weights: {% stepper %} {% step %} Go to **Finance** in the Seller Center. {% endstep %} {% step %} Open the **Seller Performance Metrics** page. {% endstep %} {% step %} Adjust the weight and related values for each metric as needed.

{% endstep %} {% endstepper %} #### **BuyBox Weight Configurations** **BuyBox** is a feature commonly found on eCommerce platforms that allows customers to add a product directly to their cart and make a purchase. It typically highlights the offer from the seller providing the best combination of price, shipping options, and customer service. In the Seller Center, the BuyBox calculation is influenced by several factors, including the **Seller Rating**, **Offer Pricing**, and whether the seller is marked as **Premium or not**. MPOs can configure the weight of each factor accordingly. To configure BuyBox weight settings: {% stepper %} {% step %} Navigate to **Settings**. {% endstep %} {% step %} Open the **Dynamic Settings** page. {% endstep %} {% step %} Set the following parameters according to their descriptions:

Parameter	Description	Notes
PP_GRADE_WEIGHT	Weight of the Seller Rating in the BuyBox calculation.	Accepts a decimal value between 0 and 1
PP_PRICE_WEIGHT	Weight of the Seller’s Offer Price in the BuyBox calculation.	Accepts a decimal value between 0 and 1
PP_DATASOURCE_PREMIUM_POINT	The point value awarded to a seller marked as Premium in the BuyBox calculation.
PP_GRADE_VERSION	The version identifier for the BuyBox calculation logic.	Must be incremented by 1 whenever any related setting changes
PP_UPPER_LIMIT_RATIO	Maximum percentage limit for the price range of an upcoming offer compared to other marketplace offers for the same product.
PP_LOWER_LIMIT_RATIO	Minimum percentage limit for the price range of an upcoming offer compared to other marketplace offers for the same product.

![](https://164766933-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FszVHHD4skw8SftKawRsw%2Fuploads%2FtgmTMpyAFBN80OwUzZK1%2F9.png?alt=media\&token=690ebf8a-5aba-492d-9162-863226c68294) {% endstep %} {% endstepper %} #### **Order Rejection Deductions** This configuration allows MPOs to define deduction rules for sellers when an order item is rejected. Deductions are applied to the seller’s commission earnings based on the selected rejection reason during the cancellation or return process. To configure: {% stepper %} {% step %} Navigate to **Settings**. {% endstep %} {% step %} Open the **Order Rejection Deductions** page. {% endstep %} {% step %} For each listed **Cancellation / Return Reason**, enter the deduction details that will be applied during seller reconciliation if that reason is selected. ![](https://164766933-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FszVHHD4skw8SftKawRsw%2Fuploads%2FWYN9U8xCi2bx7rXWX2vq%2F10.png?alt=media\&token=b90b6e63-20b2-4ceb-8177-eb95cd10cbb5) ![](https://164766933-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FszVHHD4skw8SftKawRsw%2Fuploads%2F1tFpmxIYeJxVFsQjXiyR%2F11.png?alt=media\&token=d4c79c16-d15c-4bc0-b2f1-c9fdb710d20d) {% endstep %} {% endstepper %} #### **Image Dimension Ranges** This configuration ensures that sellers upload product images within acceptable resolution limits, helping maintain visual consistency and quality across the platform. To configure: {% stepper %} {% step %} Navigate to **Settings**. {% endstep %} {% step %} Open the **Dynamic Settings** page. {% endstep %} {% step %} Set the following parameters based on the desired resolution guidelines (in pixels, defined by width x height):

Parameter	Description
MAX_IMAGE_DIMENSIONS	The maximum image resolution allowed for uploads to the Seller Center.
MIN_IMAGE_DIMENSIONS	The minimum image resolution allowed for uploads to the Seller Center.

![](https://164766933-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FszVHHD4skw8SftKawRsw%2Fuploads%2FItJxy0pqwpwQ69CAIfrV%2F12.png?alt=media\&token=62f47c92-b489-4032-9052-f9cb7f0e94a0) {% endstep %} {% endstepper %} ## 3. Create Sellers in Seller Center After completing the mandatory and optional configurations, you can proceed to add Sellers to the platform. To create a new Seller: {% stepper %} {% step %} Navigate to **Finance**. {% endstep %} {% step %} Open the **Seller Management** page. {% endstep %} {% step %} Click the **+ Add New Seller** button. {% endstep %} {% step %} Fill in the required information. {% endstep %} {% endstepper %} A password creation email will be sent to the address provided in the **Seller Email Address** field to allow the Seller to complete their account setup. {% hint style="success" %} For detailed information on Seller Management, refer to: [Seller Management Tutorial](https://docs.akinon.com/tutorials/seller-center/marketplace-owner/finance/seller-management) {% endhint %} ## 4. Manage Offers & Products in Seller Center In the Seller Center, Sellers can create offers—containing price, stock, and attribute information according to the related category—using three different methods: * One by one * In bulk * From the Marketplace Catalog menu In addition, MPOs have the ability to manage Seller-created offers. They can: * Approve offers * Reject offers * Resolve offers {% hint style="success" %} You can find more information about offer and product management at the following links: * For Sellers: [How to Add Product Offers Using Bulk Actions](https://docs.akinon.com/tutorials/seller-center/seller/products/how-to-add-product-offers-using-bulk-actions-in-seller-center) * For MPOs:[ How to Use Offer Actions](https://docs.akinon.com/tutorials/seller-center/marketplace-owner/products/how-to-use-offer-actions-in-seller-center) {% endhint %} {% hint style="success" %} Additionally, offer and product management can be handled via integration: [Seller Center Products API](https://apidocs.akinon.com/seller-center/products) {% endhint %} ## 5. Manage Orders & Packages in Seller Center In the Seller Center, if a Seller’s **Auto Pack** setting is enabled (True), the system automatically creates a package when an order is picked up. {% hint style="success" %} For detailed information on managing orders and packages, refer to the following resources: * [How to Manage Orders in Seller Center](https://docs.akinon.com/tutorials/seller-center/seller/orders/how-to-manage-orders-in-seller-center) * [How to Manage Packages in Seller Center](https://docs.akinon.com/tutorials/seller-center/seller/orders/how-to-manage-packages-in-seller-center) {% endhint %} {% hint style="success" %} Integration APIs are also available for order and package operations: * [Orders API](https://apidocs.akinon.com/seller-center/orders) * [Packages API](https://apidocs.akinon.com/seller-center/packages) {% endhint %} {% hint style="danger" %} ### Zero App Compatibility Note If a project in ACC is linked to the Seller Center, the **Product List** and **Product Detail** pages in the associated Zero application must correctly display products and offers. It is essential to ensure that the item being added to the cart is a valid **offer**, not just a product. {% endhint %} # Welcome to Akinon Tutorials To view additional Tutorials please Log in below; {% hint style="warning" icon="lock" %} **This section is for signed-in partners.** Sign in {% endhint %} Akinon Tutorials is the ultimate resource for comprehensive tutorials covering a wide range of topics related to Akinon's technologies. Our tutorials are designed to provide **in-depth learning materials**, **practical examples**, and **step-by-step guides** to help users master various aspects of Akinon's offerings and products. Each tutorial is thoughtfully crafted to ensure **clarity and ease of understanding**. We provide detailed explanations of concepts, accompanied by practical examples and code snippets to illustrate their application in real-world scenarios. By following along with the tutorials, users can gain hands-on experience and build a strong foundation in using Akinon's technologies. Whether users are a beginner or an experienced professional, our tutorials cater to learners of all levels, providing them with the knowledge and skills necessary to leverage Akinon's technologies effectively. We continuously update our tutorials to keep them **current and relevant**. As technologies evolve and new features are introduced, we ensure that our tutorials reflect the latest advancements, providing up-to-date information and guidance. Embark on your learning journey by exploring the Akinon Tutorials. Discover products and their functionalities, master key concepts with Akinon's step-by-step tutorials. # ACC # How to Manage Projects and Services On the **Projects** page of ACC, users have the flexibility to create projects for multiple brands. Each project is designed to focus on services and applications, and the test environment of a brand is handled as a distinct and separate project. This approach allows for efficient organization and management of various brand-related tasks and applications within their dedicated environments. ## Creating Project {% stepper %} {% step %} Log in to the platform and navigate to the **Projects**. A comprehensive list of all projects created in the partner's account is displayed on this screen. From this list, users can easily search for specific projects.

{% endstep %} {% step %} To create a new project, click on the **+New Project** button in the upper right corner of the screen.

{% endstep %} {% step %} To set up a new project for a brand, an authorized user should follow the steps for adding projects. Initially, fill in the related fields on the project details page: * **Project Name:** Provide a descriptive name, such as the brand name. * **Slug:** This unique value defines the project and should be specific to each project. It is used for communication between services, for example, a project-specific slug information is used to create a Sentry account. After completing the required information, click on the **Apply** button. This action will redirect users to the plan selection screen for the specified project, where they can proceed with further customization and setup.

{% endstep %} {% step %} The partner can easily select the plan that aligns with their business contract. Dynamically generated invoice amounts for each plan are presented to the partner, facilitating transparent pricing. Additionally, the products included in each plan are clearly displayed, empowering the partner to make informed decisions about their preferred plan.

{% endstep %} {% step %} To access the detail page of the created project, users can do so conveniently either from the welcome page or by locating the project in the left-side menu's project list and clicking on it. As mentioned on the welcome page, Omnitron installations will automatically commence immediately after the project is created.

{% endstep %} {% step %} After the Omnitron installations are complete, the setup status of the deployments will be seen as **Deployed**. At this point, new services and applications can be added to the project.

{% hint style="info" %} Omnitron credentials will be sent to the email address of the user who created the project. {% endhint %} {% endstep %} {% endstepper %} ## Adding Service {% stepper %} {% step %} To add new services available in the Akinon ecosystem to their project, click on the **+ New Service** button on the project detail page.

{% endstep %} {% step %} Instore, Live Commerce, OMS, and Commerce services can be automatically added to the project according to the application dependencies. For example, after the Omnitron installations, users can directly add Commerce, OMS, or Live Commerce to their project, but they will be prompted to choose a connected service to add Instore.

{% endstep %} {% step %} Initiate the deployment of Commerce by clicking the **Yes, Proceed** button. Next, add Instore to the project by entering a name and slug for the backend service, then select the previously added Commerce as the connected service.

{% endstep %} {% step %} To begin the deployment of the Instore backend, click on the **Apply** button. Once the backend deployment is initiated, the Instore frontend will automatically start deploying.

{% endstep %} {% step %} Clicking on a service name allows users to access detailed information such as URL, version, connected service, and more. Additionally, users have the option to customize the service name by clicking on the edit icon.

{% endstep %} {% step %} Users can conveniently access the logs of the services in their project by clicking on the icon located in the **Logs** column.

{% endstep %} {% step %} By clicking on the **View Real Time Logs** button, users can access real-time logs, providing up-to-date information on the ongoing processes. Moreover, users have the option to copy and download selected log types.

{% endstep %} {% step %} Users can easily obtain logs based on log types and for a specified date range from the **Application Log** field. The platform provides the convenience of sending the email download link of the logs directly to the user's email address.

{% hint style="info" %} The **Applications** table in the project detail offers an overview of various applications, including Project Zero, extensions, and more. Users can view deployment statuses, application details, and logs, similar to the information provided for services. To add an application created in ACC to projects, follow the tutorial titled Tutorials>Add Application via App Store. {% endhint %}

{% endstep %} {% endstepper %} # How to Use Demo Projects with ARC ACC and ARC (Akinon Rapid Commerce) offers various ready-to-use application package options to provide an easy and fast Akinon experience with just one click. This allows Akinon users to create demo projects with the provided application packages and experience Akinon digital commerce solutions end-to-end through ready-to-use applications with sample data. To create a demo project, users assigned the role must have **App Bundle** authorization. When a new account is created in ACC, the account owner is automatically assigned the Manager role, which includes App Bundle authorization. Users with this authorization can see the action to create a demo project on the **Projects** page.

{% stepper %} {% step %} Clicking the **+ Create Demo** button redirects users to the demo project setup detail page. On this page, users need to specify the demo project name and slug, select one of the available application packages. After filling in the necessary fields, clicking the **Start Demo** button initiates automatic project and application deployments with the specified details on the page.

{% endstep %} {% step %} The created demo project is listed on the **Projects** page and is distinguished from other projects by a different cardbox color.

{% endstep %} {% step %} After creating the demo project, the deployment of ready-to-use applications is automatically performed in sequence based on application dependencies. By clicking on the relevant demo project cardbox in the project page, users are directed to the project detail page where they can track the application setup status in the demo project.

{% hint style="info" %} Application deployments are carried out with stable versions if the stable version is marked and with the latest versions successfully built if not marked. After the Omnitron deployment is completed, user login information is sent to the ACC user who created the demo project via email. {% endhint %} {% endstep %} {% step %} It is not possible to add a new service/application to the project until the deployment of all applications in the selected application package is successfully completed. After successful deployments, a new service can be added to the project by clicking the **+ New Service** button. Services added later to the project are also deployed and ready for use with sample data.

{% hint style="info" %} The limit set for the number of applications in demo projects will be automatically assigned as the number of applications in the application package by default. An increase in the limit should be requested for services and applications to be added later to demo projects. {% endhint %} {% endstep %} {% step %} In the project detail page, similar to other projects, by clicking on the log icon, logs for demo projects can be viewed from the log detail page, and by clicking on the application names, the application detail page can be accessed. {% endstep %} {% endstepper %} # How to Move Apps into ACC If you've been developing a web application locally using the **Django** framework and are now ready to take it live, deploying it to **ACC** is a powerful next step. ACC provides a scalable, cloud-native environment designed for modern commerce applications, allowing you to host, build, and manage your apps with ease. {% stepper %} {% step %} If your application is written in **Python** using the **Django** framework, your local project directory may look like this: ``` ├── manage.py ├── quickstart │ ├── __init__.py │ ├── __pycache__ │ ├── asgi.py │ ├── settings.py │ ├── urls.py │ └── wsgi.py ├── requirements.txt ``` {% endstep %} {% step %} After setting up and running the application locally, you should see the expected output in the browser.

{% endstep %} {% step %} To run your application on **ACC**, you’ll need to add **three essential files** to your project directory: * `akinon.json` – This JSON file contains the manifest-level information of your application. * `Procfile` – Includes the necessary commands to run the application within ACC. * `build.sh` – ACC stores image files for each new version of the application. This shell script file should contain the package contents of these image files and instructions on how they should be executed. **Sample akinon.json:** ``` { "name": "Quickstart Project", "description": "Quickstart Project", "scripts": { "release": "", "build": "sh build.sh" }, "env": {}, "formation": { "web": { "min": 1, "max": "auto" } }, "runtime": "python:3.8-alpine", "addons": [] } ``` {% endstep %} {% step %} By including this file, specific requirements for ACC are defined regarding the Docker image of the application. This configuration guides versioning and the necessary commands during the build and release stages. It is important to note that the **akinon.json** file offers additional opportunities beyond these essentials. For more detailed information, refer to the [ACC App Manifest (akinon.json) and Procfile](/tutorials/acc/how-to-configure-your-acc-application-with-akinon.json-and-procfile). {% endstep %} {% step %} Next, the contents of the **build. sh** file will be explored: ``` set -euo pipefail apk add python3-dev g++ jpeg-dev zlib-dev libffi-dev --no-cache pip install -U --force-reinstall pip pip install -r requirements.txt apk del g++ python3-dev ``` {% hint style="info" %} Including this file allows specification of the actions ACC must take with the version image whenever a new version is built. {% endhint %} {% endstep %} {% step %} Finally, the **Procfile** must be added. ``` web: gunicorn quickstart.wsgi -w 4 -b 0.0.0.0:8008 --access-logfile - ``` Given that the **Gunicorn** library is being used to handle the **web** part of our application, it is crucial to specify the appropriate command in the Procfile using the standard format mentioned earlier. The provided command is responsible for running our application and setting the format for access logs. If you wish to run your own application, ensure that you input the required command in the 'web: command' format. {% hint style="info" %} The `web:` prefix is required, and the app **must run on port 8008**, which is the only supported port in ACC. {% endhint %} {% endstep %} {% step %} Three essential files have been added to the application directory. As a result, the application directory should now resemble the following: ``` ├── Procfile ├── akinon.json ├── build.sh ├── manage.py ├── quickstart │ ├── __init__.py │ ├── __pycache__ │ ├── asgi.py │ ├── settings.py │ ├── urls.py │ └── wsgi.py ├── requirements.txt ``` {% endstep %} {% step %} Your app is now ready to be deployed to ACC. {% endstep %} {% endstepper %} ## Creating a Public Key To enable ACC to create a repository for the application and allow for development submissions, users must register an SSH Public Key within the ACC. If a Public Key has been previously provided, this step can be skipped. {% stepper %} {% step %} To create an SSH Public Key, users can use the following command:

ssh-keygen -t rsa -b 4096

{% endstep %} {% step %} This command has created a Private and a Public Key. The Public Key will be generated under the **.pub** extension. Next, copy this Public Key: ``` pbcopy < ~/.ssh/acc_rsa.pub ``` {% endstep %} {% step %} If `pbcopy` doesn’t work, open the file manually and copy its contents. Then paste it into ACC. {% hint style="info" %} For more info, see the [**Public Keys**](/tutorials/acc/how-to-generate-and-add-public-keys-in-acc) documentation. {% endhint %} {% endstep %} {% endstepper %} ## Creating an Application Applications within the ACC are stored in **git** repositories. To publish each version, users must push the corresponding **tag** to the git repository in ACC. If the application is not currently versioned with git, a git repository can be created within the application directory by running the following command through the terminal: {% stepper %} {% step %} If you're not currently versioning the application with git, create a git repository within the application by running the following command in the application directory through the terminal: ``` git init ``` {% endstep %} {% step %} To link your git repository in the local environment to the one within ACC, first add a new ***remote*** registry to your local git repository. * **remote\_name**: For clarity, consider using a name that includes "acc" to distinguish it from your development repo. * **remote\_address**: Copy and paste the URL that starts with "ssh://" of your application from the application list on the “My Applications” page in ACC into this field. ``` git remote add [remote_name] [remote_address] ``` {% endstep %} {% step %} Lastly, execute the following command: ``` git remote add acc ssh://abcdefgh@git-codecommit.eu-central-1.amazonaws.com/v1/repos/abcdefghe-abcdefhgh ``` {% endstep %} {% step %} To verify whether you have successfully added it, run this command: ``` git remote -v ``` {% endstep %} {% step %} The application can now be sent from the local environment to ACC. Create a new tag and push the first version. ``` git add . git commit -m "Quickstart v1.0.0" git tag v1.0.0 git push acc v1.0.0 ``` {% endstep %} {% step %} After running the commands above, the v1.0.0 tag will be sent to the ACC repository. {% endstep %} {% endstepper %} The next step is to initiate the version build corresponding to this tag. ## Building Versions {% stepper %} {% step %} Go to the **“My Applications”** page in the ACC dashboard. Click on the name of your application. You’ll be directed to the application’s detail page, which includes a section for builds.

{% endstep %} {% step %} Follow the instructions under the **“Building Application”** section of the [My Application](/tutorials/acc/how-to-create-manage-build-and-deploy-applications-in-acc) documentation to trigger the build process. {% endstep %} {% step %} As your version is being built, you'll see one of the following statuses: * **Initializing**: The build has started and is being prepared. * **Completed**: The build finished successfully and is ready to deploy. * **Failed**: The build encountered an error. If the status shows **Failed**, click on the build to view the error logs and troubleshoot the issue. Once the build is marked **Completed**, you're ready to move on to deployment. {% endstep %} {% endstepper %} ## Creating a Project In ACC, applications are installed into **projects**, which allow you to run different versions of your app in different environments (e.g., staging, production). * If you **already have a project**, you can skip this step. * If not, follow the steps outlined in the **“Creating Project”** section of the [Project and Services](#creating-a-project) documentation. ## Installing the Application As there is currently no project linked to Omnitron, the next step is to install the application into a project. To do this, follow the steps outlined in the [App Store](/tutorials/acc/how-to-install-applications-from-the-app-store-in-acc) documentation under “Adding an Application to a Project.” ## Deploying the Application to the Project {% stepper %} {% step %} Go back to **“My Applications”** and click on your application’s name. Scroll to the **Installed Projects** section to see which project the app is installed in.

{% endstep %} {% step %} Follow the steps under the **“Deploying Application”** section in the [My Application](/tutorials/acc/how-to-create-manage-build-and-deploy-applications-in-acc) documentation. Once deployed successfully, the status will be updated to **Deployed**. {% endstep %} {% step %} Navigate to the **Projects** page. Select your project and locate your application under the **Applications** section. Click on the application name to view its details. The application details page includes the **URL** where the app is running.

{% endstep %} {% step %} Click the URL to launch your app—now fully deployed and running in ACC!

{% endstep %} {% endstepper %} Congratulations! Your application is now live on ACC. 🎉 The next step is to ensure your application has access to the necessary data. To configure database connectivity, continue with the [Configure Database Connections](/tutorials/acc/how-to-configure-database-connection-in-acc) guide. # How To Configure Database Connection in ACC This tutorial explains how to configure a **database connection** for your application in **ACC**. ## Recap: The `akinon.json` File Earlier, we created a basic `akinon.json` configuration file: ``` { "name": "Quickstart Project", "description": "Quickstart Project", "scripts": { "release": "", "build": "sh build.sh" }, "env": {}, "formation": { "web": { "min": 1, "max": "auto" } }, "runtime": "python:3.8-alpine", "addons": [] } ``` ## Configuring Addons The needs of the application can be met by adding various components such as database, cache, CDN, and more into the addons field. For detailed information about addons, please refer to this [link](/tutorials/acc/how-to-configure-your-acc-application-with-akinon.json-and-procfile#healthcheck). Below is the method to specify the addons required for the application within the akinon.json file: ``` { "...": "...", "addons": [ { "plan": "postgresql", // "options": { // "instance_type": "db.r5.large", // "instance_count": 1 // } } ] } ``` {% hint style="info" %} To specify addons, simply fill out the plan area in the akinon.json file. Optional configurations can be made using the options field, as demonstrated above. For instance, users can configure the type and amount of the database instance. The available instance types are aligned with the [database instance names on AWS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html). {% endhint %} After completing the configuration, the akinon.json file will resemble the following: ``` { "name": "Quickstart Project", "description": "Quickstart Project", "scripts": { "release": "", "build": "sh build.sh" }, "env": {}, "formation": { "web": { "min": 1, "max": "auto" } }, "runtime": "python:3.8-alpine", "addons": [ { "plan": "postgresql" } ] } ``` ## Using Environment Variables for Configuration When a database addon is added, the following environment variables become available to your app: * `DB_HOST` * `DB_PORT` * `DB_NAME` * `DB_USER` * `DB_PASSWORD` Update your `settings.py` to use these variables: ``` DATABASES = { "default": { "ENGINE": "django.db.backends.postgresql", "HOST": env("DB_HOST"), "USER": env("DB_USER"), "PASSWORD": env("DB_PASSWORD"), "NAME": env("DB_NAME"), "PORT": env("DB_PORT", cast=int), } } ``` To run the app locally, you’ll need to simulate these environment variables: **.env** ``` # postgres DB_NAME=quickstart DB_USER=postgres_user DB_PASSWORD='postgres_password' DB_HOST=127.0.0.1 DB_PORT=5432 ``` To enable the application to communicate with PostgreSQL, users must incorporate the **postgresql-dev** library into the build.sh file. Below is the modified version of the build.sh file: ``` set -euo pipefail apk add python3-dev postgresql-dev g++ jpeg-dev zlib-dev libffi-dev --no-cache pip install -U --force-reinstall pip pip install -r requirements.txt apk del g++ python3-dev ``` ## Automating of Database Migrations To ensure database migrations run automatically during deployment, add the migration command to the `release` script in `akinon.json`: Below is the addition to be made in the akinon.json file: ``` { //... , "scripts": { "release": "python manage.py migrate --noinput", "build": "sh build.sh" }, // ... } ``` ## Ensuring the Database Connection with Health-Check To control the database connection and ensure that the application is running smoothly, users can create a **healthcheck** page. This page will serve as a status indicator, providing information about the application's proper configuration and functionality. If everything is functioning well, the server will return an **HTTP 200 OK** status code. Otherwise, if there's an issue, it will handle the error and respond with an appropriate error status code (e.g., 500 Internal Server Error). Let's add a new view to the application that will respond to the **/healthz** path and implement the health-check functionality: **views.py** ``` import django from django.http import HttpResponse from django.views import View class HomeView(View): def get(self, request): return HttpResponse(content='Quickstart App Home Page', status=200) class HealthCheckView(View): def get(self, request): try: django.db.connection.ensure_connection() except Exception as exc: return HttpResponse(content='Database connection could not be established.', status=500) return HttpResponse(content='OK', status=200) ``` **urls.py** ``` from django.contrib import admin from django.urls import path from quickstart.views import HealthCheckView, HomeView urlpatterns = [ path('', HomeView.as_view(), name='home'), path('admin/', admin.site.urls), path('healthz/', HealthCheckView.as_view(), name='healthcheck') ] ``` Test the healthcheck page in the local environment:

Everything seems to be running smoothly! Let's try pausing the PostgreSQL service locally:

If the application is unable to connect to the database, the health check page will notify users of the issue. By defining the health check path in the `akinon.json` file, ACC can automatically and periodically verify the application's health once it's deployed. To enable this, simply add the `healthcheck` key under the `formation > web` section, specifying the path to the health check endpoint. ``` { //... "env": {}, "formation": { "web": { "min": 1, "max": "auto", "healthcheck": "/healthz/" } }, // ... } ``` {% hint style="info" %} For more detailed information, refer to the tutorial [here](/tutorials/acc/how-to-configure-your-acc-application-with-akinon.json-and-procfile#healthcheck). {% endhint %} To test the changes in the ACC environment, push the updates to your application’s repository and trigger a new version build. Once the build is complete, proceed with the deployment. After deployment, navigate to the health check endpoint. If everything is configured correctly, the page will confirm a successful database connection—indicating that your application is running smoothly.

# How to Configure Your ACC Application with akinon.json and Procfile To run your application on ACC, it must first be containerized. The approach for this will vary based on the programming language and framework you're using—searching for "dockerize $language $framework" is a good way to discover the recommended practices. ACC packages your application into a Docker container and deploys it on a Kubernetes cluster. To do this, it needs specific instructions on how to build and run your app. Instead of using a traditional Dockerfile, ACC relies on an app manifest composed of two files: `akinon.json` and a `Procfile`. ## akinon.json This file outlines the essential details about your application—what it is, how it should be built and executed, and any dependencies it requires to function correctly (such as a database or message broker). It must be placed at the root of your application's repository. Here’s a minimal example of an `akinon.json` file: ``` { "name": "mcapp-9000", "description": "My cool app", "scripts": { "build": "build.sh" }, "runtime": "python:3.10-slim", "formation": { "web": { "healthcheck": "/healthz" } }, "...": "..." } ``` Name and description are pretty self-explanatory, they're used to identify your app in the UI. Scripts are used to build & run your app in different stages of its lifecycle. Since they're executed inside the container, they can use any shell available in the container (sh, bash, xonsh, etc.). We'll explore other fields and their uses in the following sections. #### Converting a Dockerfile into a build script ACC abstracts `Dockerfile` into a script that is run while building the Docker container. It effectively combines all `RUN` statements into one. This is to prevent users from generating a massive Docker container, often due to creating too many layers by mistake. It's best to start from a Dockerfile and later convert it to an app manifest that ACC can understand. Take this minimal (though not optimized) Dockerfile as an example of a Python application served by Gunicorn server. ``` # Dockerfile FROM python:3.10-slim RUN apt-get update && apt-get install -y python-dev postgresql-dev jpeg-dev g++ COPY requirements.txt requirements.txt RUN pip install -r requirements.txt COPY . . CMD ["gunicorn", "app:app", "-b", "0.0.0.0:8000"] EXPOSE 8000 ``` We have a number of `RUN` commands in the Dockerfile. And an `CMD` command that runs starts process. To create a build script, we combine all `RUN` statements. Files inside the repo are copied to the Docker container, and the script is run at the root of the repo. ``` # build.sh #!/bin/bash set -euo pipefail apt-get update && apt-get install -y python-dev postgresql-dev jpeg-dev g++ pip install -r requirements.txt # remember to clean up unnecessary files to reduce container size # for example, g++ or python-dev is not used by the app, it can be uninstalled # this will reduce the container size significantly, # and speed up builds & deployments. apt-get remove -y python-dev g++ ``` {% hint style="info" %} The `build.sh` file must be executable. On Unix-based systems, you can make this file executable by running the `chmod +x build.sh` command. For Windows users who cannot use chmod, you can achieve the same result by using the `git update-index --chmod=+x build.sh` Git command. {% endhint %} Then this is specified in `akinon.json` under `$.scripts.build`, and the base image under `$.runtime`: ``` { "...": "...", "scripts": { "build": "build.sh" // runs `sh build.sh` at the repo root }, "runtime": "python:3.10-slim" // used as the base image for the Docker container } ``` This also means you can put your scripts under a subdirectory and point to it in `$.scripts.build`: ``` { "...": "...", "scripts": { "build": "./scripts/build.sh" } } ``` #### Release Script Release script is an **optional** script that is run just before deploying your app. This is usually used to run migrations. Keep in mind that this script can and will likely be run multiple times, so it **must** be idempotent, meaning it should expect some changes to be already made by previous runs. ``` { "...": "...", "scripts": { "build": "build.sh", "release": "release.sh" } } ``` It contents could potentially be: ``` # release.sh #!/bin/bash set -euo pipefail # only run migrations if the database is not already migrated. # this check is usually performed by the ORM you're using. is_migrated() { # ... if test $migrated -eq 0; then return 0 # yes else return 1 # no fi } is_migrated || migrate ``` {% hint style="info" %} The `release.sh` file must be executable. You can make this file executable by running the `chmod +x release.sh` command. {% endhint %} ## Formations and Procfile Formation defines how the app is deployed on a Kubernetes cluster and how many replicas it has or how many instances it can scale to. ``` { "...": "...", "formation": { "web": { "min": 2, // app is deployed with 2 replicas "max": "auto", // and scale up as needed "healthcheck": "/healthz" }, "beat": { "min": 1, // only a single instance is deployed "max": 1 }, "worker": { "min": 1, // only a single instance is deployed "max": "auto" // but can scale up as needed } } } ``` Keys of the formation are the names of the processes that are defined in Procfile. We expect to find this file at repo root. Procfile is a file that contains a list of processes that can be run inside the container. ``` # format: : web: gunicorn app:app -b 0.0.0.0:8008 worker: worker.py ``` This command will be used as `CMD` statement in the Dockerfile. For example, if you have a Django app, it is usually served by Gunicorn. But it also needs a worker process to run background tasks. So we define two processes, both of which will be deployed as **separate** containers. This means they **cannot share state** among each other without using a shared database or a broker like Redis. ### Healthcheck If the app is expected to be accessed from the internet, it must have a `web` process which listens to all interfaces `0.0.0.0` at port `8008`. And it must have a healthcheck endpoint. A healthcheck endpoint is a path used that responds to HTTP GET requests to confirm if the app is ready to receive traffic. It is like the following command that is run inside the container: ``` curl -XGET http://localhost:$PORT/healthz ``` After deployment, once the app starts returning HTTP 200 responses from this endpoint, it is assumed to be healthy and ready to serve traffic. This means, that if the app is **not ready** to serve traffic, such as, it cannot access the database or other upstream services & APIs it depends on, it **should not return HTTP 200 responses** from this endpoint. If it does, the traffic will be routed to the app, and it will most likely crash, and return HTTP 500 responses. ``` { "...": "...", "formation": { "web": { "...": "...", "healthcheck": "/healthz" }, "...": "..." } } ``` It is also possible to use health checks for processes other than `web`. In this case, the health check path will correspond to a file rather than an endpoint. This indicates that if the health check file exists, the deployment is assumed to be healthy. Conversely, if the file is absent, the deployment is assumed to be unhealthy. ``` { "...": "...", "formation": { "worker": { "...": "...", "healthcheck": "/tmp/healthz" }, "beat": { "...": "...", "healthcheck": "/tmp/healthz" } "...": "..." } } ``` The following example demonstrates the process of creating a health check file with Celery: ``` from celery.signals import beat_init, worker_ready, worker_shutdown READINESS_FILE = Path('/tmp/healthz') @worker_ready.connect def worker_ready(**_): READINESS_FILE.touch() @worker_shutdown.connect def worker_shutdown(**_): READINESS_FILE.unlink(missing_ok=True) @beat_init.connect def beat_ready(**_): READINESS_FILE.touch() ``` ## Addons With all this information, the app is now ready for deployment. However, most applications require a database to store state, which is provided through addons. It's an array of objects, each of which defines an addon (with optional configuration). ``` { "...": "...", "addons": [ { "plan": "postgresql", // "options": { // "instance_type": "db.r5.large", // "instance_count": 1 // } } ] } ``` Each addon causes a number of environment variables to be passed to the container. And the app needs to **read these environment variables** to configure itself. You can define a type of addon multiple times, but they must have different roles defined in `as` field. ``` { "...": "...", "addons": [ { "plan": "redis", "as": "cache" }, { "plan": "redis", "as": "broker" } ] } ``` This will cause environment variables to have different prefixes. In this case, the app will have two different Redis instances, and their details will be stored in `CACHE_*` and `BROKER_*` environment variables. ### Postgresql Addon This addon provides a Postgresql database. It can be defined as follows: ``` { "plan": "postgresql" // "as": "db", // optional, set to "db" by default // "options": { // "instance_type": "db.r5.large", // "instance_count": 1 // } } ``` This will pass the following environment variables to the container: * `DB_HOST`: the hostname of the database * `DB_PORT`: the port to connect to the host * `DB_NAME`: the name of the database * `DB_USER`: the username to connect to the database * `DB_PASSWORD`: the password of the user ### Redis Addon This addon provides a Redis instance to the app. It can be defined as follows: ``` { "plan": "redis" // "as": "cache", // optional, set as cache by default // "options": { // "instance_type": "cache.r4.large", // "instance_count": 1 // } } ``` This will pass the following environment variables to the container: * `CACHE_HOST`: the hostname of the Redis instance * `CACHE_PORT`: the port to connect to the host * `CACHE_DATABASE_INDEX`: the index of the database to use Combining these, you'll need to prepare a Redis DSN as follows: ``` redis://$CACHE_HOST:$CACHE_PORT/$CACHE_DATABASE_INDEX ``` ### Sentry Addon This addon provides a Sentry DSN to send error logs to. It can be defined as follows: ``` { "plan": "sentry" } ``` This will pass the following environment variables to the container: * `SENTRY_DSN`: the DSN of the Sentry instance ### Mail Addon This addon provides SMTP details to allow the app to send emails. It's included with every app by default, so it doesn't need to be defined in akinon.json. This will pass the following environment variables to the container: * `EMAIL_HOST`: the hostname of the SMTP server * `EMAIL_PORT`: the port to connect to the host * `EMAIL_HOST_USER`: the username to connect to the SMTP server * `EMAIL_HOST_PASSWORD`: the password of the user * `EMAIL_USE_TLS`: whether to use TLS or not ### CDN Addon This addon provides a CDN instance to the app. It can be defined as follows: ``` { "plan": "cdn", // "scope": "project" // optional set as cache by default } ``` This will pass the following environment variables to the container: * `CDN_DOMAIN`: the domain of the CDN server * `S3_BUCKET_NAME`: the name of the AWS S3 bucket * `S3_REGION_NAME`: the name of the AWS S3 region name * `AWS_ACCESS_KEY_ID`: the access key id of the AWS account * `S3_SIGNATURE_VERSION`: the signature version of the AWS S3 * `AWS_SECRET_ACCESS_KEY`: the secret access key of the AWS account #### Static CDN Addon This addon provides a Static CDN instance to the app. It can be defined as follows: ``` { "plan": "static_cdn" } ``` This will pass the following environment variables to the container: * `BASE_STATIC_URL`: the url of the Static CDN server ### Elasticsearch Addon This addon provides an Elasticsearch instance to the app. It can be defined as follows: ``` { "plan": "elasticsearch", // "options": { // "version": "5.5", // "instance_type": "t2.medium.elasticsearch", // "instance_count": 1 // } } ``` This will pass the following environment variables to the container: * `ES_HOST`: the hostname of the Elasticsearch server * `ES_PORT`: the port to connect to the host ## Adding Required Environment Variables in akinon.json When developing and deploying an extension in ACC, there might be cases where specific environment variables must be set before the extension can be added to a project. For example, sensitive configurations like `SECRET_KEY` or critical settings like `API_URL` can be defined as prerequisites for installation. This requirement can be enforced by defining the `env` field in the `akinon.json` file. The example below includes two required environment variables: * `SECRET_KEY`: A sensitive key with specific length constraints. * `API_URL`: The base URL needed for API communication. ``` { "name": "example-extension", "description": "An example ACC extension", "runtime": "python:3.10-slim", "scripts": { "build": "build.sh" }, "env": { "SECRET_KEY": { "type": "text", "required": true, "minlength": 12, "maxlength": 128, "description": "Secret Key" }, "API_URL": { "type": "text", "required": true, "description": "Base URL for the API" } } } ``` When a user attempts to deploy this extension, ACC validates the `env` section in the `akinon.json` file. If the required environment variables (SECRET\_KEY or API\_URL) are not provided or do not meet the specified criteria (e.g., type or length), the deployment process will be interrupted, prompting the user to input the required information. # How to Create, Manage, Build, and Deploy Applications in ACC ## My Applications Users can easily access application details or add a new application by clicking on **My Applications** in the left-side menu. This action directs users to a screen displaying all partner-viewed applications, providing quick access to relevant information and the ability to add new applications as needed.

The list screen provides users with a view of application summary information. Additionally, users can use the search functionality to easily locate specific applications based on their preferences. Furthermore, the **Edit** column grants users to make changes to specific fields such as description, logo, or images within the application.

## Creating Application To add an application to a project, the application must first be created. To initiate this process, click on the **+ New Application** button, which will then display the **Create New Application** page.

In order to create a new application, fill in essential fields such as the application's name, slug, type, description, logo, and images. To proceed, provide both the name and the slug for the application. Then, select the suitable application type from the automatically displayed options. Do not forget to add a description, logo, and images to complete the application setup.

The application logo will be visible across all instances where the application is used. To enhance the application's presentation, users are required to include a minimum of 4 product images. They also have the option to add up to 5 images, all of which will be showcased in the application's detail on the App Store. Once all necessary details are provided, click the **Apply** button to create and add the application to the application list. With this step, the application setup is complete, and it will be ready for building and deploying.

{% hint style="info" %} In order to view and manage an application, users must own the application. **The My Applications** page will only display applications created within the user’s account in the ACC, where the user has been added as a member. However, access to applications from other accounts can be granted through authorization. {% endhint %} All users who have the rights to create projects and add applications within their own account can also add applications. When clicking on an application name from the application list, users will be directed to the application detail page. Here, they can access the application details, including the projects in which it has been added, the versions built, and the reports for each version. The management of application builds and deployments to projects is handled within this screen.

In the **Application Detail** section, users can access information about the application, which includes details such as the application access setting, application type, slug, and more. {% hint style="info" %} Regarding the **Application Access** option, it grants users the ability to determine whether the application should be set as private or public. Private applications are accessible for addition in projects within the ACC account where the application was created. In contrast, public applications can be accessed by users from any account, allowing them to add the application to their own projects. These public applications, created in other accounts, will be visible in the App Store, alongside applications owned by individual users. {% endhint %} Applications created as the **Project Zero** application type cannot be designated as public applications. They are used as private applications.

## Building Application In the **Versions** section of the application detail page, users can build different versions of their application. This section presents a list of the application's entire version history, allowing users to access error logs and quality reports. Each version listed in this section is associated with a specific tag that the developer used during the application's build process. Furthermore, developers can use different tags for each project. To initiate the application build process, click the **Build** button. A pop-up window will appear, provide a version tag and notes detailing the edits made in this particular version. Once all necessary information is entered, clicking the **Build** button will commence the application build process.

In the **Versions** section of the application detail page, users can keep track of the build status. If a build fails, they can view the error logs by clicking on the error icon, which provides detailed information about the encountered issues. The **Status** column displays either **Completed** or **Failed** to indicate whether the application is ready for deployment with the specified tag. After successful application builds, users have the option to install these versions into their projects before proceeding with deployment. For a step-by-step guide on the installation process, please refer to the **Tutorials > Add Application** via App Store.

A perfectly working version can be set as a stable version under the **Stable** column. It is crucial to select a stable version as it will be the first version deployed when installed in projects.

Within the version list, users can access quality reports for successfully completed application versions through the **Reports** column. These reports are generated as part of CI/CD pipelines in ACC, providing essential metrics such as code coverage, complexity, duplication, and adherence to coding standards. To initiate the report generation process for a specific version, click the **Create Report** button. Once the process is successfully completed, the generated report will be displayed in the **Reports** table. However, if any issues arise during the generation, users can retry generating the report for the same version. The details of the report can be thoroughly examined within the **Reports** table. Under the **Quality Gate** column, the statuses “Passed” and “Failed” indicate whether the version meets the required quality standards or not. Additionally, users can download the report directly from the download icon.

## Deploying Application The **Installed Projects** section displays information about the projects in which the application is being used, along with the corresponding tags. Users can easily locate specific projects or application versions using the search bars. Furthermore, applications can be deployed in multiple projects. To achieve this, users only need to select the desired projects, then click the **Deploy Selected Projects** button. In the pop-up window, provide the version tag information and then click the **Deploy** button to initiate the deployment process.

The deployment status of the version for each associated project is visible in the table. Users can access the deployment history page and view deployment details, including any error logs, if they exist, by clicking on the project's name.

In addition, users can easily locate their application listed in the **Applications** table by navigating to the relevant project's detail page through the **Projects** menu. Here, they can check the deployment status of the application within that specific project. To access detailed information about the application, users can click on the application's name in the table. # How to Install Applications from the App Store in ACC ## App Store The App Store serves as a digital showcase, enriching the projects of ACC users with a diverse range of applications. It provides a secure and standardized experience, automating the installation of applications within projects. Selecting the **App Store** from the left-side menu takes users to the **Application Catalog**, where the process of installing applications into a project starts. This procedure comprises four steps, with the initial step being the selection of an App, followed by choosing a project and service, configuring application settings, and proceeding with the installation.

{% stepper %} {% step %} Application Catalog page displays both public and private applications. Users can conveniently search and filter applications based on criteria such as "Application Name," "Application Provider," and "Category." The Application provider refers to the account under which the application was created, while category refers to the type of application.

{% endstep %} {% step %} Users can filter the list to display only their own applications created in their account by selecting the **Show only my applications** checkbox. Otherwise, public applications from other accounts will also appear in the list.

{% endstep %} {% step %} Click on an application card from the list to move on to the next step. {% endstep %} {% step %} After selecting an application, users will be directed to its launch page. Here, users can select the project in which they intend to use the application. {% endstep %} {% step %} If the application is related to another app, users will dynamically find a dropdown menu for selecting the related app alongside the project selection.

{% endstep %} {% step %} The application's launch page showcases images added during its creation process and provides information about the application, including an overview, technical specifications, release notes, and support details. The “Release Notes” section highlights recent changes made in the latest application version.

{% endstep %} {% step %} Click the **Select Project** dropdown to choose a project for application installation. This dropdown displays all projects within the user's account. {% endstep %} {% step %} After selecting a project, click the **Configure Application Values** button to proceed to the next step.

{% endstep %} {% step %} Application Values page allows users to enter specific application values. These values are typically defined in the "akinon.json" file by the application owner when migrating the application to the platform. All these values will be dynamically displayed on the page based on their defined conditions. While there may not always be application values to enter, if any are applicable, all stakeholders looking to install the application within their projects must provide these values. These values can be either mandatory or optional, depending on the application's requirements. {% endstep %} {% step %} Click the **Save and Continue** button to move on to the installation step.

{% endstep %} {% step %} This page provides a summary of the actions taken in the previous steps. If needed, users can revisit the relevant tabs for any adjustments. {% endstep %} {% step %} After confirming the accuracy of the information, click the **Install** button to start the application deployment process.

{% endstep %} {% step %} Once the installation is complete, users will receive a confirmation message. To access the details of the project where the application has been installed, click the **View Project** button.

{% endstep %} {% step %} Note that deployment methods may vary. Some applications auto-deploy, while others may require the application owner to initiate deployment.

{% endstep %} {% endstepper %} # How to Add and Manage Domains in ACC Partners can add services and applications to projects created on the ACC platform, and the system generates a default URL for those services and applications. This URL information is available on the service and application detail pages. When a B2C website, such as Project Zero, goes live, it is accessible using the domain name purchased from the Domains menu on the platform instead of the default URL created by the system. ## Access and Navigate Domain Menu On the ACC platform, navigate to the **Domain** tab on the platform's left side menu.

The terms **Hosting** and **Domain** can often come across in this menu. To distinguish between **Hosting** and **Domain**, the domain name is a website's physical address, while web hosting is a service for hosting content. Domain names are digital shortcuts that users may use to access the website and are stored in a central database. Hosting is referred to as a server since it displays user's website to visitors. When user type a URL ([www.akinon.com](http://www.akinon.com/)) into the browser, a request is sent to the server where the website is hosted. The files are uploaded to the user's device through the internet by this server. Thus, the website is displayed on the user's device. In a larger sense, the Domain Name represents website's physical address. Domains serve to direct visitors to the server. ## Add a New Domain To add a new domain to the ACC platform, three steps need to be followed. ### 1. Domains The list of all previously added domains is displayed in the first step of the new domain adding flow. This page contains filtering options as well as a list of existing domains. User can select a domain from the list or add a new one by clicking the **+ New Domain** button.

When the **+ New Domain** button is clicked, a pop-up window appears in which the domain's basic information such as the **Hostname** and **Managed by**. **Client** should be selected for externally verified domain names on the client side, and **Akinon** should be selected for domain names to be managed by Akinon. After setting these two parameters, click the **Apply** button to save the settings. The newly registered domain is saved in the domain list, and the system notifies the user that the domain has been successfully added. The domain then awaits a certificate to be added as the following step.

Find the newly added domain in the list and click on hostname for adding the certificates. By clicking the delete icon next to the hostname, domains that do not have a certificate or those users want to remove from the domain list may also be removed. **Note:** To move on to the next **Certificate** step, a domain needs to be selected from the domain list. If the certificate icon in the navigation menu is clicked to proceed to the next step, the warning *'Please select a domain name from the Domains list to add a certificate'* is received.

### 2. Certificate After selecting a domain from the list, proceed to the **Certificate** step. The hostname, certificate details, and who manages the domain are all provided on this page. The **Client** and **Akinon** options of the **Managed by** parameter represent ownership of the domain. For certificates that are externally verified and managed by the partner, the **Client** option is selected. If **Akinon** option is selected, certificate ownership is managed through Akinon.

If user need to add a new certificate, click the **+New Certificate** button, type the FQDN in the pop-up window and then click the Apply button.

When a FQDN is specified for the certificate, it is automatically displayed in the **Certificates** section, and newly added certificates can be clicked for more details. The process is followed based on who holds the domain name management ownership. **Domains managed by Akinon:** * The partner adds the NS records displayed in the hostname field to the domain's environment so that the domain is managed by Akinon. This data is displayed in the hostname field. NS records are only displayed if Akinon is selected as the owner of the domain management. * The A record of domains to be managed by Akinon is automatically assigned by Akinon during migration. A record is not available on the platform. * The certificate's CNAME record for the domains is listed in the **Certificate Records** list, and the certificate is verified automatically. When the status of the certificate is **Success**, the certificate is eligible for the **Certificate Attachment** step. * Once the certificate verification is complete, the status of the certificate changes to **Success**. For the verified certificates, the attachment button appears and the certificate is able to attach to a project and application by clicking the **Attach Certificate** button. **Domains managed by Client:** * The CNAME record of the certificate created for the domain is listed on the **Certificate Records** and the record for the certificate to be managed by client is sent to the partner. * After the partner adds this record to the environment where the domain is hosted, the certificate verification process is complete. * Once the certificate verification is complete, the status of the certificate changes to **Success**. For the verified certificates, the attachment button appears and the certificate is able to attach to a project and application by clicking the **Attach Certificate** button.

{% hint style="info" %} To move on to the next **Certificate Attachment** step, the adding certificate step needs to be completed. If the certificate attachment icon in the navigation menu is clicked to proceed to the next step, the warning *'In order to attach the certificate to a project, after your certificate is approved, you can proceed to this step by clicking the Attach Certificate button for the relevant certificate.'* is received.

{% endhint %} ### 3. Certificate Attachment By selecting a project and application in the **Certificate Attachment** step, the certificate is attached to this project and application. The **Select Application** parameter is a dependent combo box; in order for the available options, the project needs to be selected first. Click the **Save and Continue** button after selecting the project and application.

{% hint style="info" %} If a different certificate is added to the same project and application, the previous certificate remains valid. {% endhint %} After the certificate is attached to a project and application, the domain records can be viewed and the certificate attachment field is disabled.

Partner should add the record in the **Domain Records** list to the environment where the domain is hosted. This process is automatically done for the domains managed by Akinon. Following the addition of domain records, application traffic is routed to ACC servers. Users have the option to proceed to the **Certificate Attachment** step for certificates that are already attached to a project and its application. They can do this by clicking on the **Domain Records** button located in the certificate detail field on the **Certificate** page. By doing so, users will be able to view the related project and project application in the dropdown menus, along with the associated domain records.

## Email Domain Verification Email domains serve as a means to confirm domain ownership for email dispatch. Failure to complete this verification can result in emails being flagged as spam. “Email Domain Verification" should be completed for emails intended for delivery to the brands' end users through Amazon Simple Email Service (SES). To access the "Email Domain Verification" page, go to the "Domains" section in the left-side menu. From there, users can view, search, and delete added email domains, along with their statuses, using the delete icon.

To add a new email domain, click **+ New Email Verification** in the upper-right corner.

Upon clicking, users will be directed to the “Create Email Domain Verification” form, where they will encounter fields for “Domain” and “MAIL FROM Subdomain”.

“Domain“ field is mandatory and it is used for the domain where the emails will be sent from. If you define a custom “MAIL FROM Subdomain”, it will result in Amazon SES labeling messages as originating from your domain rather than a subdomain of amazon.com. Click on **Apply**, and the email domain will be added to the list.

Email DNS records can now be accessed on the “Email Domain Verification Detail” page. To view them, simply click on the email domain name in the list.

In the “DNS Record” table, users will see the “DKIM” and “mail\_from\_domain” records. These records statuses can be viewed on the field under the domain name. DKIM (DomainKeys Identified Mail) is a cryptographic protocol used for signing and verifying emails, ensuring their legitimacy. “MAIL FROM” is an integral part of the SMTP protocol, serving to manage bounce messages and other errors from recipient mail servers, while also facilitating DMARC authentication compliance. These verification processes collectively enhance the credibility of emails originating from a domain. {% hint style="info" %} If the domain is managed by the client, the partner or the client side must add these DNS records to the environment where the domain is managed. This process is automatically done for the domains managed by Akinon. {% endhint %} Users can conveniently acquire a **.zone** document containing DNS records, simplifying the process of entering these records where the domain is managed. This can be done by clicking the icon located in the top left corner of the “DNS Record” table.

Once the necessary DNS records are created and verified, the client will be able to send emails from any address under that domain. Statuses indicate whether a certain claim is verified by our systems through the DNS records. This procedure typically concludes within 20 minutes, although the system perseveres for 72 hours. Afterward, users may need to restart the process and generate a new record. # How to Generate and Add Public Keys in ACC SSH (Secure Shell) serves as a secure means for computers to communicate with each other. It establishes a protected connection over the internet, encrypting the data exchanged between your computer and another computer, ensuring its confidentiality. In the realm of public-key cryptography, data encryption and decryption are facilitated using a key pair. One of the keys, known as the public key, is shared with others to encrypt data. The other key, the private key, is kept confidential and solely utilized by the owner to decrypt the data. This cryptographic approach ensures secure and private communication between parties involved. ## Generate Public Key To generate a new RSA key pair, follow these steps: {% stepper %} {% step %} Open a terminal or command prompt and run the following command: `ssh-keygen -o -t rsa -C "[your@email.com](mailto:your@email.com)"` {% hint style="info" %} In case the command gives errors, delete the‘**-o**’ option and try running it again. {% endhint %} {% endstep %} {% step %} During the installation process, the location where the key is to be inserted needs to be selected. The default value can be accepted by pressing the **Enter** key. **Enter file in which to save the key (/Users/username/.ssh/id\_rsa):** {% endstep %} {% step %} In the next step, users have the option to assign a password to their key. If they prefer not to set a password, they can press **Enter** key to skip this step. **Enter passphrase (empty for no passphrase):** **Enter same passphrase again:** {% endstep %} {% step %} After configuring the key, the subsequent screen will appear: * Identification has been saved in `/Users/username/.ssh/id_rsa.` * Public key has been saved in `/Users/username/.ssh/id_rsa.pub.` **The key fingerprint is:** `01:0f:f4:3b:ca:85:d6:17:a1:7d:f0:68:9d:f0:a2:db your@email.com` **The key's randomart image is:** ``` +--[ RSA 2048]----+ | | | | | . E + | | . o = . | | . S = o | | o.O . o | | o .+ . | | . o+.. | | .+=o | +-----------------+ ``` {% endstep %} {% step %} To view the public key, run the following command: `$ cat ~/.ssh/id_rsa.pub` {% endstep %} {% step %} Copy the output of the command. The output should look like this: ``` ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA879BJGYlPTLIuc9/R5MYiN4yc/YiCLcdBpSdzgK9Dt0Bkfe3rSz5cPm4wmehdE7GkVFXrBJ2YHqPLuM1yx1AUxIebpwlIl9f/aUHOts9eVnVh4NztPy0iSU/Sv0b2ODQQvcy2vYcasdasdxJjAgfWsO3W4iGEe6QwBpVomcME8IU35v5VbylM9ORQa6wvZMVrPECBvwItTY8cPWH3MGZiK/74eHbSLKA4PY3gM4GHI450Nie16yggEg2aTQfWA1rry9JYWEoHS9pJ1dnLqZU3k/8OWgqJrilwSoC5rGjgp93iu0H8T6+mEHGRQe84Nk1y5lESSWIbn6P636Bl3uQ== your@email.com ``` {% endstep %} {% endstepper %} ## Add Public Key To modify the code commit repository associated with the application in the Akinon ecosystem, users need to add a public key. The responsibility of overseeing this process lies with the developer. It is important to note that up to five public keys can be added for enhanced security and access control. To add a public key to the ACC account, log in to the account and navigate to the **Settings** section from the left-side menu. Then, click on **Public Keys** to manage and configure the public key settings.

To add a new public key, click on the **+New Public Key** button.

Enter a label for the public key in the **Label** field, and paste the generated SSH Key into the **Public Key** field. Afterward, click the **Apply** button to successfully add the public key to the account.

The **Public Keys** list will display the public key that users have added. If they wish to remove a public key, they can click on the delete icon next to the respective key.

# How to Monitor Application Resources in ACC The ACC Monitoring enables the observation of resource consumption behaviors of applications tied to projects and allows monitoring of applications based on these behaviors for optimization. On this page, all applications related to projects on the respective account can be tracked according to specific metrics. To access the Monitoring page, log in to the ACC application, follow the sidebar menu and click on the **Monitoring** tab. All users with **Monitoring** permissions in the associated role can access this page.

Upon the initial login to the page, the latest project created on the account where the application login is made, along with the data of an application (project app) linked to this project from the past hour, is displayed. To access the data of another application, the project and the application itself must be selected through the filters provided above.

{% hint style="info" %} ACC users can only view projects created within the account they have logged into. {% endhint %} On the right side of the project and application filters, users can select the time interval option to determine the time range for which the data will be displayed. Among the options are time intervals for the last 1, 3, 12 hours, and 1 day. Additionally, users have the flexibility to set a custom time interval according to their preferences.

{% hint style="info" %} The data displayed on this page is presented with a maximum range of 7 days. {% endhint %} The viewing options can be customized using the **Settings** icon located to the left of the time interval options. The **Refresh** option determines how often the data in the graphics on the page will be automatically refreshed. When the page is initially opened, the refresh interval comes as default turned off; if no time interval is selected, the data will not be updated automatically. When a custom time interval is selected, the automatic refresh is not performed. In the **Settings** section, in addition to the refresh option, there is another option that determines the time interval for retrieving data. With the **Change Period** option, the period of the data displayed at intervals of 1, 10, 30 minutes, or 1 hour can be adjusted.

In accordance with the selections made for viewing application data, access to relevant graphs will be provided on the page. Initially, the **Application Pod Count** graph for the chosen application is displayed. This graph illustrates the variation in the number of pods in which the selected application runs during the specified time interval. This graph also specifies the types of pods the application runs, and the changes in the number of pods for each pod type are displayed individually. Hovering over the points on the line graphs reveals tooltips, providing time information for each data point and displaying the pod counts for each pod type at the respective time.

{% hint style="info" %} Apart from automatic refreshing, manual refreshing for all the graphs on the page can be performed using the refresh icon located in the top right corner of each graph. {% endhint %} Below the Application Pod Count graph, there is a list of pods in which the application runs. This list includes pod information, pod status, and CPU & Memory usage data for the listed pods.

By clicking on any pod in the pod list, users can access container-based CPU & Memory usage information for that specific pod. Below this list, container-based usage graphs for the pod at the top of the list, which is listed for the selected application, are opened by default.

For the CPU & Memory usage graphs of the selected pod, users can change the container information from the fields next to the graph's name. Tooltips on the graphs display date and time information and usage, request, and limit data for each data point at the respective time.

# How to Manage Users and Roles in ACC In ACC, there is an account-based structure. For instance, partners request separate accounts to oversee their projects and applications independently. Projects and applications within each specific account are restricted to viewing and management solely within that account. Each account establishes its own user roles and defines its users accordingly. ## Users When an account is created in ACC, a user is also created on the platform with the email address provided as the account owner and a password creation email is sent. This user is the initial user with all permissions, and new users can only be added through this user. Similarly, users created within an account are specific to that account, and they can only view the projects and applications within that account using the email address they were added with. A user can be added to multiple accounts using the same email address. When a user with access to more than one account logs in to ACC, they can switch between their accounts using the account switcher in the top right corner of the page, without needing to log out and log back in. When account owners log in to ACC, they can find their personal user on the "Users" page in the **Settings** section. The first user is automatically a "Manager" with full account permissions. Role details will be explained later in this document.

On the “Users” page, account users have the ability to view and search a comprehensive list of all users within their account. They can also edit existing user profiles or generate new user accounts. It's important to note that user permissions and visible pages are determined by their assigned roles. To create a new user, simply click the **+New User** button.

This will direct users to the user creation page.

All fields on this page must be filled. If a user with the provided email address already exists in the system, the email, name, and surname fields will be populated automatically. For this example, we will choose the "Manager" role as it is the only role currently available within the account. Additionally, this role is automatically created with full permissions for the initial user. Upon clicking the **Apply** button, a new user will be added to the user list. If no existing user is associated with the provided email address, a password creation email will be sent to the user. Otherwise, the user will receive a notification informing them that they have been added to the new account.

Clicking the edit icon in the user list allows users to access the “Edit User” page.

Here, users with appropriate permissions can edit all user information, with the exception of their email address. To deactivate a user, use the toggle switch on the form, which will change the user's status to "passive." Please be aware that this action is irreversible and reactivation is not possible. However, the user can be re-added to the account by creating a new user with the same email address.

Additionally, by hovering over the profile icon in the top right corner of any page, users can access a dropdown menu that displays their associated accounts, with the active account indicated by a checkmark. From this menu, users can switch between accounts, navigate to their profile page using the **Edit Profile** button, adjust language settings, and log out.

The "Profile" page allows for the modification of name information, addition of a profile avatar, and adjustments to the password.

## Roles As mentioned earlier, ACC associates users with their assigned roles, which determine their permissions within the account. The "Manager" role is automatically given to the first user, while users with appropriate permissions, including initial users, can view and edit roles or create new ones on the "Roles" page in the **Settings** section of the left-side menu.

To add a new role, simply click on the **+ New Role** button and this will direct users to the “Create Role” page.

In the “Add Authority Group” field, it is required to specify a role name, and users may also provide a role description.

In the “Select Authorizations to Add” field, users will find a list of permissions that can be included in the role. The “Added Authorizations” field lists the permissions already included in the role. When users click the **+** icon next to a permission type title in the “Select Authorizations to Add” field to add a new permission, they will be presented with subcategories and the option to **Add All Permissions** under that permission. The **Add All** option on the right corner of the main field can be used to include all permission types, along with their respective subcategories, within the role.

Selecting **Add All Permissions** will add all subcategories under that permission into the role. Alternatively, users can individually select the ones they desire by clicking the **+** icon next to the subcategories. For instance, users can opt to include only **List** and **Create** permissions for the **Email** permission type, while selecting all permissions for the **Project App Email** permission type.

This action will add the chosen permissions to the “Added Authorizations” field. To remove individual permissions, users can simply click the **-** icon. Alternatively, all permissions in the role can be removed by selecting **Remove All**, or permissions specific to a permission type can be removed by clicking the **Remove All Permissions** button beneath that permission type. This will relocate the removed permissions back to the “Select Authorizations to Add” field.

To complete the role creation process, just click the **Save Settings** button, and the role will be added to the list of roles. Users can further modify the role's name, description, and assigned permissions by clicking the edit icon within the list.

Edit the newly created user and update their role to the newly created one.

For instance, this user won't have the ability to modify user roles since we did not grant them “Users” permissions. If users are unable to view any page or perform an action on the platform, they should first ensure that they have the necessary permissions. # How to Integrate a BI Tool with Your Project in ACC This tutorial will walk you through the process of integrating a BI (Business Intelligence) tool with your project. BI tools enable you to analyze and visualize your data effectively, providing valuable insights for informed decision-making. ## Creating Google BigQuery Account Once you have set up the BI Tool within your project, the next step is to create a Google BigQuery account. Follow these steps: {% stepper %} {% step %} Click the **Go to console** button.

{% endstep %} {% step %} You'll be directed to the console setup. Follow the on-screen instructions.

{% endstep %} {% step %} On the next page, click the **Create Project** button.

{% endstep %} {% step %} Enter a project name and select the location for storing data. Then, click the **Create** button.

{% endstep %} {% step %} After project creation, you'll need to generate a project ID for your Google project. The **business-intelligence** field should match the project name on ACC. The location from which this project receives data is displayed in the breakdown menu.

{% endstep %} {% step %} Once the project is created, a `service-account.json` file is generated. This file is crucial for transferring data to Google BigQuery. Make sure to add the information from this file using the CLI. Below are the environment variables that must be added to the CLI: * `BI_TOOL_TOKEN`: Enter an alphanumeric value of 16 characters following the token in "Token x16." * `BIGQUERY_PROJECT_ID`: BigQuery project ID. * `BIGQUERY_DATASET`: The name of the dataset on BigQuery. * `GOOGLE_APPLICATION_CREDENTIALS`: JSON.

{% endstep %} {% step %} Click on the location where the data is received to display data on the page. This page dynamically shows data based on data transfer frequency. To customize incoming data for reports, you can write queries in the relevant field.

{% endstep %} {% endstepper %} ## ACC Setup Requirements {% stepper %} {% step %} Navigate to the App Store in the left-side menu and find the BI Tool application in the application catalog. Clicking on the application card will direct users to the project selection step.

{% endstep %} {% step %} Choose the project in which the BI Tool application will be installed, and then click on **Configure Application Values**. Clicking this button will direct users to the application value entry step.

{% endstep %} {% step %} At this stage, users should input the application values required for configuring the application. Enter the necessary values and click **Save and Continue**.

{% endstep %} {% step %} Once the application values have been entered, they will be reviewed in the final step, and users can initiate the application installation by clicking the **Install** button.

{% endstep %} {% step %} The BI Tool frontend and backend applications will be installed in the selected project. Users can monitor the deployment status of these applications on the project's detail page.

{% endstep %} {% endstepper %} # How to Create App Preview ## Creating a Preview App Preview lets you test a specific application version through a short-lived, isolated URL without deploying it to your live environment. To create a preview, go to **My Applications**, select the application, and open the **Versions** tab. Find the version you'd like to preview — it must have a **Completed** status — and click the preview icon in the Actions column.

A modal will open where you can select the **Project** and the **Project Application** you want to preview the version in.

Once you've made your selection, click **Create Preview**. {% hint style="info" %} After a preview is created, it may take 1–2 minutes for it to become viewable while the environment finishes deploying. Each preview stays live for **1 hour**. {% endhint %} {% hint style="info" %} This feature is currently enabled for select applications only. It will be gradually rolled out to other applications in the coming days. {% endhint %} ## Viewing the Preview Once the preview is deployed, you can find it in the **Previews** tab along with its status and a link to the live preview URL.

You can stop an active preview at any time from the same tab using the stop icon in the Actions column.

# How to Manage Build Variables Build variables let you pass environment-specific values into an application's build process — for example, a private key needed to authenticate with a private package repository. Once defined, these variables are injected as environment variables during each new build and can be accessed from within `build.sh`. {% stepper %} {% step %} Go to **My Applications** and click the settings icon on the row of the application you want to configure.

{% endstep %} {% step %} On the application's **Settings** page, click **Build Variables** to switch to the build variables tab.

{% endstep %} {% step %} Click **+New Build Variable** to open the form for adding a new variable.

{% endstep %} {% step %} Enter a **Name** and **Value** for the variable. Optionally check **Mark as secret** to hide the value after creation, then click **Save**.

{% hint style="info" %} Once a variable is marked as secret, its value can no longer be read after creation. {% endhint %} {% endstep %} {% step %} From the list, use the actions column to edit or delete an existing build variable.

{% endstep %} {% endstepper %} # Omnitron # Products & Catalogs # Product Pool In this page, the process of adding single or bulk products to product pool within Omnitron is explained. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Product Pool * Follow the Product and Catalogs sidebar and click the **Product Pool** page.

* On the Product Pool page, filters and products are listed. Within the filter panel, product types, include and exclude filters, or **.CSV** and **.XLS** files can be used to filter the product pool. * Users can apply filters in the product pool by clicking the

icon using the added attributes on **Products and Catalogs > Product Attributes** pages. * Below the filter panel, the products are listed, allowing for the selection of product display limits such as 20, 50, 100, and 250 per page. * To download products with or without filters applied, users can use the **XLS** button situated on the far right of the product list. Additionally, the product pool template can be obtained by clicking the button located at the bottom left corner of the product list. * In the product list, on the leftmost side, the **Select Action** dropdown contains options for "Export to Excel with Selected Items," "Export to CSV with Selected Items," and "Delete Selected Items". The desired action and products are selected, followed by clicking the **Apply** button.

## Step 3: Add Single Product to Product Pool * Click the **+New Product** button in the top right corner of the Product Pool page. Select the product type that you want to add to the product pool.

* Start by inputting the **Product Name, SKU, Base Code** for the product. * Choose the preferred attribute set for adding the product; this action will display all attributes linked with the chosen attribute set. * Input the **Listing Code** and **Status** of the product, then proceed by clicking on the **Save** button to complete the process.

## Step 4: Bulk Product Update in Product Pool * In the top-right corner of the screen, locate and click the **Bulk Product Update** button.

* Before proceeding, ensure your data aligns with the required format by downloading the product pool template: * Find the **Download Product Pool Template** button at the bottom left corner of the screen. * Click the button to download the template file to your computer.

* Ensure all mandatory fields are filled in correctly. Save your completed file in either `.CSV` or `.XLS` format. * Return to the platform and click on the **Bulk Product Update** button again. * Choose one of the following methods to upload your file: * **Drag and Drop:** Drag your file into the designated upload area. * **Click and Select:** Click on the designated area to open a file selector, then locate and select your file.

* After the process completes, review the updated products in the product pool to confirm the changes. # Attributes and Attribute Sets This tutorial provides step-by-step instructions on how to add product attribute sets and product attributes in Omnitron. ## Step 1: Access Omnitron * Access the Omnitron panel. * Enter your username and password, then click the **SIGN IN** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to the Product Attributes Page * Navigate to the **Product and Catalogs** section and click on the **Product Attributes** page.

* On the Product Attributes page, filters and attributes are listed. Static filters for filtering product attributes are displayed in the filter panel. * Below the filter panel, users can view product attributes and choose to display them in sets of 20, 50, 100, or 250 per page.

## Step 3: Add Product Attributes * Click the **+New Attribute** button in the top right corner of the Product Attributes page. Attributes are used to enrich product information for filtering and listing purposes. More details on creating attributes with the API can be found [here](https://apidocs.akinon.com/omnitron/integration/product/attribute#create-attribute).

### Add / Edit Attributes Form Inputs * **Attribute Code:** Enter the Attribute Code. * **Product Attribute Input Type:** Commonly used attribute types are **text**, **text\_area**, and **dropdown**. * **dropdown:** Select this type for creating filterable or listable products. Requires entering attribute values, e.g., color, size, season, brand, category, collar type. * **text:** Select this type for non-selectable attributes like product descriptions. The attribute value information is automatically linked to the product itself, manual input of the attribute value is not necessary. * **text\_area**: Select this type for editing product descriptions within the Omnitron interface. When **text\_area** is selected, the enriched text editor is displayed on the Omnitron product detail page. * **Mandatory Attribute:** After the product attribute is linked to the attribute set, decide whether the product attribute is mandatory or optional on the product detail page. * **Is Visible?:** Choose if this product attribute will appear on the site. * **Searchable:** Specify if the product attribute is searchable on the site. * **Is Filterable?:** Determine if the product attribute is filterable on the webshop. * **Variant Attribute:** Define this attribute as a variant of the product. * **Is Variant Listable?:** List this variant on the sales site by grouping it according to variant attribute values. * **Attribute Name:** Enter an attribute name visible to customers. * **ERP Code:** Enter the Attribute ERP Code. * **Pre Attribute:** Decide if the product attribute is a pre-attribute. * **Is Localizable?:** If Omnitron supports multiple languages, attributes are generated for the main language. To define attributes for other languages, select the relevant language from the Locales field in the upper right of the Omnitron interface.

## Step 4: Add Attribute Value Attribute values define selectable fields (for **dropdown** type). To add values in Omnitron: * Navigate to **Products and Catalogs** > **Product Attribute** in the left menu. * Select the relevant **dropdown** attribute from the attribute list. * Enter the values by clicking the **Add** button in the table at the bottom of the page.

### For API-Related Actions * Once the attribute for which a value will be defined with the API has been queried from Omnitron, the attribute value is generated together with the attribute ID. Details are available [here](https://apidocs.akinon.com/omnitron/integration/product/attribute-value#create-attribute-value). ### **Get & Search Attribute Value** * To create or update attribute values using the API, the attribute ID to which the value will be added must first be obtained. Detailed information on this process can be found [here](https://apidocs.akinon.com/omnitron/integration/product/attribute-value#search-attribute-value). ### **Update Attribute Value** * To update attribute value information, navigate to the **Products and Catalogs > Product Attribute** in the left menu. Select the relevant attribute with the **dropdown** type from the attribute list. Changes can be made by clicking the value line that requires updating. * To update the attribute value using the API, the attribute value ID to which the value will be added must first be obtained. After reaching the Attribute value ID, an update request should be sent to the `attribute_value` endpoint, specifying the desired changes in the respective fields. More details can be found [here](https://apidocs.akinon.com/omnitron/integration/product/attribute-value#update-attribute-value). ### Language Support Omnitron's default language is set during the installation process, typically to a language such as English when it's deployed on platforms like Commerce Cloud. However, if the website is intended to be launched in a language other than Omnitron's default, it's essential to input translations for the products in that specific language. If translation is not provided for the products, the default language of the product is displayed on the website. For instance, if the default language of Omnitron is English and the website is planned to be in German, it is imperative to input German translations for all products intended for sale on the German version of the site. Otherwise, the products will be displayed in English even though the website is set to German. {% hint style="info" %} The principle of uniqueness applies to both the `value` and the `attribute` when considered as a single attribute model. Since the `value` itself is unique within an `attribute`, it is not possible to create multiple records with the same `value`. {% endhint %} ## Step 5: Navigate to the Product Attribute Sets Page * In the **Products and Catalogs** section, click on the **Product Attribute Sets** page.

* Below the filter panel, the product attributes are listed, and you have the option to select the attribute display limit, with choices of 20, 50, 100, and 250 per page. * Furthermore, attribute sets are used for grouping attributes or products, determining how products are presented on the site, and configuring how grouped attributes are filtered on the site. This framework is used to define the attributes that a product will possess.

## Step 6: Create an Attribute Set * In Omnitron, navigate to **Products and Catalogs** > **Product Attribute Sets** from the left-hand menu. * Click the **+New Attribute Set** button in the top right corner of the Product Attribute Sets page. * Enter a name for **Attribute Set** and select the **Attribute Group Type**, then click **Save**.

* After creating an attribute set, a section will be displayed for showing all attributes. Add specific attributes to the set by clicking the **"+"** button. * In the "Selected Attributes" section, remove a selected attribute using the **"-"** button. * In the "Selected Attributes" section, edit product attributes by clicking the pencil icon.

### Assign Attributes to Attribute Set The usage of an attribute within the attribute set is defined in this process. For instance, if you need to apply the "color" attribute differently for carpets, clothing, and jewelry, you would use the attribute set. The specific usage of this attribute within the attribute set is defined through the following specifications. * **Required**: This attribute must be filled in the product within the Attribute set. * **Searchable**: Mark this attribute as searchable in products within the Attribute set. * **Filterable**: Mark this attribute as available for filters within the Attribute set. * **Variant**: Define this attribute as a variant of the product within the Attribute set. * **Variant Listing**: List this variant on the sales site by grouping it according to variant attribute values within the Attribute set. For example, the color variant can be listed for the clothing attribute set, while the size variant can be listed for the carpet attribute set. * **Visible**: Use for attributes used for back-office operations in Omnitron but not on the website. Examples; erp\_color\_code, erp\_sku, etc. * **Form Required**: Use for texts like name and notes on the product, e.g., jewelry, watches, wallets, flowers. * **Form Field Required**: Eliminate the obligation to enter texts like name and notes, allowing anonymous product orders.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FMg6Iw4PYTa6iJ25QEoSe%2Fimage.png?alt=media\&token=8960aaae-7e62-467c-87cb-43bbb9b9b775) # Attribute Values In Omnitron, attributes play a crucial role in defining product characteristics, enabling filtering in the storefront, and integrating with external systems like ERPs. However, there is a key limitation: a single attribute on a product cannot hold multiple values. This tutorial walks you through the recommended approach for handling such cases by using separate boolean attributes for each value. You'll learn how to create boolean attributes via the Omnitron interface or API, configure attribute mappings for ERP integrations, and ensure that these attributes are correctly reflected in product data and storefront filtering. Whether you're managing attributes manually or through an integrator, this guide provides the complete workflow to ensure accurate attribute configuration. ## Understand Attribute Value Limitation * In the current Omnitron structure, attributes on a product cannot have multiple values. * If it is desired for an attribute to have more than one value on a product, a separate boolean attribute must be created for each value. ## Create Boolean Attributes via Omnitron * Go to **Products and Catalogs > Product Attributes** page in Omnitron. * Click the **+ New Attribute** button to create a new attribute. * In the form that opens: * Set the **Product Attribute Input Type** field to `Boolean`. * If the attribute will be used for filtering in the shop, set the **Is Filterable?** field to `Yes`. * Set the **Pre Attribute** field to `No`. **Example:**

Instead of using the interface, a `POST` request can be sent to the following endpoint: ```bash {{omnitron_url}}/api/v1/attributes/ ``` **Example Body:** ```json { "key": "concern_oily", "data_type": "bool", "default_value": null, "is_required": false, "is_visible": false, "is_searchable": false, "is_filterable": true, "is_variant": false, "is_variant_listable": false, "name": "Oily", "is_form_required": false, "is_form_field_required": false, "erp_code": "concern_oily", "pre_attribute": false, "is_offer": false, "is_localizable": false } ``` ## If Attribute Value Will Be Sent from ERP #### **If the brand is using pending product:** **i. Create Pre Attributes** * Go to **Products and Catalogs > Product Attributes** in Omnitron. * Click **+ New Attribute** to create a new attribute. * In the opened form: * Match information with the original attribute. * Set **Pre Attribute** field to `Yes`. **Example:**

**ii. Map Pre Attributes** * Go to **Integration > Mapping** and click **+ New Rule Set**. * In the empty mapping row at the end of the page: * Select **Pre Attribute** in the **ERP Features** field. * Select the **Attribute** to be mapped in the **Attributes** field. * Select the **Pre Attribute** in the **Default Attribute** field. Instead of using the interface, a `POST` request can be sent to the following endpoint:

{{omnitron_url}}/api/v1/mappings/

**Example Body:** ```json { "mapping_type": "attribute_value", "value_dict": { "attributes__erp_concern_oily__isnull": false }, "default_value": {}, "default_attribute": "erp_concern_oily", "priority": 1, "mapping_key": "Oily", "create_all_kind": false } ``` #### **If the brand is using an Integrator:** **i. Update Product Flow in Integrator** * Add newly created attributes to the **Product Flow** under **Integration Flows** in Integrator. * If needed, update the script in the flow to modify data coming from ERP. **ii. Map ERP Values to Omnitron Attributes** * On the **Mapping** page of the flow: * Create mapping between ERP values and Omnitron attributes. *(If using pending product, use pre attributes.)* ## Add Attributes to Attribute Sets To reflect the newly added attribute on products, it must be added to the relevant attribute sets. * Go to **Products and Catalogs > Product Attribute Sets** in Omnitron. * Edit the attribute sets where the attribute will be used. * If attribute should not be used for filtering on certain products, set **Is Filterable?** to `No` in those attribute sets. ## Reflect Attribute Values on Products * **If the brand is using ERP:** * Add new attributes to the product in the ERP system. * **If ERP is not used:** * Enter attribute values via Omnitron. ## Enable Filtering by Attribute in the Shop In order for products to be filterable by the newly added attributes in the shop, the attribute name and value must be added to the URL using the following format:`attributes_=` **Example:** ``` /?attributes_concern_oily=True&attributes_concern_sensitive=True ``` {% hint style="warning" %} For this filter to work, the attribute's **Is Filterable?** field must be set to `Yes` (see the "Create Boolean Attributes via Omnitron" section above). If the attribute is not defined as filterable, adding the parameter to the URL will not produce any filtering result. {% endhint %} # Catalogs This tutorial provides step-by-step instructions on how to manage catalogs in Omnitron. ## Step 1: Access Omnitron * Access to the Omnitron panel. * Enter your username and password, then click the **SIGN IN** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to the Catalogs Page * Follow the Product and Catalogs sidebar and click the **Catalogs** page.

* On the **Catalogs** page, users will find information about the prices, stock, and sales channels linked to the existing catalogs. * To access the price and stock lists associated with a catalog, click on the **Edit Price List** and **Update Stock List** buttons.

## Step 3: Add a Catalog * To create a new catalog, click the **+New Catalog** button located in the top right corner of the Catalogs page. * Provide a Catalog Name and then click the **Save** button.

## Step 4: Navigate to the Product List on Catalogs * On the **Products and Catalogs > Catalogs** page, the filter panel, product pool, and the list of products added to the catalog are displayed. * Below the filter panel, users will find a list of products, and options are provided to display 20, 50, 100, or 250 products per page. * The **.xls** button, located on the far right of the product list, can be used to download products, either with or without applying filters. * If the **Showing Added Products** checkbox have been checked, only products that have not been added to the catalog will be listed in the product pool. * Within the product pool, the **Select Action** dropdown allows users to select either the **Add Selected Products** or **Add All Products** actions for the listed items. * In the product list, the **Select Action** dropdown provides the option to select either the **Remove All Selected Products** or **Remove All Products** actions for the listed items.

## Step 5: Navigate to the Price List on Catalogs * A price list for the related catalog can be selected by users, followed by clicking the **Save** button. * When users click the **Edit Price List** button, they will be directed to the **Products and Catalog > Price List > Add/Edit Price List** page. * On the Price List page, filters and products are listed. The filter panel provides options for filtering by product types, include and exclude filters, or filtering the product pool using **.CSV** and **.XLS** files. * Filters can be applied in the product pool by clicking the "filter" icon, using the added attributes found on the **Products and Catalogs > Product Attributes** pages. * Below the filter panel, a list of products is available, and users have the option to select from different product display limits, including 20, 50, 100, and 250 products per page. * In the product pool, the **Select Action** dropdown allows users to select either the **Add Selected Products** or **Exclude Selected Products** actions for the listed items.

## Step 6: Navigate to the Stock List on Catalogs * A stock list for the related catalog can be selected by users, followed by clicking the **Save** button. * When users click the **Edit Stock List** button, they will be directed to the **Products and Catalogs > Product Attributes** page. * On the Stock List page, filters and products are listed. The filter panel provides options for filtering by product types, include and exclude filters, or filtering the product pool using **.CSV** and **.XLS** files. * Filters can be applied in the product pool by clicking the "filter" icon, using the added attributes found on the **Products and Catalogs > Product Attributes** pages. * Below the filter panel, a list of products is available, and users have the option to select from different product display limits, including 20, 50, 100, and 250 products per page. * In the product pool, the **Select Action** dropdown allows users to select either the **Add Selected Products** or **Remove Selected Ones From Products** actions for the listed items.

## Step 7: Categories * On the Category Tree page, warnings, filters and products are listed. The filter panel provides options for filtering by product types, include and exclude filters, or using **.CSV** and **.XLS** files. * Users can expand the entire category tree and view all categories and their subcategories by clicking the **Expand All** button. Conversely, they can collapse the expanded category tree using the **Collapse All** button.

* Below the filter panel, a list of products is available, and users have the option to select from different product display limits, including 20, 50, 100, and 250 products per page. * Within the product list, there are two actions available: **Add Selected Product to Selected Categories** and **Add All Products**. Users first select the category or categories where they want to add the product(s). After selecting the action, users click the **Apply** button.

* Users can review the products added to a category by clicking on the icon within the category. In the opened panel, users can take actions such as **Remove Selected Product From Selected Categories** and **Remove All Products** on the Category Product List Page. * Users have the capability to adjust the order of categories using the up and down arrow icons. * If a category has no children or products, users have the option to delete the category.

* By using the editing icon, category-specific content can be saved and edited for the schema added to the category node on the **Sales Channels > Content Management > Model Schema Management** page. ## Step 8: Catalog Control * On the Catalog Control page, filters and products are listed. The filter panel provides options for filtering by product types, include and exclude filters, or using **.CSV** and **.XLS** files. * On this page, categories, product images, prices, and stock lists of the products in the catalog can be reviewed and managed by users. * Within the product list, actions such as **Adding Selected Products to the Catalog** and **Removing Selected Ones From the Catalog** can be taken by users.

## Step 9: Sorting * In the sorting page, users will find the category tree and collections panel on the left side.

* When a category or collection is selected, the **Settings > Sorting Algorithm** page will display the sorting algorithms that have been added, with the "Is Visible" option set to Yes. * From the list of available sorting algorithms, users can select one or more, click the **Add** button, and then save the operation using the **Save** button.

* On the flat sorting page, users can use the **Add Products to Sorting** action to add the products that require manual sorting.

* On the Preview and Edit page, products can be manually reordered by dragging and dropping. After arranging them, changes can be saved with the **Save Placement** button. If needed, users can use the **Remove All Products** button to delete all the products they want to manually sort. * The product view per row can be changed, ranging from 2 to 12 items. * If users want to sort out-of-stock products, the **Show Out of Stock** checkbox should be checked.

## Step 10: Sales Channels * The Sales Channels page lists the sales channels associated with the catalog.

## Step 11: Settings * On Settings page users can rename their catalog by clicking on the **Save** button.

# Price Lists In this page, the process of adding or editing price list within Omnitron is explained. ## Step 1: Access to Omnitron * Access the Omnitron panel. * Enter your username and password, then click the **SIGN IN** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Price List Page * Follow the Product and Catalogs sidebar and click the **Price List** page.

* On the **Price List** page, filter panel and the list of price lists are displayed.

## Step 3: Add a New Price List * To create a new price list, click the **+New Price List** button located in the top right corner of the Price List page.

* **Enter Price List Name:** Different price lists can assign various values to a product. For example, a product can be priced at X amount in Price List A, which is designated for Marketplace A, while it can be sold for Y amount in Price List B, designated for Marketplace B. Therefore, when creating or updating a product's price, it's essential to specify the relevant price list. * **Select ERP Connection:** Select between 'Yes' or 'No'. If 'Yes' is selected, price creation and updates can be performed through integration. If 'No' is selected, the price creation and update processes are managed using Excel through the Omnitron back-office. * When accessing the form initially in **Sales Channel Settings > Dynamic Settings**, the default currency set in the dynamic settings will be preselected. * Currencies listed in the currency drop-down menu will be those added to the Available Currencies key of **Sales Channel Settings > Dynamic Settings**. * After entering this information, click the **Save** button to create the new price list. For detailed information on creating a price list using an API, refer to [this page](https://apidocs.akinon.com/omnitron/integration/price/price-list). ## Step 4: Update Price Lists * To access the details of the listed price lists, click on it.

* On the Price List page, filters and products are listed. The filter panel provides options for filtering by product types, include and exclude filters, or filtering the product pool using **.CSV** and **.XLS** files.

* To ensure the accuracy of the parameters within the uploaded file, it is recommended to download the price list template from the bottom of the page first. Once product information is added to the template, bulk product updates can be performed by either dragging and dropping the file or clicking on the designated area and selecting the .xls or .csv file format. * By clicking the **+Update Price List** button, a file in the designated area can be uploaded by users. * After the file is uploaded, the update process will be completed with a progress bar for users to monitor.

* Once the process is complete, the page will be refreshed, and the updated values will be displayed. # Stock Lists In this page, adding or editing stock list processes within Omnitron is explained. ## Step 1: Access to Omnitron * Access the Omnitron panel. * Enter your username and password, then click the **SIGN IN** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Stock List Page * Follow the Product and Catalogs sidebar and click the **Stock List** page.

* On the **Stock List** page, filter panel and the list of stock lists are displayed.

## Step 3: Add a New Stock List * To create a new stock list, click the **+New Stock List** button located in the top right corner of the Stock List page.

* **Enter Stock List Name:** Different stock lists can assign various values to a product. For example, a product can be priced at X amount in Stock List A, which is designated for Marketplace A, while it can be sold for Y amount in Stock List B, designated for Marketplace B. Therefore, when creating or updating a product's stock, it's essential to specify the relevant stock list. * **Select ERP Connection:** Select between 'Yes' or 'No'. If 'Yes' is selected, stock creation and updates can be performed through integration. If 'No' is selected, the stock creation and update processes are managed using Excel through the Omnitron back-office. * After entering this information, click the **Save** button to create the new stock list. For detailed information on creating a stock list using an API, refer to [this page](https://apidocs.akinon.com/omnitron/integration/stock/stock-list). ## Step 4: Update Stock Lists * To access the details of the listed stock lists, click on it.

* On the Stock List page, filters and products are listed. The filter panel provides options for filtering by product types, include and exclude filters, or filtering the product pool using **.CSV** and **.XLS** files.

* To ensure the accuracy of the parameters within the uploaded file, it is recommended to download the stock list template from the bottom of the page first. Once product information is added to the template, bulk product updates can be performed by either dragging and dropping the file or clicking on the designated area and selecting the **.CSV** or **.XLS** file format. * By clicking the **+Update Stock List** button, a file in the designated area can be uploaded by users. * After the file is uploaded, the update process will be completed with a progress bar for users to monitor.

* Once the process is complete, the page will be refreshed, and the updated values will be displayed. # Collections This tutorial provides step-by-step instructions for managing collections in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Collections Page * Follow the Product and Catalogs sidebar and click the **Collections** page.

* On the **Collection** page, the filter panel and the list of existing collections are displayed. * New collection can be created by using the **+ New Collection.**

* In the collection list, operations such as **Make Selected Passive** and **Make Selected Active** can be performed by selecting the collections.

## Step 3: Add New Collection * Click the **+ New Collection** button in the top right corner of the Collection page.

* Fill in the required information: * **Collection Name**: Enter a name for the collection. * **Catalog**: Select the catalog where the collection should be placed. * **Collection Type**: Choose between a static or dynamic collection type. * **Status**: Select whether the collection will be active or passive. * Click the **Save** button to finalize the creation. ## Step 4: Manage Static Collection If a static collection has been created, the following steps are followed to add or remove products from this static collection. * Navigate to the **Product and Catalogs > Collections > Add/Edit Collection** page by clicking on the collection name.

* On this page, you will find filtering options, and just below them, the products are listed. On the left side of the products section, you will see the products that have not yet been assigned to the collection from the catalog's sellable products, while on the right side, you will find the products that have been assigned to the collection. * Advanced filtering options such as product type, inclusion/exclusion, or filtering with CSV/XLS files can be used to determine which products to perform actions on.

* To add the filtered products from the Product Pool to the collection, you can perform bulk additions by selecting the products and using the **Add Selected Products** or **Add All Products** actions. Alternatively, you can also use the green **"+"** button next to each product to add them individually to the collection.

* To remove the filtered products from the collection, you can perform bulk removal by selecting the products and using the **Delete Selected Items** or **Remove All Products** actions. Alternatively, you can also use the red **"−"** button next to each product to remove them individually from the collection.

## Step 5: Manage Dynamic Collection If a dynamic collection has been created, the following steps are followed to add or remove products dynamically from this static collection. * Navigate to the **Product and Catalogs > Collections > Add/Edit Collection** page by clicking on the collection name. * Specify the collection's end date as needed.

* Advanced filtering options such as product type or inclusion/exclusion can be used to determine which products to add or remove from the collection. * After determining the products that will be included in, click the **Save Collection Settings** button to apply your dynamic collection settings.

# Sorting How to sort your products, tab by tab The **Products and Catalogs > Catalogs > \[Category or Collection] > Sorting** screen lets you control the display order of products in a category or collection. It has three tabs, and this guide walks through each one separately: * **Sorting Algorithms** — apply an automatic sorting rule (e.g. price, newest arrivals). * **Products to Sort** — find products in the catalog pool and add them to your sorting list. * **Edit Sorting** — select and manually reorder the products you've added, using drag-and-drop, filters, or bulk actions.

You can use one tab or combine all three, depending on how much manual control you want over the order. In this guide: 1. **Tab 1 — Sorting Algorithms:** choosing an automatic sort rule 2. **Tab 2 — Products to Sort:** finding products and adding them to your sorting list 3. **Tab 3 — Edit Sorting:** selecting and manually arranging your sorted products ## Tab 1 **—** Sorting Algorithms This is the first tab you land on. Use it when you want the system to order products automatically — for example, always showing the cheapest items first, or newest arrivals first — instead of arranging every product by hand. ### Open the Sorting Algorithms tab 1. From the left panel, select the **Category** or **Collection** you want to sort. 2. On the right, make sure the **Sorting Algorithms** tab is selected (it's the leftmost of the three tabs, and the one shown by default).

### Choose an algorithm 1. Click the **Select Algorithm** dropdown. You'll see a searchable list of available algorithms, for example: * **Default —** the platform's standard order. * **Ascending Price —** lowest price first. * **Descending Price —** highest price first. * **Newcomers —** most recently added products first.

2. Click **+ Add** to add it to the Selected Algorithms list below. Repeat to add more than one — when several are added, the first one is the primary sort and the rest break ties, in the order they're listed.

3. Drag an item in the Selected Algorithms list to reorder it, or click − to remove it. 4. Click **SAVE SETTINGS** to confirm. ### Define a new algorithm (optional) Not finding what you need in the dropdown? 1. Click the All Sorting Algorithms link in the top right to go to **Settings > Sorting Algorithms**. 2. Define a new algorithm there (Dynamic, or External) — see [How to Create and Manage Sorting Algorithms in Omnitron](/tutorials/omnitron/settings/how-to-create-and-manage-sorting-algorithms-in-omnitron) for the full walkthrough. 3. Come back to this tab and add it.

{% hint style="warning" %} An automatic algorithm is a good starting point, but you can still fine-tune individual product positions afterwards in the Edit Sorting tab (Tab 3) — manual positions there take priority over the algorithm. {% endhint %} ## Tab 2 **—** Products to Sort This tab is where you build up the list of products you actually want to manually order. It shows every product available in the selected category/collection — not just the ones already being sorted. Filter this pool down to the products you care about, select them, and send them to the **Edit Sorting** tab (Tab 3), where you'll arrange their exact order. {% hint style="success" %} Only products you add here will show up in Edit Sorting. If a product is missing from your sort list, come back to this tab and add it. {% endhint %} ### Open the tab and view the pool Click the **Products to Sort** tab (middle tab). The list shows every product in the selected category/collection as a table, with columns for * **Image,** * **Base Code,** * **Listing Code,** * **Product Name,** * **Stock, Sales Price,** * **Retail Price,** and * **Variant Count**.

### Filter to find the products you want Use the filter fields above the table to narrow down the pool: * **Product Name, Base Code, Listing Code, SKU** for text search. * **Min./Max. Sales Price, Min./Max. Number of Stock, Min./Max. Variant Stock** for numeric ranges. * **Out of Stock** to filter by stock status.

* Click the **funnel** icon next to the CSV/XLS icons to open the **Filters** picker. Here you can search for and enable additional filter fields based on your product attributes — for example Color, Gender, Beden (Size), Material, or any other custom attribute defined. Once you tick an attribute, it's added as a new field in the filter panel, ready for you to enter a value and search by it, just like the default fields.

Applied filters appear as tags in the "Active Filters" row. Remove one with `✕`, or clear all of them at once with the trash icon at the end of the row.

You can also filter in bulk by uploading a **CSV** or **XLS** file instead of entering values one by one. Each row in the file represents one product group. The file accepts two columns:

Column	Meaning
`base_code`	The product group's main code
`listing_code`	The group's listing code

### Select products and send them to Edit Sorting 1. Tick the checkbox next to each product you want to sort. Selected rows are highlighted. 2. Open the **Select Action** dropdown and choose **Add Products To Sorting**. 3. Click **APPLY**. The selected products are added to the sorting list and become available in the **Edit Sorting** tab.

4. Optional: use the **XLS** icons in the top right to download the current list. Once you've added the products you care about, switch to **Edit Sorting** to arrange their exact display order. ## Tab 3 **—** Edit Sorting This is where you fine-tune the exact display order — product by product, or in bulk — using drag-and-drop, card selection, and bulk actions. It only shows products you've added via Products to Sort (Tab 2). ### Switch to Edit Sorting Click **Edit Sorting** (rightmost tab). Products are now shown as visual cards instead of a table. When you switch to this tab, the working area expands automatically: * The main left menu collapses to an icon strip (only icons remain). * The category/collection panel narrows and becomes scrollable within its own area. * This leaves a much wider area for the product cards.

### Choose a view mode Two icons in the toolbar let you switch the grid view: * **Detailed card view:** Product Name, Base Code, Listing Code, Stock, and Price appear below each card. This is the default view.

* **Image-only view:** only the product image is shown, so many more products fit in the same space.

* Use the **VIEW** slider to set how many cards appear side by side.

### Filter to select products, ready for sorting The filter fields here work differently from Tab 2: applying a filter **doesn't hide the rest of the grid**. Instead, it automatically **selects every matching product** — as if you'd clicked each one by hand — so they're instantly ready for a bulk action (move to top/bottom, remove, etc.). All other products stay visible on the grid; they're just left unselected. 1. Enter a value in one or more filter fields (**Product Name, Base Code, Listing Code, Min./Max. Stock, Min./Max. Price**). 2. The products **matching your filter become selected** (highlighted with a blue border) across the grid.

3. Apply a bulk action to act on exactly those selected products, or click cards individually to adjust the selection further. ### Reorder with drag-and-drop 1. Hold a card and drag it to the position you want. 2. The position number in the bottom-left corner of each card shows its current display order (1, 2, 3 …). 3. You can also select **multiple products first via their checkboxes**, then drag any one of the selected cards — the whole group moves together to the new position.

Drag-and-drop is ideal for positioning products one at a time; for moving many products at once — especially a group you've just selected via filter — use the bulk actions below instead. ### Jump to a position by typing it in 1. Click directly into the position number box on a card. 2. Type the new position and enter. The product jumps straight to that spot and the rest of the list shifts accordingly.

### Apply a bulk action 1. Select the products you want to act on — either by clicking cards individually, or by using a filter to select a whole group at once. 2. Open the "Select Action" dropdown and choose: * **Move to Beginning of List** * **Move to End of List** * **Remove All Products from List** — after you confirm. * **Remove Selected Products from List**

3. Click **APPLY**. (Disabled while no product is selected.)

{% hint style="info" %} *Bulk operations are held temporarily; don't forget to save your changes to make them permanent.* {% endhint %} ### Check product detail and sales performance 1. Click the zoom icon in the bottom-right corner of a card.

2. The "Select Product" window opens. The window shows a large product image and product info on the right, plus a Sales Performance section.

3. Pick a range from the period selector: Last 1 Day / 7 Days / 30 Days / 3 Months / 6 Months / 1 Year. * **Metrics shown:** Total Orders, Cancellations, Refunds, Net Orders, and Total Sales (GMV) — so you can spot high- and low-performing products and sort accordingly. * Use the `‹ ›` arrows to move to the next/previous product without closing the window. * The **MOVE TO TOP OF LIST / MOVE TO BOTTOM OF LIST** buttons let you reposition the product from here too.

* Ticking the **Select Product** checkbox at the top of the window also selects that product on the main grid — so once you close the window, it's ready for a bulk action just like any other selected card.

### Sort in bulk via CSV (optional) 1. Use the CSV export icon to download the current list.

2. Edit the product order in the file and save it — to change the order, **move entire rows** to their new position; don't edit the index/order numbers within a row and leave the row in place. The system reads the file top-to-bottom, so a row's position in the file is what determines its position in the sort order.

3. Use CSV import to upload the file back.

4. Before anything is applied, a preview screen shows you the new order based on the file — review it here, then click **Confirm & Save** to apply it. If something looks off, you can cancel and fix the file.

{% hint style="danger" %} Before importing your new sorting as a CSV file, make sure to export the latest CSV file and apply your changes to it. {% endhint %} ### Save your changes Click **SAVE CHANGES** at the bottom of the screen. Until you do, all moves and removals are only held temporarily. Clear product selection (bottom right) clears your current selection without touching the sort order.

If you try to leave without saving, the system will warn you. {% hint style="danger" %} Products you don't add here will appear after the sorted products, within that category/collection. To hide a product from the storefront entirely, remove it from the category/collection instead. {% endhint %} # Orders # How to Manage Orders in Omnitron? This tutorial provides step-by-step instructions for managing orders in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Orders Page * Follow the Orders sidebar and click the **Orders** page.

* On the **Orders** page, the filter panel and the list of existing orders lists are displayed. ## Step 3: Update Order Info with CSV File * By using the **Update Order Info with CSV** button, users can bulk update the order lists.

* Before starting the order update, a template can be downloaded by clicking on the **Download Order Update Template File** button at the bottom of the order list page.

* After downloading the template, you can enter the updated order information into the CSV file. * The fields to update include: * **status** : The status of the order line. * **shipping\_company** : Information about which shipping company the order line is shipped with (must be from the enum in Omnitron) * **e\_archive\_url** : The URL to access the invoice pdf in the Omnitron panel and sales channels. * **invoice\_number** : Invoice number for the order line. * **invoice\_date** : Billing date for the order line. * **tracking\_number** : Shipping tracking number for the order line (this will be sent filled when the cargo tracking integration is done by the company). * On the Orders page, users have the option to select the specific orders and perform the **Export to Excel with Selected Items** and **Export to CSV with Selected Items** actions.

## Step 4: Navigate to Order Detail Page * Click on one of the selected orders to navigate to the Order Detail page. * The Order Detail page includes information such as the customer's name, last name, shipping address, and the platform used. * To view all the details related to the order, including order information, customer information, shipping details, and payment information, click the **Expand All** button. * You can also view order logs by clicking the **Order Log** button.

## Step 5: Update Customer Information * To formally update customer information, click the **Edit** button under the **Customer Information** section. * This will open a form where you can make necessary changes to the customer's information

## Step 6: Create a Cancellation Plan * In the Product panel below the Order Details page, the products that create the order and the product features that can be added to the products are listed. * If you need to cancel or return specific products, select the products you want to work with. * Create a cancellation plan by specifying the transaction type and providing cancellation/return reasons. * After selecting the "Cancel/Return Selected Items" action, a cancellation plan will be created at the bottom of the order detail page.

* The cancellation process will refund the amount according to the payment method, up to the desired cancellation amount.

## Step 7: Manual Refund (If Required) * If the cancellation tasks cannot successfully refund the payment, the cancellation plan's status will progress to "Manual Refund Needed."

* After the manual refund is completed, the "Manual Refund Required" checkbox is marked for the order item that needs a manual refund, and the select the “Refund has been made” action.

## Step 8: Cancel Entire Order * If needed, you can cancel the entire order by using the **Cancel Entire Order** button at the bottom of the product panel. * Alternatively, based on the cancellation plan strategy, you can process a refund for only the shipping fee by using the **Only Refund Shipping Fee** button.

## Step 9: View Payment and Order Details * At the bottom of the order detail page, you can view sections that display payment transactions, Order Amount Before Return/Cancellation, Current Order Amount, and any contracts related to the order.

# How to Manage Cancellation and Return Requests in Omnitron? This tutorial provides step-by-step instructions for managing Cancellation/Return Requests in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Cancellation/Return Requests Page * Follow the **Orders** sidebar and click the **Cancellation/Return Requests** page.

* On the Cancellation/Return Requests page, the filter panel and the list of existing cancellation or return request lists are displayed. * Users have the option to select the specific orders and perform the **Export to Excel with Selected Items** and **Export to CSV with Selected Items** actions. * Cancellation/refund request list can be downloaded in XLS format through the **Download** button.

* To navigate to the Order Detail page, click on one of the selected Cancellation/Return Requests.

# Sales Channels # How to Manage Products in Omnitron? This tutorial provides step-by-step instructions for managing Products in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Products Page * Follow the **Sales Channels** sidebar and click the **Products** page.

* If the sales channel type is web or distributed, the above module is displayed. * On the **Products** page, the include and exclude filter panel and the list of existing products are listed.

## Step 3: Add/Remove Products to Catalog * In the product list, users can use the **Select Action** dropdown to either perform the **Add Selected Products to Catalogs** or **Remove Selected Ones From Catalog** actions for the listed items. The same actions can also be executed on the **Products & Catalogs > Catalogs > Product List** page.

## Step 4: Navigate to Edit Product Page * Upon clicking the product, the product details page will open on the right side of the screen. If a user wants to edit the product, they can initiate the process by clicking the **Edit Product** button, which will subsequently redirect them to the Add/Edit Product page.

# How to Manage Registered Users Based on Sales Channel? This tutorial explains how to track registered user information by sales channel from the Users page and how to update them. Additionally, it details how to access detailed user information and perform various actions. ## Step 1: Navigate to the Users Page * Follow the **Sales Channels** sidebar and click the **Users** page.

* On the Users page, users can use the filters at the top, labeled user properties, to narrow down the results as needed. * The selected filters is displayed in the **Active Filters** row.

## Step 2: Updating Users To bulk update users, follow these steps: * Click the **Bulk Update User** button located in the upper-right corner.

* Clicking this button opens a pop-up displaying local files. Select an Excel file from your local and upload it. {% hint style="info" %} You can download an example Excel template by clicking the **Download Bulk User Update Template** button at the bottom of the screen.

{% endhint %} ## Step 3: Accessing User Details To access detailed user information; * Click on the user's name in the list of users. * A new screen opens displaying the user's information and a list of their previous orders. * Clicking on one of the listed orders opens a detailed order view.

## Step 4: Updating User Permissions To update user permissions or membership information; * Navigate to the user's detail page. * Go to the section related to permissions. * Make the necessary updates by clicking **Enable** or **Remove permission** button as needed.

## Step 5: Other Settings To access additional user information or perform certain actions; * Click the **Expand All** button on the detail page to view more user information. * To send a password reset email to the user, click the **Send Forgot My Password Email** button. * To anonymize the user, click the **Anonymize The User** button.

# How to Create and Update Customer Groups in Omnitron? This tutorial explains how to create and update customer groups to effectively organize and target specific sets of customers and how to configure customer group settings to create dynamic customer groups with specific rules. ## Customer Groups ### Step 1: Navigate to the Customer Groups Page * Follow the **Sales Channels** sidebar and click the **Customer Groups** page.

### Step 2: Filtering Customer Groups * At the top of the Customer Groups page, you can filter customer groups based on customer attributes. * The selected filters is displayed in the **Active Filters** row. ### Step 3: Creating a New Customer Group * To create a new customer group, click the **+New Customer Group** button located in the upper right corner.

* A new window will appear, prompting you to enter a name for the customer group. This field is mandatory. (If you enter a customer group name that has been used before, you will receive a warning message.) * After entering the customer group name, click the **Save** button.

### Step 4: Assigning Customers to the Group * On the left side of the screen, you will find a list of all customers registered in the system. * To assign the customers to the group, select the customers you want to include from this list. * If you need to find a specific customer, you can use the filter area to search for them. * After making your selections, add customers to the group collectively using bulk addition actions or individually by clicking the green **+** button next to the customer.

### Step 5: Updating an Existing Customer Group * To update an existing customer group, click on the row corresponding to the group you want to update. * On the left side of the screen, you will see a list of all customers registered in the system. * On the right side, you will see the details of the selected customer group. * To add more customer to the existing customer group, clicking the green **+** button next to the customer row. * Once the process is complete, the right-hand list will be updated with the new additions. ## Customer Groups Settings ### Step 1: Navigate to the Customer Group Settings * Follow the **Sales Channels** sidebar and click the **Customer Groups**, then **Customer Group Settings**.

* From the Customer Group Settings page, you can set up the rules for creating a dynamic customer group. * These rules will determine how customer groups are created and how they affect the display of stock and pricing information. ### Step 2: Filtering Customer Group Settings * To manage and view your customer group settings, you can filter them based on customer attributes. * The selected filters is displayed in the **Active Filters** row. ### Step 3: Creating a New Customer Group Setting * To create a new customer group setting, click the **+New Customer Groups Setting** button located in the upper right corner.

* When adding a new customer group setting, you will need to provide a "name" and a "slug" for the setting. These fields are mandatory. The "name" is for identifying the setting, and the "slug" is a unique identifier for the setting. * The specific configuration you set for this customer group will determine how stock and pricing information is displayed to customers.

### Step 4: Example Use Case * For instance, let's say you want to create a special customer group setting for students. * Students can access custom stock and pricing information when they log in with their school email addresses. * To achieve this, you create a new customer group setting, name it "Student Discount," and set up the configuration to apply special pricing and stock display rules for customers with school email addresses. # Marketing # How to Create and Manage Campaigns in Omnitron? In this tutorial, we will guide you through the process of creating campaigns in your Sales Channels' Marketing tab. Campaigns are essential for promoting your products and attracting customers by offering various discounts or incentives. We will break down the process into four main sections: Campaign Information, Campaign Conditions, Campaign Actions, and Summary. ## Step 1: Navigate to the Campaigns Page * Follow the **Marketing** sidebar and click the **Campaigns** page.

* On this page, you can see a list of previously created campaigns. ## Step 2: Filtering Campaigns * At the top of the Campaigns page, you can filter campaigns based on campaign characteristics. * The selected filters are displayed in the **Active Filters** row. ## Step 3: Creating a New Campaign * Choose a campaign language from the available options listed in the Locales menu. * You may need to create independent campaigns for each language. * Ensure that the campaign message and customer warning messages are adapted to the selected language.

* To create a new campaign, click the **+ New Campaign** button in the upper-right corner.

### Campaign Information * This section is used to define the general information of the campaign.

* Fill in the required fields, including: * **Campaign Name:** The name of the campaign. * **Campaign Slug:** The unique name given to a campaign in the company's ERP system. * **Campaign Message:** The message shown to users in the basket summary and search filters. It must match the language chosen in the 'Locales' setting. * **Maximum Number of Applications (Per Cart):** Indicates how many times the campaign can be used within the same basket. A value of '0' is not allowed. * **Maximum Number of Applications (Per Customer):** Indicates how many times a single customer can apply the campaign. Use '0' for unlimited use. * **Start/End Date and Time:** Sets the date and time range when the campaign is valid. It automatically activates at the start time and deactivates at the end time you choose. * **Status:** Switches the campaign between active and passive states. * **Priority:** Determines whether the campaign takes precedence over other active campaigns. * **Currency:** Defines the currency for the campaign. To display this field on the Campaign Information page, you need to have more than one currency defined in Dynamic Settings under Sales Channel Settings. * **Combine with Other Campaigns:** When selected, this campaign can be combined with other active campaigns. * **Show on Product Detail:** If selected, the campaign's name is displayed on the product detail page. * **Show on Product List:** If selected, the campaign's name is displayed on the product list page. * **Show Gift Product**: If the product has an associated gift, it will be displayed as part of the campaign. * Click **Save and Continue** after filling all necessary fields. #### Understanding Priority and Combining Campaigns When more than one campaign is eligible for the same basket, two settings on this tab decide what happens: * **Priority (Importance)** sets the **order** in which eligible campaigns are evaluated. Non-combinable campaigns are evaluated first, and within each group the campaign with the **higher value is evaluated first**. Because campaigns are applied one after another, an earlier campaign can consume basket items and change what later campaigns see. Priority only orders the campaigns — on its own it does **not** stop a lower-priority campaign from also applying. * **Combine with Other Campaigns** decides whether this campaign is allowed to be applied **together with** other campaigns at all. If it is **not** selected, once this campaign applies, no other campaign is applied to the basket — only this single campaign takes effect. Combining is controlled by **three independent settings**, which are easy to confuse: 1. **Combine with Other Campaigns** (this tab) — the master on/off switch for stacking. 2. **Application Type** (Campaign Conditions and Campaign Actions tabs) — decides, per item, whether the products this campaign touches stay available to other campaigns (see below). 3. **Consume Group** — an optional advanced setting that lets campaigns in the same group apply one at a time by priority. {% hint style="warning" %} Selecting *"Products affected by the relevant campaign cannot be included in other campaigns"* only removes this campaign's items from the shared pool — it does **not** prevent a second campaign from applying on other items in the basket. To stop two campaigns from stacking entirely, unselect **Combine with Other Campaigns** on **all** of the overlapping campaigns. For the full behaviour and item-level examples, see [Promotions](https://github.com/akinon/docs/tree/main/technicalguides/commerce/promotions.md) and [Consume Group in Campaigns](https://github.com/akinon/docs/tree/main/technicalguides/commerce/consume-group-in-campaigns.md). {% endhint %} ### Campaign Conditions This section is used to define the conditions for the application of the campaign.

Fill in the required fields, including: * **Select a Collection:** Select a collection previously created in the products and catalogs section where you want to add the campaign. * **Primary Condition Type:** * **Total Amount:** Define specific amount or quantity thresholds for your campaign. If your campaign is based on a certain amount or quantity of products, select this option and enter the required number in the total amount/quantity field below. * **Minimum & Maximum Amount:** This field sets a range of amounts for your campaign. * **Total Number of Products**: Enables the campaign to be defined within a specific product quantity range. * **Minimum & Maximum Product Quantity:** This field sets the quantity range for products in the campaign. * **Distinct By:** If you want to limit products based on certain criteria, you can choose options such as None, SKU, Base Code, or Attributes. * **Payment Step Discount:** This covers discounts applied to the total basket during payment, typically during payment approval when a specific payment method is used. * **Supplier:** Used to create vendor-based campaigns for Unified and Seller Center. * **Secondary Condition Type:** This field allows you to add a secondary condition type to your campaign. * **Card Type:** Add custom campaign conditions based on card types defined within the system. * **Installments:** Add custom campaign conditions based on the number of installments. * **Bank:** Add custom campaign conditions based on the banks defined within the system. * **Payment Type:** Add custom campaign conditions based on payment options like credit card, wire, pay-on-delivery, Masterpass, and PayPal defined within the system. * **Minimum Cart Amount:** Set the minimum total amount for products in the cart to apply the campaign when the cart's total exceeds this limit. * **Email Extension:** Enter an email extension to make customers with that extension eligible for the campaign. * **Email:** Define a campaign for a specific email address. * **Card BIN:** These are the first 6 digits of a card and help the system identify the bank associated with the card. * **Minimum Number of Product(s) in Cart:** Specifies the minimum number of products required in the cart to apply the campaign. * **User Feature:** This field enables you to define additional conditions for your campaign to target specific scenarios or user groups, allows for advanced customization. For examples: * To offer free shipping for users with a "VIP" membership type, you can set the following condition: * `pre_order__user__attribute__member_type = vip` * Missing any necessary conditions may lead to issues (e.g., errors during checkout or incorrect campaign applications). * **Important Note:** This feature is highly customizable. So, If you require support or further assistance with configuring advanced conditions, please reach out to Akinon. * **Shopping Platform:** Options for web, Android, iOS, and Instore, allowing you to create unique campaigns for each platform. * **User Membership Date:** Users who registered after the selected date are eligible to use the relevant campaign. * **Number of Orders:** Customers who have placed orders in the specified amount are eligible for this campaign. * **User Warning Message:** These are messages meant to encourage customers to earn discounts. * **Price Type:** This field sets the campaign's application condition regarding price, with options like Unit Price, Discount Price, and Retail Price. * **Application Type:** Determines whether the discount will be applied to all products, products not included in other campaigns, or independently of other campaigns. Click **Save and Continue** after filling all necessary fields. {% hint style="info" %} If you intend to create a campaign that adjusts its scale independently, make sure to select "The campaign is applied independently of other campaigns" in the Application Type field. {% endhint %} ### Campaign Actions This section is used to define the action of the campaign when customers meet the conditions.

Fill in the required fields, including: * **Select a Collection:** Select a collection previously created in the Products and Catalogs module where the campaign should apply. * **Price Type**: * **Discount Price**: the system calculates the discount price of products that are on sale due to other campaigns. * **Unit Price**: it is based on the product’s selling price. * **Retail Price:** It is used to calculate the crossed-out price in the Retail Price shop. * **Application Type:** This field determines whether the discount will be applied to all products or to products with no campaigns applied. * Products affected by the relevant campaign can be included in other campaigns. * Products affected by the relevant campaign cannot be included in other campaigns. * The campaign is applied independently of other campaigns. ### Action Types Different action types have distinct fields associated with them. Each action type fields are explained below: **1. Price Discount** * **Price Discount:** Specify the desired discounted price. * **Discount Amount**: Determine the discount amount to be applied to the basket. **2. Cheapest Item Free (Buy 3, Pay 2)** * **Distributing to Products that Meet the Terms of Discount:** Controls how the discount is shared across the items that took part in the campaign (the `share_benefit_on_conditions` setting). It is **enabled by default**. * **Enabled (default):** the discount is distributed across **all** items that satisfied the condition, so each participating item is recorded as benefiting from the campaign and can be refunded proportionally. * **Disabled:** the discount is attributed **only to the free items**, so on return those items refund as **0 TRY**. * **Order Type:** This indicates whether the discount applies to the cheapest product, the most expensive product, or follows a gradual discount scheme. * **Gradual Discount:** This is a 2-4-6 discount. The discount is gradually applied to the second, fourth, and sixth most expensive products in the cart. * **Discount for the Cheapest Product:** The discount is applied to the cheapest product in the cart. * **Discount for the Most Expensive Product:** The discount is applied to the most expensive product in the cart. * **Number of Products to be Applied:** Specify the total number of products for which the campaign will be valid. {% hint style="warning" %} Keep **Distributing to Products that Meet the Terms of Discount** enabled unless you have a specific reason not to. Disabling it is the usual cause of "the item refunds as 0 TRY" reports, because the whole discount is attributed to a single line that then has nothing left to refund. {% endhint %} **3. Percent Discount** Apply a discount at the specified percentage. * **Percent Discount:** Enter the percentage discount to be applied. **4. Free Shipping** Ensures free shipping when the campaign conditions are met. **5. Coupon** Provide a coupon defined here to anyone who meets the campaign conditions.

**6. Discount Code** This option shares similarities with coupons. The key distinction is that a coupon is created within a user's account, while a discount code is provided to the user, and they are prompted to enter it during their purchase. **7. Sample Product** This action lets you include an additional product in the shopping basket. The products designated as "Sample Products" should already be listed in Omnitron as simple products. After you are certain about what the campaign will offer and have filled in the necessary information, click **Save and Continue**. ## Step 4: Review and Approve * On the Summary page, review all the Campaign Information, Conditions, and Actions. * If everything appears correct, click the **Approve** button to finalize the campaign creation process.

## Step 5: Changing the Status of Campaigns * Select the campaigns you want to change the status of from the list. * From the dropdown menu located at the top left of the list, click **Make Selected Active** if you want to activate the selected campaigns, or click **Make Selected Passive** if you want to deactivate them. * Click the **Apply** button.

## Step 6: Updating Campaigns * To make updates, click on the row of an existing campaign in the list. * You will be directed to the detail screen where you can make the necessary changes.

{% hint style="info" %} Seeing a discount that is larger, smaller, or distributed differently than expected? The cause is almost always in the campaign configuration — priority order, combine settings, Application Type, or Share Benefit on Conditions. Follow the step-by-step [Troubleshooting: Unexpected Discount Amount](https://github.com/akinon/docs/tree/main/technicalguides/commerce/promotions.md#troubleshooting-unexpected-discount-amount) checklist. {% endhint %} # How to Create and Manage Coupons in Omnitron? This tutorial provides step-by-step instructions for creating and managing coupons in Omnitron. ## Step 1: Navigate to Coupons Page * Navigate to the Omnitorn platform and log into your account. * Follow the **Sales Channels** > **Marketing** sidebar and click the **Coupons** page.

* On the Coupons page, the filter panel and the list of existing coupons are displayed. * You can filter the coupons based on their characteristics such as Coupon Name, Discount Type, and more. The selected filters are displayed in the active filters row. ## Step 2: Creating a New Coupon * To create a new coupon, start by selecting a language from the available options. This language preference will determine the language of the coupon message and user warning messages. * Then, click the **+ New Coupon** button located in the upper-right corner.

### Coupon Information * This section is used to define the general information of the coupon.

* Fill in the required fields, including: * **Coupon Name:** The name of the coupon. * **Discount Slug:** Define a name for the coupon in your ERP system. * **User:** Choose which customers are eligible for the coupon. * **Coupon Message:** This message is shown to customers in the cart summary and search filters. Please make sure it is in the selected language. * **Maximum Number of Applications (Per Cart):** Specify the maximum number of times each customer can apply the coupon. Use "0" for unlimited uses. * **Priority:** Set the priority of the coupon in comparison to others. A lower value indicates higher priority, and negative values are allowed. * **Start/End Date and Time:** Define the valid date and time for the coupon. * **Status:** Toggle the status to activate or deactivate the coupon. * **Currency:** Select the currency for the coupon. * **Can be combined with other campaigns:** Choose whether the coupon can be combined with other active campaigns or discounts. * **Show on Product Detail:** Choose whether the coupon name should be displayed on the product detail page. * Click **Save and Continue** after filling all necessary fields. ### Coupon Conditions * This section is used to define the conditions for the application of the coupon.

* Fill in the required fields, including: * **Select a Collection:** Select the collection to which the coupon should apply. * **Primary Condition Type:** Select the primary condition type, such as Total Amount, Total Number of Products, or Payment Step Discount, and define specific conditions based on your selection. * (You can also define secondary conditions based on card types, installments, banks, payment types, minimum cart amount, email extensions, and more.) * **User Warning Message:** Customize the user warning message to encourage customers to meet the coupon conditions. Use placeholders like {remaining} to dynamically display information about what customers need to do to qualify for the coupon. * **Price Type:** Select the price type to determine the application condition related to pricing, such as Unit Price, Discount Price, or Retail Price. * **Application Type:** Select the application type to specify whether the coupon will be applied to all products or only to products without any pre-existing coupons. * Click **Save and Continue** after filling all necessary fields. ### Coupon Action * This section is used to define the action of the coupon when customers meet the conditions.

* Fill in the required fields, including: * **Select a Collection**: Select the collection to which the coupon should apply. * **Action Type:** Select the action type that aligns with the specific discount or offer you want to provide, such as **Price Discount, Cheapest Item Free, Percent Discount, Free Shipping,** and more. * **Price Type:** Specify the price type to decide whether the discount will be applied to the **Unit Price** or the **Discount Price**. * **Application Type:** Set the application type to determine whether the coupon can be used in conjunction with other coupons or campaigns. * Depending on your selection, configure the specific details of the action. * Click **Save and Continue** after filling all necessary fields. ## Step 3: Review and Approve * On the Summary page, review all the Coupon Information, Conditions, and Actions. * If everything appears correct, click the Approve button to finalize the discount code creation process.

## Step 4: Changing the Status of Coupons * Select the coupons you want to change the status of from the list. * From the dropdown menu located at the top left of the list, click **Make Selected Active** if you want to activate the selected coupons, or click **Make Selected Passive** if you want to deactivate them. * Click the **Apply** button.

## Step 5: Updating Coupons * To make updates, click on the row of an existing coupon in the list. * You will be directed to the detail screen where you can make the necessary changes.

# How to Create and Manage Bulk Coupons in Omnitron? This page will enable you to create bulk coupon codes according to the conditions you have set to achieve the campaign while managing them in several aspects. ## Step 1: Access to Omnitron * Access the Omnitron panel through your URL. * Insert your granted *Username* and *Password*, and click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FQnfNjX72in5Qcy4LZzGH%2Fimage.png?alt=media\&token=7777dd02-19d8-44cd-af84-d258bc07ab2b) ## Step 2: Navigate to Bulk Coupons Page * From the sidebar, click through **Sales Channels > Marketing > Bulk Coupons.**

## Step 3: Creating a New Bulk Coupon * To create a new bulk coupon, click the **+ New Bulk Coupon** that is located in the upper-right corner. * This feature will later break down to 4 + 1 main categories to fill out, respectively; Bulk Coupon Information, Bulk Coupon Condition, Bulk Coupon Action, Summary and Bulk Coupon section that will open after successfully reviewing and saving the summary.

### Bulk Coupon Information After selecting the local language, you will be taken to the "Bulk Coupon Information" section where you need to fill out the following fields: * **Discount Name:** Enter a unique name for the coupon. * **Discount Slug:** Define a name for the coupon in your ERP system. * **Discount Message:** This is the message displayed to customers in the cart summary and search filters. Ensure that it's in the selected language. * **Maximum Number of Applications (Per Customer):** Specify how many times this coupon can be applied for customers. Use "0" for unlimited use. * **Maximum Number of Applications (Per Cart):** Specify how many times this coupon can be applied to the basket. Use "0" for unlimited use. * **Priority:** Set the priority of this coupon compared to others. A lower numerical value gives higher priority. Negative values are allowed. * **Start/End Date and Time:** Define the valid date and time for the coupon. * **Status:** oggle the status to activate or deactivate the coupon. * **Currency:** Choose the currency for the coupon. * **Can be combined with other campaigns:** Decide if this coupon can be combined with other active campaigns or coupons. * **Show on Product Detail:** Select whether the coupon name should be displayed on the product detail page. After filling out the mandatory fields, click **Save and Continue**.

### Bulk Coupon Conditions In the "Bulk Coupon Conditions" section, define the conditions required for the coupon to be applied: * **Select a Collection:** Select the collection to which the coupon should be applied. * **Condition Type:** Select from options such as Total Amount, Total Number of Products, Payment Step Discount. Depending on your selection, set the specific conditions and criteria for the coupon. * **Upper Limit:** After setting the condition along with criteria as **greater than**, set the upper limit to be applied to limit customer’s action. * You can also define **Secondary conditions** to complex the target customer based on card types, installments, banks, payment types, minimum cart amount, email extensions, and more, with using the plus (+) button you will be able to add as many as secondary conditions. * Configure the **User Warning Message** to encourage customers to meet the coupon conditions. Use placeholders like {remaining} to dynamically display information about what customers need to do to earn the coupon. * Select the **Price Type** to determine the application condition regarding price, such as Unit Price, Discount Price, or Retail Price. * Choose the **Application Type** to specify whether the coupon will be applied to all products or only to products without any applied coupons. Once all conditions are set, click **Save and Continue**.

### Bulk Coupon Action In the "Bulk Coupon Action" section, define what action the customer will receive if they meet the coupon conditions: * **Select a Collection:** Choose the collection for which the coupon is expected to be valid. * Select the **Action Type** that corresponds to the type of discount or offer you want to provide, such as Price Discount, Cheapest Item Free, Percent Discount, Free Shipping, and more. Depending on your selection, configure the specific details of the action. * Specify the **Price Type** to determine whether the discount will be applied to the Unit Price, Discount Price or Retail Price. * Set the **Application Type** to determine whether the discount can be combined with other coupons or campaigns. Once you've configured the bulk coupon action, click **Save and Continue**.

#### Summary The **Summary** section will allow you to review all the information you have entered for the coupon, including coupon details, conditions, and actions. At the bottom of the page, you can either click **Edit** to make changes or **Approve** to finalize the coupon creation process.

### Bulk Coupon After successfully approving the summary section, once clicked to the **Bulk Coupon** step, 2 buttons will be available to create coupon codes, respectively; **+ Discount Code, + Bulk Discount Code** along with the page view for already created coupons codes for that specific campaign.

### **Activate/Deactivate Discount Codes** From the **Discount Codes** section, you can select the check box as shown and apply **Active/Passive** in a bulk action.

### **Add Discount Code** From the **Add Discount Code** pop up, you can either type a manual code and click **Save** or you can click the green button to automatically generate one.

### **Add Bulk Discount Code** In the **Add Bulk Discount Code** pop up**,** complete the following fields: * **Number of Discount Codes:** Total number of codes that are expected to be generated. * **Discount Code Prefix:** Common numbers or letters that are expected to be placed on the beginning of code, such as **Summer**12X162Y, **Summer**1948F6X. * **Discount Code Length:** The expected character of the code excluding the **Prefix**, default value will be 8 when it is not filled out. * **Discount Code Content:** Expected variation and combinations of the characters that are on the code; it can be selected as letters, numbers, the combination of both and/or created custom. When the steps are looking right, click **Save** to generate.

## Step 4: Filtering Coupons Users can filter the coupons based on their characteristics such as coupon name, start date, and more. The selected filters will be displayed in the active filters row.

# How to Create and Manage Discount Codes in Omnitron? This tutorial provides step-by-step instructions for creating and managing discount codes in Omnitron. ## Step 1: Navigate to Discount Codes Page * Navigate to the Omnitorn platform and log into your account. * Follow the **Sales Channels** > **Marketing** sidebar and click the **Discount Codes** page.

* On the Discount Codes page, the filter panel and the list of existing discount codes are displayed. * You can filter the discount codes based on their characteristics such as Discount Name, Discount Type, and more. The selected filters are displayed in the active filters row. ## Step 2: Creating a New Discount Code * To create a new discount code, start by selecting a language from the available options. This language preference will determine the language of the discount and user warning messages. * Then, click the **+ New Discount Code** button located in the upper-right corner.

### Discount Code Information * This section is used to define the general information of the discount code.

* Fill in the required fields, including: * **Discount Name:** The name of the discount code. * **Discount Slug:** The unique name given to a discount code in the company's ERP system. * **Discount Code:** Enter the code to offer customers. You have the option to generate a new discount code by clicking the **+ New Discount Code** button or enter a custom discount code. * **Discount Message:** This message is shown to customers in the cart summary and search filters. * **Maximum Number of Applications (Per Customer):** Specify the maximum number of times each customer can apply the discount code. Use "0" for unlimited uses. * **Maximum Number of Applications (Per Cart):** Set a limit on how many times the code can be applied to the same cart. * **User:** Choose which customers are eligible for the discount code. * **Start/End Date and Time:** Define the valid date and time for the discount code. * **Status:** Toggle the status to activate or deactivate the discount code. * **Priority:** Set the priority of the discount code in comparison to others. A lower value indicates higher priority, and negative values are allowed. * **Currency:** Select the currency for the discount. * **Can be combined with other discount-codes:** Decide whether the discount can be combined with other active discount-codes or discounts. * Click **Save and Continue** after filling all necessary fields. ### Discount Conditions * This section is used to define the conditions for the application of the discount code.

* Fill in the required fields, including: * **Select a Collection:** Select the collection to which the discount code should apply. * **Condition Type:** Choose the primary condition type, such as **Total Amount, Total Number of Products,** or **Payment Step Discount**, and define specific conditions based on your selection. * (You can also define secondary conditions based on card types, installments, banks, payment types, minimum cart amount, email extensions, and more.) * **User Warning Message:** Customize the user warning message to encourage customers to meet the discount code conditions. Use placeholders like {remaining} to dynamically display information about what customers need to do to qualify for the discount code. * **Price Type:** Select the Price Type to determine the application condition related to pricing, such as Unit Price, Discount Price, or Retail Price. * **Application Type:** Select the Application Type to specify whether the discount code will be applied to all products or only to products without any pre-existing discounts. * Click **Save and Continue** after filling all necessary fields. ### Discount Action * This section is used to define the action of the discount code when customers meet the conditions.

* Fill in the required fields, including: * **Select a Collection**: Select the collection to which the discount code should apply. * **Action Type:** Select the action type that aligns with the specific discount or offer you want to provide, such as **Price Discount, Cheapest Item Free, Percent Discount, Free Shipping,** and more. * **Price Type:** Specify the price type to decide whether the discount will be applied to the **Unit Price** or the **Discount Price**. * **Application Type:** Set the application type to determine whether the discount can be used in conjunction with other coupons or discount-codes. * Depending on your selection, configure the specific details of the action. * Click **Save and Continue** after filling all necessary fields. ## Step 3: Review and Approve * On the Summary page, review all the Discount Code Information, Conditions, and Actions. * If everything appears correct, click the Approve button to finalize the discount code creation process.

## Step 4: Changing the Status of Discount Codes * Select the discount codes you want to change the status of from the list. * From the dropdown menu located at the top left of the list, click **Make Selected Active** if you want to activate the selected discount codes, or click **Make Selected Passive** if you want to deactivate them. * Click the **Apply** button.

## Step 5: Updating Discount Codes * To make updates, click on the row of an existing discount code in the list. * You will be directed to the detail screen where you can make the necessary changes. # How to Configure SEO Settings in Omnitron? Search Engine Optimization (SEO) is crucial for improving the website's visibility in search engines. This tutorial explains the process of configuring SEO settings for your website and provides step-by-step instructions on how to create new settings, filter settings and edit/delete existing settings. ## Step 1: Navigate to SEO Settings Page * Follow the **Sales Channels >** **Marketing** sidebar and click the **SEO Settings** page.

## Step 2: Filtering and Editing SEO Settings for a Page * On the SEO Settings page, the filter panel and the list of existing SEO settings are displayed. * You can filter pages based on several criteria, including Page URL, Meta Title, Meta Description, First and Last Creation Dates, and First and Last Updated Dates. Use these filters to quickly locate the page you want to work on. * To edit the SEO settings for a specific page, click on the row containing the page. This will take you to the SEO Settings detail screen for that page.

## Step 3: Creating a New SEO Setting * To create a SEO settings for a new page, click the **+ New SEO Setting** button in the upper-right corner of the SEO Settings page.

* On this page, fields are dynamically generated based on the selected shop and its defined schemas. * The form will be pre-filled with information, including Title, Description, Keywords, and Social Media Tags, based on the configured page URL. You can configure these settings manually or programmatically, with the exception of Meta Title and Meta Description rules.

The fields on this form: * **HTML Tag:** * **Page URL:** Enter the URL of the page for which you want to set SEO settings. * **Meta Title:** Specify the title to be displayed in search engine results. * **Meta Description:** Provide a concise description for the page. * **Meta Keywords:** Add relevant keywords for the page. * **Twitter Media Tag:** * Configure the fields required for Twitter. * **Google+ Media Tag:** * Set the fields required for Google+. * **Facebook Media Tag:** * Define the fields required for Facebook. * **CSS Selector Class:** * This field can typically be left empty unless you need to specify a CSS class for styling purposes. ## Step 4: Adding Bulk SEO Settings * On the SEO Settings page, you have the option to use the **Add Bulk SEO Settings** button located in the upper-right corner. This feature allows you to add multiple SEO settings at once by uploading a file in XLS or CSV format. * Ensure that your file includes fields for Title, URL, Description, Keywords, and Attributes for Twitter titles.

* Additionally, you can download a template for the file you will upload by clicking on the **Download Add Bulk SEO Setting Template File** button at the bottom of the page and view the necessary fields.

## Step 5: Deleting SEO Settings * Select the desired SEO setting to be deleted from the list. Multiple SEO settings can be selected. * From the dropdown menu at the top of the list, select the **Delete Selected Items** option, then click the **Apply** button.

# How to Configure URL Redirects and Settings in Omnitron? This screen will enable you to 301 redirect the old URLs to the desired target URL. Please see further instructions to achieve this goal and be cautious when intended to change slugs due to its SEO important nature. ## Step 1: Access to Omnitron * Access the Omnitron panel through your URL. * Insert your granted *Username* and *Password*, and click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FQnfNjX72in5Qcy4LZzGH%2Fimage.png?alt=media\&token=7777dd02-19d8-44cd-af84-d258bc07ab2b) ## Step 2: Navigate to URL Redirections Page * Follow through the **Sales Channels > Marketing** sidebar and click the **URL Redirects** page.

* Once you click the URL Redirects page, you will find a filtering area to help you sort and find specific old and new URLs for redirection. * There is a redirection list that displays existing URL redirects. Clicking a row in this list will take you to the Edit URL Redirection page, where you can modify the settings of a particular redirection.

## Step 3: Creating a New Redirection * To create a new URL redirection, click the **+ New Redirect** button, located in the upper-right corner. * You will be directed to a form where you can define the redirection settings.

### **Add/Edit URL Redirection** Fill out following fields with the appropriate URLs you desire to redirect. This is useful for managing broken links or changing URL structures. * **Old URL:** Enter the old URL that is no longer in use. This is the URL you want to redirect from. * **New URL:** Enter the URL to which users will be redirected when they click on the old URL. This is the destination URL. Click the **REDIRECT** button after filling the fields. **Add/Update URL Redirection Bulk (Optional)** On the URL Redirects page, you have the option to perform Bulk URL Redirections, which can be useful when you need to redirect multiple URLs at once. * To add or update the URL redirection settings in bulk, click **+ New URL Redirect** button, which may have a section specifically designed for bulk actions. * Follow the on-screen instructions to redirect URLs in bulk with a file. ## How to Configure URL Settings? URL Settings are crucial for maintaining website structure and SEO. Often used for products and categories along with the rest of the single pages that adds to the link structure of the e-commerce website, ensuring a standardized URL structure. URL Settings are divided into 3 main categories under the roof of URL Settings, respectively, **URL Settings, Product URL Settings, Category URL Settings.** {% hint style="info" %} Product & Category URL settings are automatically created by the system with considering their SEO structure and should not be altered without proper guidance. {% endhint %}

### Step 1: URL Settings Follow through the **Sales Channels > Marketing** sidebar and click the **URL Settings** page. * Insert the **Language** of the link setting desired to be done, this will clarify which language your root domain targeted, as in /en, /ar extensions. * Insert the **Old URL** to be redirected which is often assigned by the system but does not match with the URL structure of your website, as in the example /category/643. * Insert the **New URL** that matches with your content and URL structure for example /bags/. This section can be used as URL redirections as we studied above since its 301 redirection nature and it will store all your redirected links from both screens; URL Settings and URL Redirections.

### Step 2: Product URL Settings Product URL Settings are created to standardize the URL structure of single products pages that exist on your e-commerce site. For instance, when a new product is registered on your website, the Old URL is automatically generated. When the product is moved to a specific category, a unique URL is generated for the product and entered in the New URL field. Often used with the combination of (domain)/(category) - **Product Name-Base Code.** * While domain is stable and not changeable, category will be dependent on the category tree where you desired your product to be stored, this will help you build a healthy breadcrumb strategy, and product name/base code combination will be coming from the key section of **Product Url Settings** and can be combined with more keys as desired. {% hint style="info" %} See more in the following feature, Category URL settings to see how category links are generated. {% endhint %}

### Step 3: Category URL Settings Category URL Settings are designed to standardize the URL structure of categories displayed on your e-commerce website. Whenever you create or modify a category, these settings ensure that the URL structure remains consistent and user-friendly. It is often used with the keys of parent-name, which refers to the parent category in the category tree, in this example let's say ‘women’ and name will be referred as the category name, in this example we can call it ‘shoes’ to be explained more clearly. But can be enriched as desired by consulting your authorized person who is assigned to your e-commerce brand.

# How to Manage Promotions in Omnitron? ## Campaigns * If the campaign to be created will not be applied to all products of the brand, a collection must first be created for the campaign. * Steps to Follow for Creating Collections: **Omnitron > Products and Catalogs > Collections**, followed by clicking on *Add New Collection* and filling in the fields below.

**Collection Name:** The name given to the created collection. **Catalog:** The sales channel for the created collection is selected. **Collection Type:** Static or dynamic collection is selected. In *Static Collection,* the products are added to the collection manually, whereas in *Dynamic Collection*, a product list is prepared according to certain filters.

**Status:** *Active/Passive* status of the collection is determined. ### Creating a Campaign * Steps to Follow: **Omnitron > Sales Channels > Marketing > Campaigns**. * This is followed by clicking on *Add New Campaign*. * Each campaign is created exclusively for the relevant **Sales Channel**. #### **Campaign Information**

| Title | Description | Example | | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Campaign Name** | The name given to the campaign | | | **Campaign Slug** | Campaign Slug | | | **Campaign Message** | The message that will appear in the filter and/or basket when the campaign is applied | *“You have won X TRY!”, “You have X TRY more to spend”* etc. | | **Maximum Number of Application (per Basket)** | Information on how many times a campaign will be used in a basket | In a case where the Maximum Number of Application is 1, when there is a 50% discount campaign if you buy three products, only 50% discount is provided both for the person who buys three products, and for the person who buys six products. | | **Maximum Number of Application (per Customer)** | Information on how much a customer can benefit from a campaign. | | | **Priority** | The field to determine which campaign will be applied first in case there is more than one campaign for a product. | Example Campaign: *Discount of 10% for the first product, 20% for the second product, 30% for the third product*; in such case, the order of priority for three different campaigns must be provided in the correct order. | | **Start Date** | Campaign Start Date | | | **End Date** | Campaign End Date | | | **Status** | Campaign Activity Status | `Pasive` and `Active` options are available. | | **Can be combined with other campaigns** | The checkbox that will decide whether the relevant product will benefit from other campaigns in case a product is included in more than one campaign. | | | **Show on Product Detail** | The checkbox that decides whether to show the relevant campaign on the Product Detail Page. | | | **Show on Product List** | The checkbox that decides whether to show the relevant campaign in the Product List. | | #### **Campaign Conditions**

For the created collection, the campaign conditions may be entered through **Total Amount, Total Quantity, Payment Step Discount** subject to the **Condition Type** restrictions below.

**Total Amount:** The campaign is valid for orders that match the determined total amount and the upper amount limit. **Total Quantity:** The campaign is valid for orders that comply with the determined total quantity and upper quantity limit. **Payment Step Discount:** The campaign is valid for orders that meet the following conditions in the Payment Step. **Condition Types:**

| Condition Types | Explanations | Can be Applied To | | ---------------------------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------- | | **By Card Type** | By Card Type in Omnitron | *Payment Step Discount* | | **According to Installments** | According to the Installments to be Applied to the Products | *Payment Step Discount* | | **By Bank** | By All Banks Coming By Default After Omnitron Installation | *Payment Step Discount* | | **By Payment Type** | By Payment Types such as Credit Card, Money Order, Pay-On-Delivery etc. | *Payment Step Discount* | | **Minimum Basket Amount** | | *Total Amount, Total Quantity, Payment Step Discount* | | **e-mail Extension** | By Group/Company E-Mail Addresses | *Total Amount, Total Quantity, Payment Step Discount* | | **e-mail** | By Specific E-Mail Address | *Total Amount, Total Quantity, Payment Step Discount* | | **Bin Number** | By the First Six Digits of the Credit Card | *Payment Step Discount* | | **User Feature** | According to the Specific Features of the User Signed Up on the Brand Shop Page | *Total Amount, Total Quantity, Payment Step Discount* | | **Minimum Number of Products Added to Basket** | | *Total Amount, Total Quantity, Payment Step Discount* | | **Shopping Platform** | By Sales Channel | *Total Amount, Total Quantity, Payment Step Discount* | | **By User Membership Date** | | *Total Amount, Total Quantity, Payment Step Discount* | **User Warning Message:** The warning message that will encourage the user to qualify for the discount, ”{remaining}” shows the information about the remaining amount for the user to qualify for the campaign. \* For instance, *“Add {remaining} more items to your basket and get free shipping.”, “Add {remaining} more items to your basket and get the third one for free.”* **Price Type:** Unit/Discount/Retail price options are available. The campaign can be based on these price types.

**Application Type:** Application type of the campaign is selected from the options below.

\- **Campaign products can be included in other campaigns:** If a product is in more than one collection/campaign, the user can benefit from both campaigns. \- **Products affected by the campaign cannot be included in other campaigns.** \- **The campaign is implemented independently from other campaigns:** Even if a product is in more than one campaign, the user may only benefit from this campaign. It does not matter if other campaigns are more advantageous or not. #### **Campaign Action**

**Select Collection:** A collection different than the collection on the Campaign Conditions page can be selected. The goal is to provide discounts for different collections when different products are purchased. For instance, offering a discount for *ski boots* with the purchase of a *ski jacket*. **Action Type:**

| Action Type | Definition | Example | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Price Discount** | The products under the selected collection that meet the campaign conditions are given a discount equal to the **Discounted Price** value according to **Price Type and Application Type**. | | | **Cheapest Item Free** | One of the *Percent Discount/ Price Discount/ Fixed Price/ Fixed Total Price* campaigns may be applied with the *Distributing to Products that Meet the Terms of Discount* option depending on the *Gradual Discount/ Discount for the Cheapest Product/ Discount to the Most Expensive Product* options for the products under the selected collection that meet the campaign conditions according to the **Price Type, Application Type and Number of Products to be Applied**. | **“Buy 6, Pay 4" Campaign:** **Campaign Conditions** - *“Total Quantity”, Total Quantity = 6*, **Campaign Actions** - *Action Type = Cheapest Item Free, Percent Discount = 100, Number of Products to be Applied = 2*. Depending on the *Application Type*, the relevant campaign can be used in every six products. (Buy 12 Pay 8, Buy 18 Pay 12…) | | **Percent Discount** | The products under the selected collection that meet the campaign conditions are given a discount equal to the **Percent Discount** value according to **Price Type and Application Type**. | | | **Free Shipping** | The products under the selected collection that meet the campaign conditions are shipped for free. | | | **Coupon** | Coupons are defined for the users who meet the campaign conditions, with the **Conditions and Actions** being specified with the coupons. | | | **Discount Code** | Discount Codes are shared with the users who meet the campaign conditions, with the **Conditions and Actions** being specified with the codes. | | #### Discount Codes * These are codes that will provide users with a one-time discount or discounts for certain periods when entered in the Add to Basket or Payment Steps. * Discount codes are created automatically by Omnitron; they can be user-based, or can be used by anyone who enters the relevant code. #### Creating a Discount Code * Steps to Follow: **Omnitron > Sales Channels > Marketing > Discount Codes**. * This is followed by clicking on *Add New Discount Code*. * Each discount code is created exclusively for the relevant **Sales Channel**. #### **Discount Code Information**

In addition to what is described under the **Campaign Information** heading, the **Discount Code** related to the *User* input can be user-based. | Title | Description | Example | | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Discount Name** | The name given to the discount | | | **Discount Slug** | Discount Slug | | | **Discount Code** | Discount Code Automatically Generated by Omnitron upon clicking on the *Generate Discount Code* button | `0A9762DE` | | **Discount Message** | Discount code message that will be shown in the filter and/or the basket | | | **Maximum Number of Application (Per Basket)** | Information on how many times a discount can be used in a basket | In a case where the **Maximum Number of Application** is 1, a discount code can only be used once in the basket. | | **Maximum Number of Application (Per Customer)** | Information on how many times a customer can benefit from a discount. | | | **User** | Information on the user for whom the discount code has been defined. | | | **Priority** | The field to determine which campaign will be applied first in case there is more than one campaign for a product. | Example Campaign: *Discount of 10% for the first product, 20% for the second product, 30% for the third product*; in such case, the order of priority for three different campaigns must be provided in the correct order. | | **Start Date** | Discount Start Date | | | **End Date** | Discount End Date | | | **Status** | Discount Activity Status | `Pasive` and `Active` options are available. | | **Can Be Combined with Other Campaigns** | The checkbox that will decide whether the relevant product will benefit from other campaigns in case a product is included in more than one campaign. | | | **Show on Product Detail** | The checkbox that decides whether to show the relevant discount on the Product Detail Page. | | #### **Discount Conditions**

As described under the **Campaign Conditions** heading, the **Discount Conditions** are created with *Collection* and *Condition Types* selections. #### **Discount Action**

As described under the **Campaign Action** heading, the **Discount Action** is created with *Collection* and *Action Type* selections. Action Types listed for Discount Action can be seen below. **Action Type:** | Action Type | Definition | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Price Discount** | The products under the selected collection that meet the discount conditions are given a discount equal to the **Discounted Price** value according to **Price Type and Application Type**. | | **Cheapest Item Free** | One of the *Percent Discount/ Price Discount/ Fixed Price/ Fixed Total Price* campaigns may be applied depending on the *Gradual Discount/ Discount for the Cheapest Product/ Discount to the Most Expensive Product* options for the products under the selected collection that meet the campaign conditions according to the **Price Type, Application Type and Number of Products to be Applied**. | | **Percent Discount** | The products under the selected collection that meet the discount conditions are given a discount equal to the **Percent Discount** value according to **Price Type and Application Type**. | | **Free Shipping** | The products under the selected collection that meet the discount conditions are shipped for free. | ## Coupons ### Creating a Coupon * Steps to Follow: **Omnitron > Sales Channels > Marketing > Coupons**. * This is followed by clicking on *Add a New Coupon*. #### **Coupon Operations** Just as in **Campaigns** and **Discount Codes**, Coupons are created by entering the details of the coupon in the **Coupon Information** page,

determining the coupon conditions in the **Coupon Conditions** page,

and determining the coupon actions in the **Coupon Actions** page.

Coupons differ from **Campaigns** and **Discount Codes** in that they are defined directly for the user. The user of the coupon can be selected from the *User* dropdown menu on the **Coupon Information** page. As soon as the selected user signs in under the relevant brand, the defined coupon becomes `Active`, and the user does not need to do anything else. # Content Management # How to Manage Widgets in Omnitron? This tutorial provides step-by-step instructions for managing widget content for channels like banners and sliders, and how to effectively control and customize the content displayed on your web pages through widgets in Omnitron. ## Step 1: Navigate to Widget Management * Navigate to the Omnitron platform and log into your account. * Follow the **Sales Channels** > **Content Management** sidebar and click the **Widget Management** page.

## Step 2: Filtering Widgets * On the Widget Management page, the filter panel and the list of existing widgets are displayed. * You can filter the widgets based on their characteristics such as Widget Type, Widget Name, and Slug. The selected filters are displayed in the active filters row. ## Step 3: Creating a New Widget * To create a new widget, click the **+ New Widget** button located in the upper-right corner.

* Fill in the required fields, including: * **Widget Name:** Provide a name for the widget you intend to add. You can also specify the name of the page it will be displayed on for future reference. * **Widget Slug**: Enter a descriptive tag for the widget, ensuring you avoid using spaces, special characters, or capital letters. You can use a hyphen (-) for spaces. * **Widget Type:** Select one of the widget types from the drop-down menu that has been added in the Widget Schema Management screen. * **Template:** Input the file folder location where the widget's HTML code is stored. This information will be supplied by the project manager. * Click **SAVE & CLOSE** after filling all necessary fields.

{% hint style="info" %} Please note that each widget type comes with its own set of fields. Selecting a widget type will reveal the fields specifically defined for that widget, which can be found in the Widget Schema Management screen. {% endhint %} ## Step 4: Updating Widgets * To make updates, click on the row of an existing widget in the list. * You will be directed to the detail screen where you can make the necessary changes.

# How to Manage Widget Schema in Omnitron? This tutorial provides step-by-step instructions for managing widget schemas on your site and mobile platforms in Omnitron. ## Step 1: Navigate to Widget Schema Management * Navigate to the Omnitron platform and log into your account. * Follow the **Sales Channels** > **Content Management** sidebar and click the **Widget Schema Management** page.

## Step 2: Filtering Widget Schemas * On the Widget Schema Management page, the filter panel and the list of existing widget schemas are displayed. * You can filter the widget schemas based on Widget Type. The selected filters are displayed in the active filters row. ## Step 3: Creating a New Widget Schema To add a new widget to the Storefront, the first step is to create a **Widget Schema**. * To create a new widget schema, click the **+ New Widget Schema** button located in the upper-right corner.

* Fill in the required fields, including: * **Widget Type:** Provide a name for the widget type. * **Schema:** This field defines the widget areas to be displayed on the Storefront in JSON format. It is used to specify the areas that will be included within a widget, subsequently added to the Storefront under the Widget Management menu. Please contact your project manager for assistance in completing this field. * Click **Save** after filling all necessary fields.

## Step 4: Updating Widget Schemas * To make updates, click on the row of an existing widget schema in the list. * You will be directed to the detail screen where you can make the necessary changes.

# How to Manage Flat Pages in Omnitron? Flat pages are characterized with the usage for blogs and news content, as well as for general examples such as "About Us" and "Contact Us", often referred to as static pages. This page allows you to dynamically create pages using HTML editors, and you can also enhance them with templates based on your requirements. To leverage all of these features, please reach out to your authorized project manager, as the template names may vary, and the page structure can be customized through scripts. ## Step 1: Access to Omnitron * Access the **Omnitron** panel through your URL. * Insert your granted *Username* and *Password*, and click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FQnfNjX72in5Qcy4LZzGH%2Fimage.png?alt=media\&token=7777dd02-19d8-44cd-af84-d258bc07ab2b) ## Step 2: Navigate to Flat Page Management Page * Follow through the **Sales Channels > Content Management** sidebar and click the **Flat Page Management** page.

## Step 3: Filtering Flat Pages * Pages created within Flat Page Management can be conveniently filtered by *Title, Template Name, Link, and Authentication* to facilitate easy navigation and search.

## Step 4: Adding a New Flat Page * To add a new flat page, click the **+ New Flat Page** button.

* Complete the form by filling in the following fields: * **Title:** Provide a title for your flat page. This will appear on the breadcrumb trail (located right below the header menu) of your e-commerce site, such as *Homepage > Blog > **Cushion Bags***. Your chosen title will also assist in filtering. * **Content Type:** Choose the appropriate content type based on the content you intend to add in the next parameter. * **Content:** Edit your page content using either the HTML editor or Plain Text. Utilizing the rich HTML editor enables you to create a visually appealing layout and implement SEO practices effectively. * **Link (tr-tr), Link (en-en)**: Enter the desired link, which will be reflected as `domain/lorem-ipsum/`. For example, if `/lorem-ipsum/` is your chosen link, it will be integrated into your e-commerce site accordingly. * **Template:** Insert the preferred template provided by the authorized project manager of your brand. In most cases, the default flat page template would be `flatpage/index.html`. * **Authentication:** Indicate your authentication preference as Yes/No. Please select "Yes" if users are expected to log in to access this specific flat page URL on your e-commerce site. * **Site:** Choose the appropriate site for your flat page. * After filling out the mandatory fields, click **Save**.

# How to Manage Custom/Campaign Pages in Omnitron? Custom/Campaign Pages are a great tool for creating a customized page structure by combining collections. Users can list collection items with different variant types and add custom SEO content, along with banner images that have internal links to direct users to another page URLs. This will eventually boost the e-commerce site's conversion rate. ## Step 1: Access to Omnitron * Access the **Omnitron** panel through your URL. * Insert your granted *Username* and *Password*, and click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FQnfNjX72in5Qcy4LZzGH%2Fimage.png?alt=media\&token=7777dd02-19d8-44cd-af84-d258bc07ab2b) ## Step 2: Navigate to Custom/Campaign Page * Follow through the **Sales Channels** > **Content Management** sidebar and click the **Custom/Campaign Pages**.

## Step 3: Filtering Custom/Campaign Pages * On the Custom/Campaign page, the filter panel and the list of existing special pages are displayed. * Users can filter the special pages based on *Page Name, Page Url, Page Template, Collection, Status, First & Last Creation Date, First & Last Updated Date*. The selected filters will be displayed in the active filters row.

## Step 4: Creating a New Custom Page * To create a new custom page, click the **+ New Custom Page** button located in the upper-right corner.

* Complete the form by filling in the required fields, including: * **Page Name:** Provide the name of the page. Once active, it will appear as a breadcrumb, for example, 'homepage > example page name', positioned to the right below the header menu. * **Page URL**: Input the URL extension of the page. Additional URL fields should be created for multiple language options. Separate URLs are required for each language. * **Page Template:** If you prefer to use a template other than the default, specify the file folder containing the HTML code of the widget to be used. This determination is made by the project manager; please consult them for further details. * **Banner:** Upload the image to be displayed at the top of the page. * **Mobile Banner:** Upload the image to be displayed at the top of the page on the mobile application. * **Video Embedded Code:** Optionally, insert the video’s embed link from YouTube. * **Banner URL:** Enter the URL extension of the page to be displayed upon clicking the banner. This will help increase conversions and enhance the average time spent on the e-commerce website. * **Select Collection:** Choose a collection from the list previously created in the *Products and Catalogs* module to display it on the campaign page. Detailed instructions for creating collections can be found in the [Collections](/tutorials/omnitron/products-and-catalogs/how-to-create-and-manage-collections-in-omnitron) document. * **List Variants Type:** Select the default variant type to be displayed on that specific page. * **Description:** Provide the description to be displayed to the user. * **Status:** Specify the page’s active/passive status. Selecting "Passive" means the page will not be displayed to the user. * After filling out the necessary fields, click **Save**.

## Step 5: Updating Custom Pages * To update a custom page, click on the row of an existing custom page in the list. You will then be directed to the detail page where you can make the necessary changes. Finally, click **Save** to apply the changes.

# How to Manage Navigations/Menus in Omnitron? Each website will have a header menu for desktop and hamburger menu for mobile for navigation purposes. The Navigation/Menu functionality of Omnitron enables you to establish an ordered tree structure for menu items, assign names to them, and link them to their respective pages. Additionally, you have the option to apply background colors and text styles if desired. For further instructions on execution, please refer to this article. ## Step 1: Access to Omnitron * Access the **Omnitron** panel through your URL. * Insert your granted *Username* and *Password*, and click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FQnfNjX72in5Qcy4LZzGH%2Fimage.png?alt=media\&token=7777dd02-19d8-44cd-af84-d258bc07ab2b) ## Step 2: Navigate to Navigation/Menu Page * Navigate to **Sales Channels > Content Management > Navigation/Menu** from the sidebar.

## Step 3: Adding a New Navigation/Menu The navigation menu can contain multiple sub-menus, but initially, you should create the Main Menu. To do this: * Click on "Add Main Menu". * Enter the Menu Name and URL. * Click "Save".

After creating the Main Menu, you can proceed to create sub-menus and their corresponding inner menus. Follow these steps: * Click the "+" icon next to the menu item. * Enter the Menu Name and Menu URL. * Click "Save".

* Successfully adding each menu item will result in the menu tree displayed as follows:

* The menu item tree can be modified by dragging and dropping the respective row. The blue outline, as shown in the screenshot, will indicate which menu items will be moved as submenus or interchanged within the main menus.

## Step 3: Edit the Menus According to the schema integrated into the Navigation/Menu Page, specific functions may vary depending on the project. However, several default settings can be applied for editing the menus. Click on the pen icon next to the menu item to proceed with the edits. * **Menu Name:** You can change the menu name here. * **Menu URL:** Add/Edit the desired link of that respective menu item. * **Navigation Slider Images:** You can add visual internal links to the navigation menu from here, those will only shown on desktop. * **Desktop Menu Features:** You will be able to change the text weight, text color, background color of the menu and underline the text. * As a plus, you will be able to request such functionalities as; 1. **Boolean “No Follow” Tag:** Enabling the Boolean "No follow" tag will instruct search engines not to follow your menu link. This means that the link will not contribute to the distribution of link juice. This strategy is crucial for SEO purposes. For instance, if there are already one or more homepage links on the same page, an additional homepage link may not necessarily need to be indexed by Google. To minimize this, you can opt for the header menu items URL. 2. **Image Variations as Sub Content**: Using different image variations allows you to create column-based image URLs. This feature proves particularly beneficial for catalog characteristics links, such as "/shoes/80s-fashion" or "/sofas/bubble-fashion". 3. **Boolean Show on Mobile Menu:** This feature allows you to specify whether the header menu items should be included or excluded from the hamburger menu on mobile devices. By default, there will be synchronization between them, ensuring consistency across both menu types.

# How to Manage Mailing Templates in Omnitron? This tutorial provides step-by-step instructions for managing Mailing Templates in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Mailing Template Page * Follow the **Sales Channels > Content Management** sidebar and click the **Mailing Templates** page.

* This page displays mailing templates for management purposes.

## Step 3: Adding Mailing Templates * To add a new mailing template , click the **+ New Mailing Templates** button. Complete the form by filling in the following fields: * **Name:** Select one of the default email templates, e.g., for sending a welcome email upon user registration. * **Status:** Select whether the template is active or inactive. * **Language:** Select the language for the mailing template from the options available in Omnitron, aligning with local languages. * **Content:** Input the email content in HTML format. * Once the relevant fields are completed, click the **Save** button.

## Step 4: Dynamic Mailing Templates for Order Cancellations The `Dynamic_Cancel_Mail_Template_Url` in the `api/v1/dynamic setting` serves to create a custom mail template for order cancellations based on primary keys representing cancellation reasons. It is essential to define the `Dynamic_Cancel_Mail_Template_Url` with the CancellationReason primary key as the key and the corresponding template path as the value. The process follows these rules: 1. The system checks the cancellation reasons associated with the primary keys of the order items that trigger the email. If a custom template is specified in `Dynamic_Cancel_Mail_Template_Url`, that template takes precedence. 2. In case there is no match within the definitions of `Dynamic_Cancel_Mail_Template_Url`, the system retrieves the template information specified in the channel's configuration details under `cancel_mail_template_url`. 3. If, even then, no cancel\_mail\_template\_url is found, the system resorts to reading the template value in the `Cancel_Mail_Template_Url` setting. 4. In scenarios where the Cancellation Reasons for the canceled order items vary, the system selects the template based on the first one specified in `Dynamic_Cancel_Mail_Template_Url`. # How to Configure Merchant Feed Adapter? This document provides a comprehensive guide for configuring and managing **Merchant Feed Adapters** within the **Omnitron**, an essential tool for exporting structured product data to external platforms. Merchant feeds are used to display products on comparison shopping engines, search engines, or affiliate platforms—allowing users to view product details, prices, and availability without visiting the brand’s actual e-commerce site. To support this, Omnitron enables merchants to generate and customize **XML feed files** based on their own schema requirements, language preferences, pricing lists, and filtering logic. Whether you are creating a feed for a single market or managing a complex multi-language, multi-region catalog, this tutorial walks you through: * Setting up new feed adapters through the Omnitron * Structuring feed content using `schema_data` * Mapping product attributes with flexible rule-based logic * Filtering the feed by SKU or base code using uploaded files * Managing multiple feeds by language and pricing combinations * Manually or automatically triggering feed generation * Accessing the final XML output via a generated file URL By the end of this guide, you will be able to confidently configure and launch feeds that are optimized for your sales channels, meet third-party specifications, and scale across multiple locales with ease. ## Add Merchant Feed Adapter in Omnitron To begin creating a Google Merchant Feed Adapter, follow the steps below. ### Navigate to the Feed Adapter Section {% stepper %} {% step %} Go to **Sales Channels > Content Management > Google Merchant Feed Adapter.** {% endstep %} {% step %} From this page, you can **view existing adapters**, **edit them**, or **add new ones**. {% endstep %} {% step %} Click on **“+ New Google Merchant Feed Adapter”** to open the adapter creation form.

{% endstep %} {% endstepper %} ### Fill in Basic Adapter Settings {% stepper %} {% step %} At the top of the page, you’ll see a set of core fields to define the adapter:

Field	Description
Name	A unique name for the feed adapter. This is used to distinguish between different feeds, especially in multi-language or multi-region setups. Example: `insider`, `google_feed_en`, `feed_ar_uae`
Adapter Type	Defines which adapter class will handle feed generation. Select `base` unless your project includes a custom implementation.
Status	Set this to `Active` to allow the adapter to be used during scheduled or manual feed generation. If set to `Passive`, it will be ignored by automatic processes.
One time	Check this box if you want the feed to only be triggered manually. This disables scheduled executions.
File URL	This field is automatically filled after feed generation. It provides a direct link for the generated XML file.
Choose File	(Optional) Upload a filter file in `.csv` or `.xls` format. The system will convert it to base64. The file should contain `sku` or `base_code` headers to restrict which products are included in the feed.

{% endstep %} {% step %} If you're generating feeds for multiple markets, it's a best practice to name the adapter accordingly (e.g., `google_feed_ar_ksa`) and define separate adapters per language/price list. {% endstep %} {% endstepper %} ### Configure Feed Schema (`config` field) Once the basic adapter settings are filled, the next critical step is configuring how the feed will be generated. This is done through the **`config` field**, which is a JSON object that defines the structure, behavior, and formatting rules for the XML file that will be generated. This configuration directly determines: * Which product attributes are included * What the output file is named * How images, categories, and language-specific values are handled * Whether out-of-stock products are shown * How visual content (like cropped images or additional images) is formatted #### Example Configuration: ```json { "chunk_size": 100, "schema_data": [ { "tag": "description", "attr_type": null }, { "tag": "g:gender", "attr_type": null, "default_value": "Default" }, { "tag": "title", "attr_type": null, "default_value": "title" } ], "EXTRA_IMAGES": true, "feed_filename": "insider/insider-feed_en.xml", "IS_ALL_SMALL_IMAGE": true, "url_attribute_data": null, "THUMBNAIL_CROP_TYPE": "Center", "extra_image_configs": [ { "tag_name": "g:image_link", "tag_option": { "crop": "Center", "width": 1080, "height": 1080 } } ], "IS_REQUIRED_SMALL_IMAGE": true, "category_attribute_data": [ "category_name_en-us" ], "include_stock_out_products": true, "price_list_id": 1, "stock_list_id": 3, "category_name_translate_key": "category_name_en-us", "MERCHANT_FEED_VISILABS_IMAGE_TAG": "g:additional_image_link", "MERCHANT_FEED_VISILABS_IMAGE_SIZE": { "crop": "Center", "width": 1080, "height": 1080 }, "CUSTOM_CATEGORY_MAPPING_ENABLED": true, "category_ids_dict": { "00010001": "custom category id" }, "category_dict": { "00010001": "custom category name" } } ``` #### Explanation of Key Fields:

Field	Description
`chunk_size`	Number of products processed per task run. Useful for optimizing large feeds. Must be greater than 0 and less than 1000. Setting a value outside this range may result in validation errors or failed feed generation.
`schema_data`	List of tags to be included in the feed. Each item defines one XML tag. Optionally include a `default_value` if the mapped attribute is missing.
`EXTRA_IMAGES`	Enables inclusion of first product image in the feed.
`feed_filename`	Path + filename for the output feed. This should be unique per language/market.
`IS_ALL_SMALL_IMAGE`	Ensures small image versions are used where applicable.
`url_attribute_data`	Usually null unless custom logic is used for URL mapping.
`THUMBNAIL_CROP_TYPE`	Cropping strategy for image thumbnails. Options may include `Center`, `Top`, `Bottom`, etc.
`extra_image_configs`	Defines how extra images (e.g., `g:image_link`) should be rendered, including size and crop strategy.
`IS_REQUIRED_SMALL_IMAGE`	Forces the presence of small-sized images in the feed.
`category_attribute_data`	List of category-related product attributes. These are used when building the product's category tree or name.
`include_stock_out_products`	If `true`, includes products that are out of stock.
`price_list_id` / `stock_list_id`	Used to pull price and stock info from specific price/stock lists configured in Omnitron. Useful for multi-market feeds.
`category_name_translate_key`	Attribute key used to get the translated category name (e.g., for localized feeds).
`MERCHANT_FEED_VISILABS_IMAGE_TAG`	Specifies the tag under which additional images for Visilabs integration are exported.
`MERCHANT_FEED_VISILABS_IMAGE_SIZE`	Image dimensions and crop settings used for Visilabs-specific image feeds.
`CUSTOM_CATEGORY_MAPPING_ENABLED`	Enables manual category mapping by path. If set to `true`, feed category values can be overridden using `category_ids_dict` and `category_dict`.
`category_ids_dict`	Dictionary to override `<category_code>` based on category `path` value. Format: `"{path}": "custom_code_value"` See: Getting category path information
`category_dict`	Dictionary to override `<category_name>` based on category `path` value. Format: `"{path}": "custom_name_value"`
`duplicate_fields`	Copies the value of an existing tag into a new tag under a different name. Accepts a list of `{"source": ..., "target": ...}` objects. The duplication runs after all other tags are generated, so the target always mirrors the final value of the source. Example: `[{"source": "g:sale_price", "target": "sale_price"}]`

### Price and Discount Configuration By default, the feed derives its price tags from the product's price and retail (list) price: * `g:price` → the **retail/list price** (the "struck-through" price) when the product has a discount. * `g:sale_price` → the **actual selling price**. When the product has no discount (no retail price, or price ≥ retail price), only `g:price` is written. You can fine-tune this behavior with the flags below—all of them are optional and belong in the same `config` JSON object.

Field	Description
`CONCAT_PRICE_CURRENCY`	Boolean, default `true`. Appends the currency code to every price value (e.g. `995.00 TRY`). Set to `false` to output the numeric value only (e.g. `995.00`).
`ALWAYS_INCLUDE_SALE_PRICE`	Boolean, default `false`. When a product has no discount, still emits an empty `<g:sale_price>` tag instead of omitting it. Useful for platforms that require the tag to always be present.
`SALE_PRICE_WITH_BASKET_OFFERS`	Boolean, default `false`. Overwrites `g:sale_price` with the discounted price of the product's single-unit (quantity = 1) basket offer, so the sale price reflects the basket promotion. Requires the `OFFER_SHOW_LISTING_KWARGS` dynamic setting to be enabled (see hint below). Note: this replaces the real sale price—use `INCLUDE_BASKET_OFFER_PRICE` instead if you need to keep both.
`INCLUDE_BASKET_OFFER_PRICE`	Boolean, default `false`. Emits an additional `<g:basket_price>` tag containing the discounted price of the product's single-unit (quantity = 1) basket offer, without touching `g:price` or `g:sale_price`. The tag is only written when the product actually has a matching offer. Requires the `OFFER_SHOW_LISTING_KWARGS` dynamic setting to be enabled.
`add_sale_price_as_price`	Boolean, default `false`. If a sale price exists, moves it into `g:price` and drops `g:sale_price`, so the feed exposes a single (discounted) price.

#### Showing three separate prices (list, sale, and basket-offer price) A common requirement is to expose the struck-through price, the sale price, **and** a separate basket-offer price at the same time. Enable `INCLUDE_BASKET_OFFER_PRICE` and leave `SALE_PRICE_WITH_BASKET_OFFERS` off: ```json { "INCLUDE_BASKET_OFFER_PRICE": true } ``` For a product with a list price of 2095.00, a sale price of 995.00, and a single-unit basket offer of 696.50, the feed then outputs: ```xml 2095.00 TRY 995.00 TRY 696.50 TRY ``` {% hint style="info" %} `SALE_PRICE_WITH_BASKET_OFFERS` and `INCLUDE_BASKET_OFFER_PRICE` are independent. Enabling `SALE_PRICE_WITH_BASKET_OFFERS` overwrites `g:sale_price` with the offer price (losing the real sale price), whereas `INCLUDE_BASKET_OFFER_PRICE` keeps `g:sale_price` intact and adds the offer price as a separate `g:basket_price` tag. There is no need to also duplicate the sale price via `duplicate_fields` when you use `INCLUDE_BASKET_OFFER_PRICE`. {% endhint %} {% hint style="warning" %} Both basket-offer flags rely on the offer's listing data (`discounted_total_price`), which is only exposed when the **`OFFER_SHOW_LISTING_KWARGS`** dynamic setting is enabled for the project. If that setting is off, the basket-offer price will not appear even when the flag is set. {% endhint %} ### Upload Filter Files (Optional) To include only specific products in the feed, you can upload a filter file—**CSV** or **XLS**—containing product identifiers. Filter files help reduce feed size or tailor feeds to campaign-specific product lists. For example, if you want to export only a selection of SKUs for a seasonal collection, use a filter. {% stepper %} {% step %} Go to the **Choose File** field in the adapter form. {% endstep %} {% step %} Upload a `.csv` or `.xls` file. {% endstep %} {% step %} File must contain a `sku` or `base_code` column. {% hint style="warning" %} If the file format or header is incorrect, the system will return an error:\ `No valid header found in file headers.` {% endhint %} {% endstep %} {% step %} You can also combine the uploaded filter file with additional config-based filters via the `filter_arguments` key in the config: ```json "filter_arguments": { "is_listable": true } ``` This way, only listable products **that also match the uploaded SKUs** are included in the feed. {% endstep %} {% endstepper %} ### Save and Generate the Feed Once you’ve completed the **Basic Adapter Settings**, added your **config JSON**, and optionally uploaded a **filter file**, it’s time to save the adapter: * Click **“Save”.** * If your `config` field is valid and includes a `schema_data` section, the page will reload and reveal a new section called **Mapper Settings**. * This section allows you to define the transformation logic for each XML tag listed in your `schema_data`. {% hint style="warning" %} If you skip the config or forget to include `schema_data`, the Mapper Settings section will **not** be displayed. {% endhint %} ## Attribute Mapping with Rules and Actions After configuring your feed schema using the `config` field, the next crucial step is to **define how each XML field (tag) retrieves its data** from the product catalog. This is done using the **Mapper Settings** section in the adapter interface. Each XML tag listed under `schema_data` must have a corresponding **mapper**, which includes: * A **rule** that determines when the mapping should be applied * An **action** that defines how to fetch or transform the data Together, these enable complex conditional logic, localization, and formatting for your feeds—ensuring data consistency and compatibility with platforms like Google Merchant Center.

Each mapper is a JSON object with two main parts: #### 1. `rule`: *When should this mapping be applied?* Defines the condition that must be true for the action to run. #### 2. `action`: *How should the value be retrieved or constructed?* Specifies how to fetch, format, or combine values. ### Rule Types (When)

Rule Type	Description
`always`	Always applies the action, regardless of product data
`attributeexists`	Applies only if a specific attribute exists on the product
`multiattributeexists`	Checks if multiple attributes exist (can be all or any)
`query`	Applies if a certain query condition is met (advanced)
`in_dict`	Checks if a field exists in a predefined dictionary

### Action Types (How)

Action Type	Description
`attrgetter`	Retrieves a single attribute value
`attrformatter`	Formats an attribute using a custom template
`multiattrformatter`	Combines multiple attributes into a single string
`outputdict`	Uses a dictionary to map internal values to output values
`stdout`	Outputs a static value (useful for fixed tags)

#### Basic Example: Simple Attribute Getter This mapper fetches the `description` field from the product data and maps it directly to the `` XML tag. ```json { "rule": { "rule_type": "always" }, "action": { "action_type": "attrgetter", "action_kwargs": { "input_key": "description" } } } ``` #### Example: Formatting Gender Using Output Dictionary If your internal values for gender are stored as `M`, `F`, and `U`, but Google requires `male`, `female`, and `unisex`, use this: ```json { "rule": { "rule_type": "always" }, "action": { "action_type": "outputdict", "action_kwargs": { "input_key": "gender", "mapping_dict": { "M": "male", "F": "female", "U": "unisex" } } } } ``` #### Combine Multiple Attributes Use this action when you need to generate a value from multiple fields (e.g., combining brand + title + size). ```json { "rule": { "rule_type": "always" }, "action": { "action_type": "multiattrformatter", "action_kwargs": { "input_keys": ["brand", "title", "size"], "format_str": "{0} - {1} ({2})", "delimiter": " " } } } ``` **Output Example:** `Nike - Air Max (42)` ### Handling Localized Fields When generating feeds in **multiple languages**, you need to retrieve the correct **language-specific values** from product data. The format of your `input_key` inside the **mapper's `action_kwargs`** will vary depending on: * Whether the feed is for the **default language** * Whether the field is a **text** or **dropdown** attribute #### For Default Language Feeds If you're generating a feed in your **default language**, product attribute values can be accessed using this structure: ```json "input_key": "attributes__{{attr_code}}" ``` This directly pulls the attribute from the product's default data. #### For Localized Feeds (Non-Default Languages) For other languages (e.g., Arabic, Turkish, English (US)), you need to reference **localized fields**. The structure depends on the **type of attribute**. #### For text fields: Use `localized_attributes` for retrieving translated text fields such as `title`, `description`, or `long_name`. ***Pattern:*** ``` localized_attributes__{{language_code}}__{{attribute_code}} ``` ***Example:*** ```json [ { "rule": { "rule_type": "always", "rule_kwargs": {} }, "action": { "action_type": "attrgetter", "action_kwargs": { "input_key": "localized_attributes__en-us__l_name" } }, "shared_kwargs": {} } ] ``` #### For dropdown fields: For dropdown attributes that have translated options (e.g., brand, material, gender), use the `attributes_kwargs` structure to access the translated label. ***Pattern:*** ``` attributes_kwargs__{{attribute_code}}___translations__{{language_code}}__label ``` ***Example:*** ```json [ { "rule": { "rule_type": "always", "rule_kwargs": {} }, "action": { "action_type": "attrgetter", "action_kwargs": { "input_key": "attributes_kwargs__brand___translations__ar__label" } }, "shared_kwargs": {} } ] ``` {% hint style="warning" %} Use the appropriate `language_code` (e.g., `en`, `ar`, `tr`) depending on the feed’s target market. {% endhint %} ## Triggering and Monitoring Feed Generation Once your Merchant Feed Adapter is configured and saved, it's time to **generate the actual XML feed file**. Omnitron provides both **automated** and **manual** triggering methods for this purpose. You can also **track the status** of the generation process and retrieve the final file URL programmatically. **Automatic vs. Manual Triggering:**

Trigger Type	Description
Automatic (Scheduled)	If the adapter's `One Time` checkbox is unchecked, Omnitron will automatically run the feed generation task every 3 hours.
Manual (One-Time)	If `One Time` is checked, the feed must be triggered manually via the API or Omnitron UI. This is useful for test feeds, campaign-based feeds, or ad-hoc exports.

### Trigger Feed Generation Manually (API) To manually trigger feed generation for a specific adapter: #### **Endpoint:** ```bash POST /api/v1/remote/1/product_merchant_feeds/{adapter_pk}/trigger_task/ ``` Replace `{adapter_pk}` with the ID of the adapter you want to trigger. #### Example Request: ```bash curl --location --request POST 'https://your-commerce-url/api/v1/remote/1/product_merchant_feeds/268/trigger_task/' \ --header 'Authorization: Token your_token_here' ``` #### Example Response ```json { "cache_key": "6c27bc5a8f06442f96044302e6168d7a" } ``` ### Monitor Progress of Feed Generation You can track the progress of the feed task using the returned `cache_key`. #### Endpoint: ```bash GET /api/v1/remote/1/product_merchant_feeds/{adapter_pk}/trigger_status/?cache_key={cache_key} ``` #### Example Request: ```bash curl --location 'https://your-commerce-url/api/v1/remote/1/product_merchant_feeds/268/trigger_status/?cache_key=6c27bc5a8f06442f96044302e6168d7a' \ --header 'Authorization: Token your_token_here' ``` #### Example Response: ```json { "completed_tasks": 1, "data": [ { "progress": [1, 1], "completed": true, "chunk_count": 1 } ], "progress_count": 1 } ``` {% hint style="warning" %} **`progress: [x, y]`** represents **x completed chunks out of y total**. You can calculate progress percentage as:\ `(x / y) * 100` {% endhint %} ### Get Feed File URL Once the task is completed, the file will be available at the adapter’s detail endpoint. #### Endpoint: ```bash GET /api/v1/remote/1/product_merchant_feeds/{adapter_pk}/ ``` #### Example Request: ```bash curl --location 'https://your-commerce-url/api/v1/remote/1/product_merchant_feeds/268/' \ --header 'Authorization: Token your_token_here' ``` #### Example Response: ```json { ... "file_url": "https://cdn.akinoncloud.com/google/insider-feed_en.xml" } ``` You can now use this file URL in your Google Merchant Center, comparison shopping platforms, or campaign tracking tools. ### Error Handling If a feed task is already in progress and a new one is triggered: #### Example Response: ```json { "non_field_errors": "Google Merchant Feed task is already running. Please wait until the current task is completed before starting a new one.", "error_code": "google_merchant_feed_adapter_100_2" } ``` {% hint style="warning" %} Always check if a task is running before triggering a new one to avoid queue conflicts. {% endhint %} ### Triggering Feed Manually via Omnitron In addition to using API calls, you can also **manually trigger feed generation directly from the Omnitron interface**—with just a few clicks. {% stepper %} {% step %} **Select the Feed Adapter(s):** Use the checkbox on the left to select the adapter(s) you want to run. You can select one or multiple rows. {% endstep %} {% step %} **Open the "Select Action" Dropdown:** At the top of the list, open the **Select Action** dropdown. {% endstep %} {% step %} **Click “Trigger Task with Selected Items”:** This option will immediately initiate the feed generation task for the selected adapters.

{% endstep %} {% step %} **Click “Apply”:** The task will be queued and executed via Celery. You can monitor the task’s status using the API or check the file URL once generation is complete.

{% endstep %} {% endstepper %} ## Feed URL Usage Once the feed generation is complete, the XML file becomes accessible via the provided `file_url`.\ For example, you can access the generated feed directly at: {% embed url="" %}

You can now use this URL to upload the feed to Google Merchant Center or share it with external platforms that support scheduled product feed imports. {% hint style="warning" %} This URL remains valid as long as the feed is not deleted or regenerated under a different filename. {% endhint %} # Store Management # How to Manage Stores in Omnitron? This tutorial provides step-by-step instructions for managing stores in Omnitron. ## Step 1: Access to Omnitron * Access the **Omnitron** panel through your URL. * Insert your granted *Username* and *Password*, and click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FQnfNjX72in5Qcy4LZzGH%2Fimage.png?alt=media\&token=7777dd02-19d8-44cd-af84-d258bc07ab2b) ## Step 2: Navigate to Stores Page * Navigate to the Omnitron platform and log into your account. * Follow the **Sales Channels** > **Store Management** sidebar and click the **Stores** page.

## Step 3: Filtering Stores * On the Stores page, the filter panel and the list of existing stores are displayed. * You can filter the stores based on Store Name, ERP code, etc. The selected filters are displayed in the active filters row. ## Step 4: Creating a New Store To create a new custom page, click the **+ New Store** button located in the upper-right corner.

* **Store Name:** Enter the name of the store which will be displayed to users. * **ERP Code:** Enter the code specified for the store within the client’s own ERP software. * **Country, City, Township, District:** Select these from the displayed drop-down menu. * **Address:** Enter the full address of the store. * **Phone:** Enter the store’s phone number. * **Fax**: Enter the store’s phone number. * **Store Image:** Upload a store image by browsing the files on your computer. * **Work Hours:** Enter the work hours of the store for each day. * **Status**: Select the active/passive status of the store. * **Delivery from Store**: Select whether this store will be available among options to deliver from the store, regarding orders placed via the website. * **Store Type:** Select a store type that is defined in the backend. * **Channel**: Select the sales channel to which the store will be added. * **Sorting**: In storefront, you enter the order in which it will be displayed in the list. * **Coordinates:** Hold and slide the map indicator to mark the location of the map or manually enter the coordinates in the related fields. If the latter option is used, the map indicator is automatically moved to the specified location. Click **Save** after filling all necessary fields.

## Step 5: Add/Remove Buddy Stores Buddy stores are local businesses that have formed partnerships to support each other's operations. * Select buddy stores for the corresponding store by clicking the "**+**" button, where all the stores on the Omnitron are listed. * You will then see the selected buddy store in the data table above. * If necessary, you can remove it from the selected list by clicking the "**-**" button.

## Step 6: Add/Edit Store Page * To edit the store page, simply click on one of the existing store rows, make the desired changes as outlined above, and then click on the **Save** button.

# How to Manage Instore Store Employees in Omnitron? The Instore Store Management Page primarily displays a list of stores available under the brand. After bulk configuration is completed by the Project Associates, you will be able to manage it by changing passwords and adjusting the status of specific stores. ## Step 1: Access to Omnitron * Access the **Omnitron** panel through your URL. * Insert your granted *Username* and *Password*, and click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FQnfNjX72in5Qcy4LZzGH%2Fimage.png?alt=media\&token=7777dd02-19d8-44cd-af84-d258bc07ab2b) ## Step 2: Navigate to the Store Employees Page * Navigate to **Sales Channels > Content Management > Store Employees** from the menu.

## Step 3: Filtering the Store Employees * On the Store Employees page, the filter panel and the list of existing store employees are displayed. * You can filter the store on employee first name, employee email, store name and status. * The selected filters will be displayed in the active filters row.

## Step 4: Creating New Employee To create a new employee; * Click the “**+ New Employee**” button located in the upper-right corner. * **Employee First Name:** Insert the First Name. * **Employee Last Name:** Insert the Last Name. * **Employee Email:** Insert the corporate e-mail address of the new employee. * **Affiliated Store:** Insert the store assigned to the employee. * **Employee ID:** Insert the unique ID given to the employee * **Select Status:** Select the status as “Active” or “Passive”. * **Password:** Create a password manually or click “Generate Strong Password“ * **New Passport Again:** Insert the password chosen once again. * Click **Save**.

## Step 5: Changing the Password of the Employee If intended to renew the password of the existing employee; * Click on the **Change Password** button to set a new password. You can use the **Generate Strong Password** button for an automatically generated strong password. * After making changes, click the **Save** button to apply the modifications. The password for the store employee in the Instore application will be updated.

# How to Manage Instore Store from Omnitron? The Instore Store Management Page primarily displays a list of stores available under the brand. After bulk configuration is completed by the Project Associates, you will be able to manage it by changing passwords and adjusting the status of specific stores. ## Step 1: Access to Omnitron * Access the **Omnitron** panel through your URL. * Insert your granted *Username* and *Password*, and click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FQnfNjX72in5Qcy4LZzGH%2Fimage.png?alt=media\&token=7777dd02-19d8-44cd-af84-d258bc07ab2b) ## Step 2: Navigate to the Instore Store Management Page * Navigate to **Sales Channels > Content Management > Instore Store Management** from the menu. {% hint style="info" %} **Instore Store Management** cardbox appears only when the selected sales channel type is web. In other words, for shop-type of sales channels, this cardboard appears. {% endhint %}

## Step 3: Filtering On the In-Store Store Management page, you'll find both the filter panel and the list of existing stores.You can filter stores by Store Name, ERP code, and Status. The selected filters will be displayed in the Active Filters row.

## Step 4: Changing Instore Passwords To update the passwords of the stores: * Click on the "Change Password" button to set a new password. * You can utilize the "Generate Strong Password" button for an automatically generated strong password. * After making changes, click the "Save" button to apply the modifications. * The password for the store in the Instore application will be updated accordingly.

{% hint style="info" %} During the integration of stores via the ERP code, initial passwords are automatically generated. {% endhint %} ## Step 5: Editing the Instore Status * Click on the **Edit** button for the desired store. * Choose the desired status from the editable dropdown menu. * Click "Save" or "Cancel" to confirm or discard the changes. {% hint style="info" %} If the Instore status is updated as "Passive", the store will not be accessible on the instore systems. {% endhint %}

# How to Manage Store Delivery Points in Omnitron? To manage your store's delivery points effectively, follow these steps to navigate to the Store Delivery Points page, filter the store list, and update delivery points. ## Step 1: Navigate to Store Delivery Points Page * Navigate to the Omnitron platform and log into your account. * Follow the **Sales Channels** > **Store Management** sidebar and click the **Store Delivery Points** page.

## Step 2: Filtering Store Delivery Points Page * On the store delivery points page, the filter panel and the list of existing stores are displayed. * You can filter the stores based on Store Name, Store Type, ERP Code, Status etc. The selected filters are displayed in the active filters row.

## Step 3: Updating Store Delivery Points * To update delivery points for a store, locate the store in the list of existing stores and click on the row.

* You will be directed to the detail screen where you can make the necessary changes. * Select the district for the store’s delivery point: * Among the neighborhoods within this district, click on the **"+"** icon next to the desired neighborhood to select it, adding it to the selected neighborhood area. * To remove a neighborhood from the selected list, click the **"—"** icon. * After entering the Quota Settings (Maximum number of deliveries for the selected district), click the **"+ Save"** button.

# How to Manage Slots and Retail Store Groups? The **Slot & Retail Store Group** functionality in Omnitron allows users to configure and manage delivery hours for specific stores or groups based on defined time intervals and date ranges. By navigating through **Sales Channels > Store Management,** users can access a centralized interface to set up delivery schedules, assign quotas, and handle store group configurations efficiently. This document provides an overview of the following key processes: * Configuring delivery hours and managing quotas. * Creating and managing passive date ranges for store groups. * Grouping retail stores and assigning delivery slots. * Handling slot closures for processing. With these tools, users can tailor delivery schedules to meet operational requirements while ensuring a streamlined and organized approach to managing store delivery times. ## Store Delivery Times The **Store Delivery Times** feature in Omnitron allows users to configure and manage specific delivery schedules for stores, ensuring operational efficiency and customer satisfaction. By navigating to **Sales Channels > Store Management > Store Delivery Times**, users can define delivery hour intervals, set quotas, and manage availability for specific date ranges.

### Creating Store Delivery Times In the **Add/Edit Delivery Hours** form, the **Start-End Time**, **Disable Time (minutes)**, and **Quota** fields are filled in, and records are created by clicking the (+) icon. * **Start-End Time**: Represents the respective delivery hour intervals. * **Disable Time (min.)**: Indicates the last time the interval will be displayed in the store. For example, if the end time is 12:00 and the disable time is set to 15 minutes, this interval will no longer be visible in the store after 11:45. * **Quota**: Represents the maximum number of orders that can be accepted within the interval.

{% hint style="info" %} Different **Disable Time** or **Quota** values can be entered for the same time interval. The **Start Time** value cannot exceed the **End Time** value. {% endhint %} ### Selecting Store Delivery Hours for Date Ranges In the **Add/Remove Passive Date** form, users can create date ranges by entering the **Start Date** and **End Date** fields, selecting **Assigned Store Group**, and clicking the **+ NEW SLOT** button. * **Start-End Date**: Represents the desired specific date range. * Only one passive date can be created for an existing date range. For example, if a passive date already exists for **(02.03.2025 - 01.04.2025)**, a new passive date cannot be created for **(08.03.2025 - 07.06.2025)** because it overlaps with the existing range **(08.03.2025 - 01.04.2025)**. * **Assigned Store Group:** Refers to the group of stores that the delivery hours configuration will apply to.

Created passive dates automatically include inactive time intervals configured via the **Add/Edit Delivery Hours** form. Delivery hours can be added to the selected passive dates by clicking the **(+)** icon. Delivery hours activated for passive dates can be removed by clicking the **(-)** icon next to the relevant interval. Delivery hours with overlapping time intervals cannot be selected together for the same passive date. For instance, delivery hours with the intervals **(08:00 - 12:00)** and **(09:00 - 13:00)** cannot be selected simultaneously for a passive date because they both overlap with the interval **(09:00 - 12:00)**. Passive dates can be deactivated by clicking the **(-) Delete** button in the row displaying the respective date range. ## Retail Store Groups The **Retail Store Groups** feature in Omnitron allows users to efficiently manage and organize groups of stores. By navigating to **Sales Channels > Store Management > Retail Store Groups**, users can view and filter store groups, access detailed information, and create or modify groups as needed. {% hint style="info" %} **Retail Store Groups** cardbox appears only when the selected sales channel type is web. In other words, for *shop-type* of sales channels, this cardboard appears. {% endhint %}

The **Retail Store Groups List** displays the names, statuses, and slugs of retail store groups. The list can be filtered based on the stores included in the groups. For example, if stores A, B, and C belong to store group X, selecting A, B, or C in the **Stores** filter will display group X.

Clicking on a store group in the list opens the **Retail Store Group Details** page.

### Creating Retail Store Group In the **Retail Store Group** form, users can create or update store groups by filling in the fields and clicking **SAVE RETAIL STORE GROUP**. * **Name**: Represents the name of the retail store group. * **Status**: Represents the active/inactive status of the group. * **Slug**: Represents the slug of the group. * **All Stores:** Lists the available stores that can be added to the group. * **Added Stores**: Displays the stores already added to the group. This section organizes the stores by their locations and includes options to remove stores. {% hint style="info" %} A store can belong to only one group. {% endhint %}

## Assigning Delivery Hours (Slots) to Retail Store Groups The **Assigning Delivery Hours (Slots) to Retail Store Groups** functionality in Omnitron enables users to assign specific delivery hours to designated store groups. By navigating to **Sales Channels > Store Management > Marketplace Slots** (Assign Slots to Groups), users can configure time intervals for various store groups based on passive date ranges.

In the dropdown menu shown below, a Retail Store Group can be selected. After making a selection, time intervals can be configured for the selected Retail Store Group.

The **Selectable Slot** list displays available time intervals for the selected store group. The **Selected Slot** list displays the intervals already chosen. Selectable Slot - Time Ranges can be added by clicking the **(+)** icon. Selected Slot - Time Ranges can be removed by clicking the **(-)** icon.

The lists of Selectable and Selected Time Ranges within the Add/Remove Passive Date form contain the active Delivery Hours specific to their respective records. For instance, in the screenshot above, only the time intervals (09:00 - 12:00, 12:00 - 22:00) are displayed for the Passive Date (28.12.2024 - 28.01.2025) since these delivery hours have been activated. {% hint style="info" %} Multiple time intervals can be selected for a Retail Store Group. {% endhint %} ### Closing Store Delivery Hours (Slots) for Processing User can close slots for processing from a specific date for store groups or all stores using the following methods: * Create a retail store group for the stores whose slots will be closed. * Define the date ranges for closed slots in the **Add/Remove Passive Date** form. Do not select any delivery hours for the defined passive date. * Assign the stores to the created group. * Navigate to **Marketplace Slots (Assign Slots to Groups)** and select the passive date for the store group without selecting delivery hours.

As shown in the screenshot above, no delivery time has been selected within the Slot - Time Ranges for Retail Store Group 1. Consequently, slots for the stores belonging to Retail Store Group 1 will not appear on the shop page during the specified time ranges. ### Key Points * Multiple slots can be selected for a single Retail Store Group. Additionally, the same slot can be assigned to multiple Retail Store Groups. * Delivery Hours that are not assigned to any Retail Store Group on the Marketplace Slots (Assign Slots to Groups) page will be valid for all stores not assigned to any Retail Store Group during the relevant passive date range. * A store listed under Added Stores on the Retail Store Group Details page cannot be displayed under the All Stores list of a different Retail Store Group, regardless of the active/passive status of the group to which it belongs. * To disable slots for all stores, all Delivery Hours can be deleted from the Add/Edit Delivery Hours form on the Store Delivery Times page. * Instead of individually removing a specific time interval from multiple inactive dates, the quota can be set to 0. In this way, the relevant time interval can be disabled for all inactive dates with a single change, avoiding the need for it to be removed one by one. # Payment Management # How to Manage POS Integrations in Omnitron? This tutorial provides step-by-step instructions for managing Pos Integration in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FQnfNjX72in5Qcy4LZzGH%2Fimage.png?alt=media\&token=7777dd02-19d8-44cd-af84-d258bc07ab2b) ## Step 2: Navigate to POS Integration Page * Follow the **Sales Channels > Payment Management** sidebar and click the **Add/Edit POS Integration** page.

* This page displays the POS information that is essential for payment processes related to the selected sales channel. Users are granted the capability to modify existing POS Integrations or create new ones.

## Step 3: Adding New POS * To add a new POS, click the **+ New POS** button. Complete the form by filling in the following fields: * **Name:** Specify the name for this POS integration. * **Slug:** Define a unique slug for this POS integration. * **Gateway:** Select the payment gateway to be used for this POS integration. Completed third-party developments for gateways will be listed in the gateway dropdown. Depending on the schema selected in this field, the form dynamically adjusts to reveal new inputs. For instance, selecting "Masterpass" will unveil additional inputs according to that specific gateway. * **Resource URL:** Input the resource URL for this POS integration. * **3D Resource URL:** Input the 3D resource URL for this POS integration. * Once the relevant fields are completed, click the **Save** button.

# How to Manage Banks in Omnitron? This tutorial provides step-by-step instructions for managing Banks in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your *Username* and *Password*, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Banks Page * Follow the **Sales Channels > Payment Management** sidebar and click the **Banks** page.

* This page displays the available banks on the selected sales channel.

## Step 3: Adding New Bank * Users have the option to add banks individually by using the **+New Bank** button.

* Fill in the required fields, including: * **Name:** Specify the name for this bank. * **Slug:** Define a unique slug for this bank. * **Logo:** Upload an image for this bank. * Once the relevant fields are completed, click the **Save** button.

## Step 4: Adding New Bank with File * Users have the option to add banks in bulk by using the **+New Bank with File** button, allowing them to upload a .CSV or .XLS file. The file should contain essential information, including **slug** and **name**. To proceed, click the **+New Bank with File** button, select the relevant file, and observe the newly added banks as they populate in the list.

## Step 5: Adding a Bank Account for Wire Transfers * Upon adding a new bank, it is essential to formally include payment information for wire transfer transactions under the corresponding bank. To achieve this, users should click the **Add New Money Transfer Account** button. Subsequently, fields will be provided for the required information to be filled out.

* Complete the raw by filling in the following fields: * **PK:** Filling out this field is not required; it will be automatically generated after pressing the **Save** button. * **Add/Save Account Owner:** Enter the name of the IBAN holder. * **Slug:** Define a unique slug for this bank account. * **IBAN:** Input the IBAN value associated with the bank. * **Description:** Optionally, provide a description for the bank account. * **Order:** Specify the order of the bank account. * **Active/Passive:** Set the active or inactive status of the bank account. * After completing the relevant fields, click the **Save** button. # How to Manage Card Types in Omnitron? This tutorial provides step-by-step instructions for managing Card Types in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Card Types Page * Follow the **Sales Channels > Payment Management** sidebar and click the **Card Types** page.

* This page displays the available card types for payments on the selected sales channel.

## Step 3: Adding Card Type * To add or edit a card type, click the **+ New Card Type** button or the name of any card type on the list. This action will direct you to the **Add/Edit Card Type** form, which presents fields for Name, Slug, and Logo. Existing card types can also be edited using this form. * **Name:** Specify the name for this card type. * **Slug:** Define a unique slug for this card type. * **Logo:** Upload an image for this card type. * Once the relevant fields are completed, click the **Save** button.

# How to Manage Payment Options in Omnitron? This tutorial provides step-by-step instructions for managing Payment Options in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Payment Options Page * Follow the **Sales Channels > Payment Management** sidebar and click the **Payment Options** page.

* This page displays the available payment options for the selected sales channel. The listed payment options can be filtered based on Slug, Name, Status, and Payment Option values. Users have the option to add a new payment option by clicking the **+New Payment Option** button.

{% hint style="info" %} The credit card payment option is singular, allowing only one instance. {% endhint %} ## Step 3: Adding Payment Option * To add or edit a payment option, either click the **+New Payment Option** button or the name of any payment option on the list. This action will direct you to the **Add/Edit Payment Option** form, where you can modify the details. The form presents fields such as Payment Type, Payment Option Name, Payment Option Slug, Priority, Config, and Status. Existing payment options can also be edited using this form. * **Payment Type:** Select the payment option to be configured. * **Name:** Specify the name for this payment option. * **Slug:** Define a unique slug for this payment option. * **Priority:** Set the priority for this payment option among others. * **Config:** Configure rules for this payment option. * **Status:** Set the Active/Passive status for this payment option. * Once the relevant fields are completed, click the **Save** button.

# How to Manage Card Settings in Omnitron? This tutorial provides step-by-step instructions for managing Card Settings in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Card Settings Page * Follow the **Sales Channels > Payment Management** sidebar and click the **Card Settings** page.

* This page displays the available card settings for payments on the selected sales channel. The listed card settings can be filtered based on Slug, Name, Bank, Payment Type, Card Type, Cash, Payment by Installments, 3D Payment, and Commercial Card values.

## Step 3: Adding Card Settings * To add a new card setting, click on the **+ New Card Setting** button or the name of any card setting in the list to access the Add/Edit Card Setting form. The displayed form dynamically changes based on whether you are adding or editing a card setting. * The Add Card Setting form presents fields such as Card Name, Slug, Single Payment POS Infrastructure, Installments POS Infrastructure, 3D POS Infrastructure, Card Payment Type, Card Type, Bank, and Commercial Card. Additionally, the Edit Card Setting form includes fields for Currencies, Interest Commission Rates, and Card BINs. * On the Add/Edit Card Settings page, users can configure POS infrastructure with currencies and BIN numbers. The required fields to be filled in include: * **Card Name:** Specify the name for this card. * **Slug:** Define a unique slug for this card. * **Single Payment POS Infrastructure:** Select the POS infrastructure for single payment processes with this card. * **Installments POS Infrastructure:** Select the POS infrastructure for payments by installment with this card. * After completing the relevant fields, click the **Save** button.

* Users have the option to select the POS based on the currency used. In a shop with multiple currencies accepted for payment, options for Single Payment, Installment, and 3D POS Infrastructure are provided. Users have the ability to input settings for multiple currencies. * Once the currency and POS-related inputs have been filled in, click the **Save** button to finalize the configuration.

## Step 4: Adding New Commission Rate Linked to the POS * To introduce a new commission rate, begin by clicking the **Add New Commission Rate** button. Subsequently, fill in the fields for Expiration Number, Expiration Definition, Expiration Difference Rate (%), Min Limit, Max Limit, and specify the Active/Passive status. It's important to note that the pk value should remain unchanged during the editing process.

{% hint style="warning" %} If you want to set minimum and/or maximum basket amount limits for installment options, make sure to define the `basket_amount` filter in the dynamic `INSTALLMENT_FILTERS` setting in Commerce. Without this filter, the validation based on basket amount will not work. For detailed information, please refer to [Installment Filters](https://docs.akinon.com/tutorials/omnitron/sales-channels/payment-management/spaces/lQinVPnOffBiOp126ldR/pages/ufqWx7BjiprXrNvTVelW#id-7.-basket-amount-filter) documentation.

{% endhint %} ## Step 5: Adding the Bin Number Linked to the POS * At the bottom of the page, a list displaying the added BIN numbers linked to the POS is available. This list provides information on BIN numbers associated with this card. The determination of the card setting for credit/debit card payments is based on the assigned card setting for the BIN value of the respective card. * By clicking the **Add BIN Number** button, users can add a single BIN number. * By clicking the **Add Bulk BIN Number** button, users can add bulk BIN numbers through a file. * The .CSV file used for bulk addition should include the bin\_number parameter.

# How to Manage Checkout Providers in Omnitron? This tutorial provides step-by-step instructions for managing Checkout Provider in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Orders Page * Follow the **Sales Channels > Payment Management** sidebar and click the **Checkout Provider** page.

* This page displays checkout providers (such as Akifast and third-party applications) for management purposes. The listed checkout providers can be filtered based on their Name and Slug values.

## Step 3: Adding Checkout Provider * To add a new provider, click the **+ New Checkout Provider** button. Complete the form by filling in the following fields: * **Name:** Specify the name for this checkout provider. * **Priority:** Assign the priority value for this checkout provider. * **Slug:** Define a unique slug for this checkout provider. * **Config:** Enter configuration details, including authorization information, in JSON format. (Parameters will be provided by the Akifast team.) * **Sample Config:** ``` {"auth":{"password":"password","oauth_resource_url":"https://oauth.akifast.com/","merchant_id":"merchant_id","oauth_client_secret":"akinon_oauth_client_secret"}} ``` * **Status:** Set the Active/Passive status for this checkout provider. * **Resource URL:** Provide the resource URL associated with this checkout provider. * **Gateway:** Currently, this field offers the "Akifast" option, which is embedded in the code. * **Translations:** Enter translations in JSON format. * Once you have filled in the relevant fields, click the **Save** button.

# Category Management # How to Automatically Assign Category Mapping Rules in Omnitron? This tutorial provides step-by-step instructions for automatically assigning rules for category mapping operations in Omnitron. ## Step 1: Access to Omnitron * Get access to the **Omnitron** panel. * Enter your *Username* and *Password*, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Category Mapping Page * Follow the **Products and Catalogs > Catalogs > Category Tree** or **Sales Channels > Category Management** steps and click on the **Auto Assign Rules** button to reach the **Category Mapping** page. * *Category Mapping* is used for automatically assigning the category node to products for related Sales Channel. * *Category Mapping* action can be taken for both marketplaces and web-type of sales channels. The path may change as above depending on the sales channel where the action will be taken.

*Auto Assign Rules* button, following **Products and Catalogs > Catalogs > Category Tree** steps

*Auto Assign Rules* button, following **Sales Channels > Category Management** steps

## Step 3: View Category Mapping Page * By clicking on the **Auto Assign Rules**, the **Category Mapping** page can be seen. * Category Mapping page includes two different tabs, * *Category to Category* tab * In which different categories from different catalogs can be mapped directly. * *Rules (Product to Category)* tab * In which rule-based product to category mapping can be made.

* Users can; * view the *Source Category Tree* for the Category to Category mapping, * view the *Source Category Nodes* and map these nodes to the selected Sales Channel’s Category Nodes (*Target Category Nodes*) * make Category to Category mapping ignored * filter Category to Category Mappings by *Excluding Ignored Categories* or *Showing Categories That Need Mapping,* * view the schema of the *Target Category Nodes* on the *Category to Category* tab.

* Users also can; * view, create, update and delete the Category Mapping Rules, * filter Rules with respect to the *Status* and *Target Category Name* on the *Rules (Product to Category*) tab.

## Step 4: Add/Update “Category to Category” Mapping * After selecting a *Source Category Tree* and clicking on the **Apply** button, the selected Category Tree can be seen on the **Category to Category** tab.

* Listed source categories can be mapped * by clicking on the dropdown and selecting the target category nodes, or * by clicking on the schema icon and selecting the target category nodes. * Mapped categories can be edited by the same steps above. * Mapped categories can be deleted by clicking on the *Delete Icon.* For products added to the catalog, category assignments are automatically made to the target category node with respect to the relevant *Category to Category Mapping*.

*Creating / Updating “Category to Category Mapping” by clicking on the dropdown and selecting the target category nodes*

*Creating / Updating “Category to Category Mapping” by clicking on the schema icon and selecting the target category nodes.* {% hint style="info" %} Please note that the “*adding products to the catalog*” operation should be done after the *Category to Category Mapping* is completed. {% endhint %} {% hint style="info" %} Please note that only the “leaf” source and target categories can be mapped to each other (leaf categories: sub-category nodes that do not have any child category nodes). {% endhint %} ## Step 5: Add/Update Category Mapping Rule * Clicking on the **Rules** button on the Category Mapping page, **Category Mapping Rules** can be seen as a list.

* By clicking on the **+ New Category Mapping Rule** button, or clicking on the **Edit** icon on the listed category mapping rules, **Add / Edit Category Mapping Rule** **Form** can be opened.

* Users can; * select a *Target Category Name*, * give rule(s) to the *Target Category Node* by selecting one or multiple *Attribute Name, Condition Processor* and *Attribute Value* for the *Category Mapping Rule*. For products added to the catalog, category assignments are automatically made to the target category node with respect to the relevant *Category Mapping Rule*.

*One Rule can include multiple Attribute Name, Condition, Attribute Value groups* {% hint style="info" %} The “*adding products to the catalog*” operation should be done after the *Category Mapping Rule* is created. {% endhint %} {% hint style="info" %} Only the “leaf” source and target categories can be mapped to each other (leaf categories: sub-category nodes that do not have any child category nodes). {% endhint %} {% hint style="info" %} *Category to Category Mapping* and *Category Mapping Rules* can be formed for the same *Target Category Node*. In this case, the product assignment to the Target Category Node, provided that the product has been added to the catalog, is automatically made with respect to both mapping rules. {% endhint %} ## Step 6: Delete Category Mapping Rule * Listed Category Mapping Rules can be deleted by selecting the “Delete Selected Items” option and clicking on the **Apply** button.

# Sales Channel Settings # How to Configure Marketplace Attribute Mapping in Omnitron? Omnitron Marketplace Mapper enables users to configure and match their product attributes and attribute values for Marketplace Sales Channels. It also allows users to verify the correctness of product features and values prior to listing them for sale.

## Marketplace Attributes The **Marketplace Attributes** page lists the attributes for the related Marketplace. On this page, Users can view the *PK (Primary Key), Name, Related Mapping Rule Set Name and Updated Date* of the Marketplace Attributes, and filter Marketplace Attributes with respect to *Attribute Name* and/or *Attribute Set* values.

## Marketplace Attribute Values The **Marketplace Attribute Values** page lists the attribute values of the related Marketplace’s attributes. On this page, users can view the *Primary Key (PK), Attribute, Name, Value, Updated Date* of the Marketplace Attribute Values and filter Marketplace Attribute Values with respect to *Name, Attribute,* and/or *Attribute Set* values.

* **Primary Key:** ID of the relevant attribute value, has to be unique. * **Attribute:** Attribute that the relevant attribute value depends on. * **Name (Attribute Value’s Label):** Label of the attribute value. For example, there can be an attribute value with a label of “White” and a value of “0001”. In other words the Name of the attribute value. * **Value (Attribute Value):** Attribute Value identifier, has to be unique. ### Mapper The **Mapper** page lists predefined Mapping Rule Sets of rules for Marketplace Attributes. A Mapping Rule can be described as the set of attribute value mappings between the Omnitron and related Marketplace. Users can create a New Mapping Rule Set by clicking on the **+ Add New Attribute Mapping Rule** button, or edit existing rule sets by clicking on the **Edit** button on the row. Additionally, users can filter Mapping Rules with respect to *Rule Set Name, Target Attribute, Target Attribute Set, Creation Date and Updated Date* on this page. This allows them to conveniently find and manage the specific mapping rules they need for their products listed on the marketplace.

#### Add/Edit Mapping Rule Form By clicking the **+ Add New Attribute Mapping Rule** button or the **Edit** button in the list, users can access **Add/Edit Mapping Rule Form**. To create a set of attribute value mappings between the Omnitron and related Marketplace, users must complete the *Mapping Rule Name* and *Target Attribute (Related Marketplace Attribute)* fields. If the mapping rule requires customization based on categories, users can select the specific category for customization in the **Target Attribute Set** field, located next to the **Target Attribute.** {% hint style="info" %} Target Attributes can be filtered by clicking on the “Show only required target attributes” checkbox. {% endhint %}

Users can create or edit Mapping Rules for Omnitron Attributes and related Marketplace Attributes by choosing the four primary Mapping Methods that Akinon Mapper offers: * Standard Mapping * Fixed Value Mapping * Merge Fields Mapping * Custom Mapping #### **Standard Mapping** The Standard Mapping method is used to directly map Omnitron Attribute & Attribute Values to Marketplace Attribute & Attribute values. Users can select which Omnitron Attribute Value will be matched to which Marketplace Attribute Value. After selecting the *Standard* Mapping Method, users should select the *Source Attribute (Related Omnitron Attribute)* for direct mapping. If users want to manually match their Source Attribute Values to Target Attribute Values, the *Add static value to value mapping* checkbox should be marked. With this action, all of the Source Attribute Values will be listed, and users can select the related Target Attribute Values for each. {% hint style="info" %} If both the Source and Target Attributes’ data types are “dropdown”, an auto-mapping is performed with respect to the *attribute values*. Auto-mapped attribute values can be distinguished from the corresponding green checkbox icon. This feature can be used only for **Adding a New Mapping Rule**. {% endhint %}

{% hint style="info" %} If the *Show Description* checkbox is checked, target and source *attribute labels* can be seen, if not, attribute values can be seen on the Attribute Values list. {% endhint %} On the other hand, if users want to send their Source Attribute Values directly to the related Target Attribute, the *Add static value to value mapping* checkbox should not be marked. Please note that Source Attribute Values’ parameter should either be present as a Marketplace Attribute Value or the related Marketplace Attribute accepts free-text inputs for the Target Attribute while the checkbox is not marked.

#### **Fixed Value Mapping** The Fixed Value mapping method is used to assign a fixed value to a Marketplace Attribute for all the products being sent. There are three options for the fixed Marketplace Attribute Value: * **Null:** Target Attribute Value is sent as null for all marketplace products (e.g., `"Origin":null`). * **Empty String:** Target Attribute Value is sent as an empty string for all marketplace products (e.g., `"Origin":""`). * **Custom:** A specified custom value is sent for all marketplace products (e.g., `"Size": "Standard"`).

#### **Merge Fields Mapping** The Merge Fields mapping method allows users to create an attribute value by combining Source Attribute Values or Fixed Values into a corresponding Marketplace Attribute Value. By selecting the *Concatenate* function under the **Function** tab, users can merge one or more Source Attributes with Fixed Values in the **Content** tab. The **Output Preview** field displays the template (showing which Source Attributes and/or Fixed Values were used to create the Marketplace Attribute Value) and the resulting value under the "Preview Output Template" and "Sample Output Value" sections, respectively.

#### **Custom Mapping** The Custom mapping method is used for more complex mappings that cannot be handled by the other three mapping methods. Some of the Rule Set components are explained below. * **type:** Defines the Mapping Type and can be one of the following: * **attribute:** Maps a source attribute to a target attribute. * **attribute\_kwargs:** Maps a source attribute to a target attribute as an object. * **field:** Uses various fields (such as SKU, base code, or localized attribute values) as the target attribute value. * ***stdout:*** Uses fixed values as the target attribute value. * **mapping:** Maps source attribute values to target attribute values individually. * **key:** Source Attribute Key, required when the Type is set to attribute, attribute\_kwargs, or field. * **condition:** The condition that must be met for Marketplace Attribute Value integration. For example, when the Source Attribute Value is `"Unisex Child"` or `"Child"`, the attribute value mapping will integrate accordingly. ``` { "query": { "attributes__integration_gender__in": [ "Unisex Child", "Child" ] }, "condition_type": "liquer" } ``` * **is\_object:** Indicates whether the rule’s output will be sent as an object. * `is_object: true` output example: ``` "size": { "label": "36", "value": "0012", "data_type": "dropdown", "_translations": { "us": { "label": "6" } } } ``` * `is_object: false` output example: ``` "size": "0012" ``` * **order:** The priority value of the rule. * **concat:** Specifies whether the rule’s output should be concatenated with other rules. This is a boolean parameter. * **prefix:** The prefix value for the target Marketplace Attribute Value, which is used when the *concat* parameter is set to true. * **default\_value:** The fallback Marketplace Attribute Value if the mapping fails. * **mapping\_dict:** A dictionary mapping Source Attribute Values to Marketplace Attribute Values. It must be used when the *Type* is set to *mapping*. * Example of `mapping_dict`: ``` { "Red": "0005", "Blue": "0001", "Grey": "0004", "Brown": "0007", "White": "0002", "Yellow": "0006" } ```

**Custom Mapping Example:** {% hint style="info" %} The field *If fails*, send a default value as; located at the bottom of the page is used to send a fixed value to the respective target attribute in case an error occurs during the mapping process, as defined in the mappings above. {% endhint %}

After the relevant Mapping Method and mapping configuration are filled out, by clicking on the *Save* button, a *Mapping Rule* can be created/edited. By clicking on the *Clear the Rule* button, relevant *Mapping Rule* can be cleared. In other words, the mapping rule still exists, but without any configuration. ## Mapping Control The Mapping Control function enables users to verify which values will be sent to the marketplace for the attributes of a product after the mapping processes. When the **Mapping Control** list page is opened, all products on the catalog for the related Marketplace are listed. Users can view the products that are in the Marketplace Catalog with respect to their all attributes, SKU, Base Code, Category, etc information, filter the Marketplace-Catalog products with respect to all-product-attributes, preview & download the Marketplace Attributes and Marketplace Attribute Values for filtered products on this page.

After filtering the Marketplace-Catalog Products, clicking on the Show Mapping Result button opens the Mapping Control pop-up, in which the Marketplace Attributes and Marketplace Attributes can be seen and downloaded by the users.

**Warning** 1. Mapper page and its functions can also be used for Marketplaces with the Sales Channel type. 2. However, when editing schemas created under **Sales Channel**, users are warned about the possibility of function loss.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2F0N4gTdCGQVHfZnxHXQSo%2Fimage.png?alt=media\&token=02006d63-b7c5-4a58-b054-4c6b567c1e2d) 3. In marketplaces with Sales Channel type, the old mapping screens (Schema, Attribute Mapping, Category Attribute Mapping) cannot be used.

4. The **Mapping Control** function is only applicable to Marketplaces with the Sales Channel type. # How to Manage Marketplace Mapping in Omnitron? This tutorial provides step-by-step instructions for managing Marketplace Mapping operations in Omnitron. ## Step 1: Access to Omnitron * Get access to the **Omnitron** panel. * Enter your *Username* and *Password*, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Marketplace Mapping Menu * Follow the **Sales Channels** sidebar and click on the **Sales Channel Settings** menu. * Click on the **Marketplace Mapping** cardbox to reach the **Marketplace Mapping** menu. {% hint style="info" %} **Marketplace Mapping** cardbox appears only when the selected sales channel type is **not** web. In other words, for *Marketplace-type* of sales channels (*Unified* included), this cardboard appears. {% endhint %}

* On the **Marketplace Mapping** menu, * Omnitron Attribute Values and Marketplace Attribute Values can be mapped on the **Mapper** page, * Defined Marketplace Mappings can be controlled product by product on the **Mapping Control** page, * Marketplace Attributes and Marketplace Attribute Values can be seen on **Marketplace Attributes** and **Marketplace Attribute Values** pages.

## Step 3: View/Filter Marketplace Attributes * Clicking on the **Marketplace Attributes** cardbox on the **Marketplace Mapping** menu, the **Marketplace Attributes** page can be seen. * Users can; * view the *Name* of the Marketplace Attributes, * filter Marketplace Attributes with respect to *Attribute Name and/ or Attribute Set* values on the **Marketplace Attributes** page.

{% hint style="info" %} In addition to *Name,* after being filtered with *Attribute Set, Remote ID, Is Required, Is Variant, Is Custom, Is Meta, Attribute Set Name, Updated Date* columns can be seen, too. {% endhint %}

## Step 4: View/Filter Marketplace Attribute Values * Clicking on the **Marketplace Attribute Values** cardbox on the **Marketplace Mapping** menu, the **Marketplace Attribute Values** page can be seen. * Users can; * view the *Primary Key (PK), Attribute, Attribute Value’s Label, Attribute Value, Updated Date* of the Marketplace Attribute Values. * **Primary Key:** ID of the relevant attribute value, has to be unique. * **Attribute*****:*** Attribute that the relevant attribute value depends on. * **Attribute Value’s Label:** Label of the attribute value. For example, there can be an attribute value with a label of “White” and a value of “0001”. In other words the *Name* of the attribute value. * **Attribute Value:** Attribute Value identifier, has to be unique. * filter Marketplace Attribute Values with respect to *Attribute Label, Attribute, and/ or Attribute Set* values on the **Marketplace Attribute Values** page.

## Step 5: View/Filter Mapping Rules on Mapper Page * Clicking on the **Mapper** cardbox on the **Marketplace Mapping** menu, the **Mapper** page can be seen. Users have the option to view, filter, add/edit Mapping Rules for related marketplace. * *A Mapping Rule can be described as the mapping between an Omnitron Attribute and a Marketplace Attribute.* * Users can; * view the *Mapping Rule Name, Creation Date, Update Start Date* of Mapping Rules, * filter Mapping Rules with respect to *Rule Set Name, Target Attribute, Target Attribute Set, Creation Date and Updated Date* * *Target = Marketplace, Source = Omnitron* * add a New Mapping Rule, * edit an existing Mapping Rule, * delete one / multiple Mapping Rule(s) on the **Mapper** page.

## Step 6: Add/Edit Mapping Rule * Clicking on **+ Add New Attribute Mapping Rule** button or clicking on the **Edit** icon on listed Mapping Rules, users can reach the **Add/Edit Attribute Mapping Rule** form. * Users can; * name the *Mapping Rule*, * select the *Target Attribute*, * select the relevant *Mapping Method,* * select a default value for mapping in case an error occurs for the mapping rule. * Target Attributes (Marketplace Attributes) can be filtered by clicking on the *“Show only required target attributes”* checkbox.

There are four different types of *Mapping Methods* available in **Marketplace Mapping Rule Form**: **Standard:** In which an Omnitron Attribute & Attribute Values are mapped directly with the Marketplace Attribute & Attribute Values. {% hint style="info" %} In *Standard* *Mapping Method*, if both the Source (Omnitron) and Target (Marketplace) Attributes’ data types are “*dropdown”*, an auto-mapping is performed with respect to the attribute values. Auto-mapped attribute values can be distinguished from the corresponding green checkbox icon. {% endhint %} This feature can be used only for **Adding a New Mapping Rule**.

**Fixed Value:** In which a fixed attribute value can be given to selected Marketplace Attribute for all Marketplace Products.

**Merge Fields:** In which multiple fixed values and / or Omnitron attributes can be concatenated and are mapped with the selected Marketplace Attribute.

**Custom:** In which a JSON Type of configuration can be given for the mapping of Marketplace Attribute.

* After the relevant *Mapping Method* and mapping configuration are filled out, by clicking on the **Save** button, a Mapping Rule can be created/edited. * By clicking on the **Clear the Rule** button, relevant Mapping Rule can be cleared. In other words, the mapping rule still exists, but without any configuration. ## Step 7: Delete Mapping Rule * On the **Mapper** page, by selecting the listed Mapping Rules, the “Delete Selected Mapping Rule(s)” option and clicking on the **Apply** button, users can delete existing Mapping Rule(s).

## Step 8: Control Marketplace Mapping * Clicking on the **Mapping Control** cardbox on the **Marketplace Mapping** menu, the **Mapping Control** page can be seen. * Users can; * view the products that are in the Marketplace Catalog with respect to their all attributes, SKU, Base Code, Category, etc information, * filter the Marketplace-Catalog products with respect to all-product-attributes, * preview & Download the Marketplace Attributes and Marketplace Attribute Values for filtered products on the **Mapping Control** page.

* After filtering the Marketplace-Catalog Products, clicking on the **Show Mapping Result** button opens the Mapping Control pop-up, in which the Marketplace Attributes and Marketplace Attributes can be seen and downloaded by the user.

{% hint style="info" %} This menu is only available for sales-channel-type of Marketplaces. {% endhint %} # How to Manage Marketplace Operations? This tutorial provides step-by-step instructions for managing marketplace operations in Omnitron. ## Step 1: Access to Omnitron * Get access to the **Omnitron** panel. * Enter your *Username* and *Password*, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Marketplace Operations Menu * Follow the **Sales Channels** sidebar and click on the **Sales Channel Settings** menu. * Click on the **Marketplace Operations** cardbox to reach the **Marketplace Operations** menu. {% hint style="info" %} The **Marketplace Operations** cardbox appears only when the selected sales channel type is **not** web. In other words, for *Marketplace-type* of sales channels (*Unified* included), this cardboard appears. {% endhint %}

* In the **Marketplace Operations** menu: * **Product**, **Stock** and **Price** Information for marketplace products can be updated from Omnitron to the related marketplace. * **Orders** can be updated from the related marketplace. * The latest **Attribute Set** configurations can be gathered from Unified Marketplace.

## Step 3: View/Filter/Update Marketplace Product Info * By clicking on the **Product Update** cardbox on the **Marketplace Operations** menu, the **Product Update** page can be accessed. * Users can: * View the *Products* of the related Marketplace Catalog. * Filter *Products* with respect to all attribute values. * Update selected *Products’* information on the related Marketplace on the **Product Update** page.

## Step 4: View/Filter/Update Product Stock Values * By clicking on the **Stock Update** cardbox on the **Marketplace Operations** menu, the **Stock Update** page can be accessed. * Users can: * View the *all Stock Lists.*

* View the *Products under these Stock Lists.* * Filter *Products* with respect to all attribute values. * Update selected Products’ stock value on the related marketplace (By selecting products under the related stock list and by clicking on the *Stock Update* action) on the **Stock Update** page.

## Step 5: View/Filter/Update Product Price Values * By clicking on the **Price Update** cardbox on the **Marketplace Operations** menu, the **Price Update** page can be accessed. * Users can: * View the *all Price Lists.*

* View the *Products under these Price Lists.* * Filter *Products* with respect to all attribute values. * Update selected Products’ price value on the related marketplace. (By selecting products under the related price list and by clicking on the *Price Update* action) on the **Price Update** page.

## Step 6: Update Marketplace Order(s) * By clicking on the **Order Update** cardbox on the **Marketplace Operations** menu, the **Order Update** page can be accessed. * Users can fetch latest order information by filtering: * Start & End Dates * and/or Order Numbers from the marketplace.

## Step 7: View/Filter/Update Attribute Sets * By clicking on the **Attribute Set Update** cardbox on the **Marketplace Operations** menu, the **Attribute Set Update** page can be accessed. * Users can: * View the *Marketplace Attribute Sets.* * Update selected Attribute Sets’ information to get the latest configuration (by selecting attribute sets and by clicking on the *Update Selected Attribute Sets* action) on the **Attribute Set Update** page.

# How to Manage Address Mapping in Omnitron? This tutorial provides step-by-step instructions for managing Address Mapping in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Address Mapping Page * Follow the **Sales Channels>Sales Channel Settings** sidebar and click the **Address Mapping** page.

* During the initial configuration of the Omnitron project, the address mapping section is automatically set up, incorporating default Turkish data retrieved from the Post Telegraph Corporation. * On the Address Mapping page, a wizard panel dedicated to the country, city, district, and neighborhood is provided. The existing mappings are listed at the bottom of the page. * The listed mappings correspond to various integration types for the respective country, city, district, and neighborhood. ## Step 3: Upload Address Mapping with .CSV File * Before starting the address mapping update process, a template can be downloaded by clicking on the **.CSV download** button next to "Drop Files Here or Click to Upload." Following the template download, the updated order information can be entered into the CSV file.

* The fields to be updated include: * **country\_name:** The country name should be entered. * **country\_code:** The relevant country code value should be added to the file. * **city\_name** : The city value to be added to the address mapping should be added to the file. * **township\_name** : The country name should be entered. * **district\_name** : The relevant district name value should be added to the file. * **Zipcode**: The zipcode value can be added. * After preparing the file, take the action **Drop Files Here or Click to Upload**, and the bulk process will begin. Once the process is completed, the page will display the newly added mapping.

## Step 4: Navigate to Country Detail Page * Clicking on a specific entry in the current country list allows users to view details about the existing mapping, including the integration type used for its creation. * The listed mappings correspond to various integration types specific to the respective country, city, district, and neighborhood. * By clicking the **+ Add Mapping** button, a form is opened, and the following fields should be filled in: * **Code**: Enter the country code (e.g., TR, etc.). * **Integration** **Type**: Select the integration type to be used for mapping.

* After completing the relevant fields, click the **Save** button.

## Step 5: Navigate to City Detail Page * Users can view existing mappings by clicking on the city in the wizard panel. * City names can be filtered based on the country. * The mappings listed in this section correspond to various integration types specific to the respective country, city, district, and neighborhood.

* When a particular entry in the current city list is clicked, detailed information about the existing mapping, including the integration type used for its creation, becomes visible. * Clicking the **+ Add Mapping** button opens a form where the following fields need to be filled: * **Code**: Enter the city code. * **Integration Type**: Select the integration type to be used for mapping. * Once the relevant fields are completed, click the **Save** button.

## Step 6: Navigate to District Detail Page * Users can view existing mappings by clicking on the district in the wizard panel. * The city and district names can be filtered according to the country. * The mappings listed in this section correspond to a variety of integration types for the respective country, city, district, and neighborhood.

* When a particular entry in the current district list is clicked, detailed information about the existing mapping, including the integration type used for its creation, becomes visible. * Clicking the **+ Add Mapping** button opens a form where the following fields need to be filled: * **Code**: Enter the district code. * **Integration Type**: Select the integration type for mapping. * Once the relevant fields are completed, click the **Save** button.

## Step 7: Navigate to Neighborhood Detail Page * Users can view existing mappings by clicking on the neighborhood in the wizard panel. * The city, district, neighborhood names can be filtered according to the country. * The mappings listed in this section correspond to a variety of integration types for the respective country, city, district, and neighborhood.

* When a specific entry in the current neighborhood list is clicked, details about the existing mapping, including the integration type used for its creation, can be viewed. * Clicking the **+ Add Mapping** button opens a form to fill in the following fields: * **Code**: Enter the neighborhood code. * **Integration Type**: Select the integration type for mapping. * Once the relevant fields are completed, click the **Save** button.

# How to Manage Social Accounts in Omnitron? The Social Accounts feature in Omnitron enables integration with various social platforms, such as Google, Apple, Facebook, Turkcell and Akifast. This functionality allows users to authenticate and manage their social connections directly within the Omnitron panel, ensuring a streamlined and secure experience. Before proceeding with the steps outlined in this guide, **ensure that the necessary configurations have been completed on the relevant platform (Developers Facebook, Developers Google, etc.)**. This guide will then walk you through accessing the panel, navigating the settings, and adding new social account providers to effectively configure and utilize the Social Accounts feature for your business needs. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Social Accounts Page * Follow the **Sales Channels > Sales Channels Settings** sidebar and click the **Social Accounts** page.

* This page displays various social accounts, including Akifast and applications. It allows users to log in using platforms like Google, Akifast, or Facebook, among others.

## Step 3: Adding Social Account * To add a new social account, click the + New Social Account button. Complete the form by filling in the following fields: * **Provider:** Select a provider, such as Akifast, Facebook, etc. * **Name:** Enter the name for this social account. * **Client Id:** The unique client value for this social account. * **Secret:** The unique secret value for this social account. * **Key:** The unique key value for this social account. * **Site:** Select the site on which it is located. * **Certificate:** Optionally fill in this field for certificate usage. * Once you have filled in the relevant fields, click the **Save** button.

{% hint style="warning" %} **Important Note for Project Zero Integration** To ensure the system functions correctly, it is essential to configure the `USE_X_FORWARDED_HOST` setting appropriately for different environments: * **ACC and Project Zero Projects:** The `USE_X_FORWARDED_HOST = True` setting must be read from the environment variables. Ensure this configuration is correctly defined in the respective environment files. * **Other Projects:** For all other projects, the `USE_X_FORWARDED_HOST = True` setting should be added to the `settings.py` file within the project. {% endhint %} # How to Manage Loyalty Integration Settings? This tutorial provides step-by-step instructions for managing loyalty integration settings operations in Omnitron. ## Step 1: Access to Omnitron * Get access to the **Omnitron** panel. * Enter your *Username* and *Password*, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Loyalty Integration Settings Page * Follow the **Sales Channels > Sales Channel Settings** steps and click on the **Loyalty Integration Settings** cardbox. {% hint style="info" %} **Loyalty Integration Settings** cardbox appears only when the selected sales channel type is web. In other words, for *shop-type* of sales channels, this cardboard appears. {% endhint %}

## Step 3: View Loyalty Integration Settings * By clicking on the **Loyalty Integration Settings** cardbox on the **Sales Channel Settings** menu, the **Loyalty Integration Settings** page can be accessed. * A Loyalty Integration Settings can be described as the loyalty card integration for the related Sales Channel. * Users can; * view the *Loyalty Integration Settings* for the related Sales Channel, * add a *New Loyalty Integration Setting*, * edit an existing *Loyalty Integration Setting* on the **Loyalty Integration Settings** page.

## Step 4: Add/Edit Loyalty Integration Settings * Clicking on **+ New Loyalty Integration Setting** button or clicking on the listed Loyalty Integration Settings, users can reach the **Add/Edit Loyalty Integration Setting** form. * Users can; * give value to the *name, infrastructure,* * fill in the *config* field with JSON format, * select the *status* value for the Loyalty Integration Setting.

# How to Manage Store Stock Settings? This tutorial provides step-by-step instructions for managing store stock setting operations in Omnitron. ## Step 1: Access to Omnitron * Get access to the **Omnitron** panel. * Enter your *Username* and *Password*, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Store Stock Settings Page * Follow the **Sales Channels** sidebar and click on the **Sales Channel Settings** menu, **Store Stock Settings** cardbox can be seen. {% hint style="info" %} **Store Stock Settings** cardbox appears only when the selected sales channel type is web. In other words, for *shop-type* of sales channels, this cardboard appears. {% endhint %}

{% hint style="info" %} **Store Stock Settings** connect users' ERPs with Omnitron and transfers information to the shop where the products are available. {% endhint %} ## Step 3: Add a New Store Stock Setting * By clicking on the **Store Stock Settings** cardbox on the **Sales Channel Settings** menu, the **Store Stock Settings** page can be accessed. * To add a new Store Stock Setting, click on the **+ New Store Stock Setting** button.

* Complete the form by filling in the following fields: * **Name:** Specify the name for this Store Stock Setting. * **Infrastructure:** Assign the infrastructure for this Store Stock Setting. * **Config:** Enter configuration details for the stock integration between the ERP and Omnitron, in JSON format. * **Status:** Assign the status (Active/Passive) of related Store Stock Setting.

## Step 4: View/Update Store Stock Settings * By clicking on the **Store Stock Settings** cardbox on the **Sales Channel Settings** menu, the **Store Stock Settings** page can be accessed.

* To update existing Store Stock Setting, click on the related Store Stock Setting. You will be redirected to the Add/Edit Store Stock Settings form, complete the editing by filling in the fields described on Step 3.

# How to Manage Product List Filter Settings? This tutorial provides step-by-step instructions for managing product list filter settings operations in Omnitron. ## Step 1: Access to Omnitron * Get access to the **Omnitron** panel. * Enter your *Username* and *Password*, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Product List Filter Settings Page * Follow the **Sales Channels > Sales Channel Settings** steps and click on the **Product List Filter Settings** cardbox. {% hint style="info" %} **Product List Filter Settings** cardbox appears only when the selected sales channel type is web. In other words, for *shop-type* of sales channels, this cardboard appears. {% endhint %}

## Step 3: View/Filter Product List Filter Settings * By clicking on the **Product List Filter Settings** cardbox on the **Sales Channel Settings** menu, the **Product List Filter Settings** page can be accessed. * A Product List Filter Setting, in other words facet, can be described as the configuration of the filter component that is shown on the shop. *Searchable* type of attributes can be seen on the shop as filters, configuration of these filters (like how they look, how they filter (exact match or includes etc.)) can be made on the **Product List Filter Settings** page. * Users can; * view the *Product List Filter Settings* for the related Sales Channel, * filter *Product List Filter Settings* with respect to the *name* and *attribute key* values, * add a *New Product List Filter Setting*, * edit an existing *Product List Filter Setting* on the **Product List Filter Settings** page.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2Fc3Av5XhF16qIqnlNAM3B%2Fimage.png?alt=media\&token=5ef23430-a85e-428b-b00e-d4fb805a77b4) ## Step 4: Add/Edit Product List Filter Settings * Clicking on **+ New Filter Option** button or clicking on the listed Product List Filter Settings, users can reach the **Add/Edit Product List Filter Setting** form. * Users can; * give value to the *filter option name, attribute key,* * *attribute key* input can be one of the attributes on *Products and Catalogs - Product Attributes* list or one of the static attributes, like *price, stock* etc. * select the *attribute type, widget type, filter type* values*,* * *attribute types can be “global” or EAV (entity-attribute-values)”.* * If static attributes are to be used, “global” should be selected. * If attributes listed on *Products and Catalogs - Product Attributes* list are to be listed “*eav*” should be selected. * widget types can be *“multi select”, “category”, “feature value”, “visual color example”, “nested”* * Visual customization for filters can be made with combining widget types and widget kwargs values, like selecting “\_visual color example” \_widget type and configuring HEX definitions on colors on widget kwargs. * filter types can be “*terms*” or “*range*” * For example, if “*between 100-125 EUR*” price filter is to be added to the shop, “*range*” filter type should be selected and relevant widget kwargs and filter kwargs should be configured. Otherwise, “*terms*” should be selected. * fill in the *widget kwargs, filter kwargs, settings* fields with JSON format for the *Product List Filter Setting*.

# How to Manage Instore Settings in Omnitron? This tutorial provides step-by-step instructions for managing Instore Settings in Omnitron. ## Step 1: Access to Omnitron * Get access to the **Omnitron** panel. * Enter your *Username* and *Password*, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Instore Settings Page * Follow the **Sales Channels** sidebar and click on the **Sales Channel Settings** menu. * Click on the **Instore Settings** cardbox to reach the **Instore Settings Form**. {% hint style="info" %} **Instore Settings** cardbox appears only when an *Instore Application* is installed to a related project and connected with the *Omnitron Application*. {% endhint %}

* On the **Instore Settings** page, *Instore Application Settings* and *Configuration* for selected Sales Channel can be seen and edited. ## Step 3: View/Edit Application Settings * Clicking on the **Application Settings** step on the wizard, users have the option to set *Font, Logo, Button Color, Default Instore Language, Default Page* for related Sales Channel's Instore Application. * **Font:** The designated font for the Instore application UI. Users have the option to either use the default font or upload custom fonts according to their preference. * **Logo:** The brand logo displayed on the Instore UI. * **Favicon:** The Favicon that enhances the brand presence and is visible on the Instore UI. * **Button Color:** The color scheme applied to buttons featured in the Instore UI. Users can select their preferred button color through a color-picker pop-up. * **Language:** Users can set the default language for the Instore UI. * **Default Page:** Users can select the default landing page for the Instore application.

{% hint style="info" %} Users can only select; * *.svg* type documents for *Logo*, * *.ico* type documents for *Favicon*, * *.otf, .ttf, .eot, .woff, .woff2* types of documents for *Regular Font*. {% endhint %} ## Step 4: View/Edit Configuration * Clicking on the **Configuration** step on the wizard, users have the option to set *Config Settings* and *Menu Settings* for Instore Application. * Users can Enable/Disable listed Config Settings, such as “Send SMS When Signing Up, Customer Search with Name, etc.” in the **Config Settings** tab.

* Users can Enable/Disable menus that are shown in the Instore Application in the **Menu** tab.

# How to Manage General Sorting Settings? This tutorial provides step-by-step instructions for managing general sorting settings operations in Omnitron. ## Step 1: Access to Omnitron * Get access to the **Omnitron** panel. * Enter your *Username* and *Password*, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to General Sorting Settings Page * Follow the **Sales Channels > Sales Channel Settings** steps and click on the **General Sorting Settings** cardbox. {% hint style="info" %} **General Sorting Settings** cardbox appears only when the selected sales channel type is web. In other words, for *shop-type* of sales channels, this cardboard appears. {% endhint %}

## Step 3: View General Sorting Settings * By clicking on the **General Sorting Settings** cardbox on the **Sales Channel Settings** menu, the **General Sorting Settings** page can be accessed. * A General Sorting Setting can be described as the customers’ checkout-step cargo option on related Sales Channel. * Users can; * view the *General Sorting Settings* for the related Sales Channel, * add a *New General Sorting Setting*, * edit an existing *General Sorting Setting* on the **General Sorting Settings** page.

## Step 4: Add/Edit General Sorting Settings * Clicking on **+ New General Sorting Setting** button or clicking on the listed Sorting Settings, users can reach the **Add/Edit General Sorting Setting** form. * Users can; * give value to the sorting *name, sorting value* of the General *Sorting Setting,* * The *sorting value* of the General Sorting Setting determines the query name which can be seen on the shop (*{shopURL}.com/{relevant\_path}/?sorter=\*). * select the *sales channel* and *visibility (whether the setting will be visible or not on the Shop)* values, * fill in the *Is Default Sorting, Remove Elastic Score Effect* checkboxes * Before Elasticsearch starts scoring documents, it first reduces the candidate documents down by applying a boolean test. Based on the match between the document and the query, the score of documents determine how they are rank ordered for relevancy.

{% hint style="info" %} To create the General Sorting Setting properly, users should link *Sorting Algorithms* with the relevant *General Sorting Setting.* This operation can be held under the *Sorting* tab on the *Add/Edit General Sorting Setting* form. One or multiple sorting algorithms can be assigned to the relevant General Sorting Setting and their priority can be changed via drag and drop. {% endhint %}

# How to Manage Shipping Options in Omnitron? This tutorial provides step-by-step instructions for managing shipping options operations in Omnitron. ## Step 1: Access to Omnitron * Get access to the **Omnitron** panel. * Enter your *Username* and *Password*, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Shipping Options Page * Follow the **Sales Channels > Sales Channel Settings** steps and click on the **Shipping Options** cardbox. {% hint style="info" %} **Shipping Options** cardbox appears only when the selected sales channel type is web. In other words, for *shop-type* of sales channels, this cardboard appears. {% endhint %}

## Step 3: View/Filter Shipping Options * By clicking on the **Shipping Options** cardbox on the **Sales Channel Settings** menu, the **Shipping Options** page can be accessed. * A Shipping Option can be described as the customers’ checkout-step cargo option on related Sales Channel. * Users can; * view the *Shipping Options* for the related Sales Channel, * filter *Shipping Options* with respect to *Name, Slug, Payment Options* and *their Status* values, * add a *New Shipping Option*, * edit an existing *Shipping Option* on the **Shipping Options** page.

## Step 4: Add/Edit Shipping Option * Clicking on **+ New Shipping Option** button or clicking on the listed Shipping Options, users can reach the **Add/Edit Shipping Option** form. * Users can; * give value to the *name, slug, order* inputs of the *Shipping Option,* * The *order* value of the Shipping Option determines the ranking of relevant shipping options on the checkout step. * fill in the *calculator, rule* and *description* fields with JSON format, * select the *status (Active, Passive)* and *delivery type (In-store, Next Day, Same Day, Standard)* values, for the Shipping Option.

{% hint style="info" %} For more information about the *calculator* and *rule*, the [Shipping Rules Calculator](/technical-guides/commerce/shipping-rules-calculator) document can be seen. {% endhint %} {% hint style="info" %} For a Shipping Option to be listed on the checkout properly, the *Slug* value of the Shipping Option should be the same as the *ERP Code* value of the related Shipping Company, defined in the Settings > Shipping Companies. {% endhint %} # How to Manage Delivery Options in Omnitron? This tutorial provides step-by-step instructions for managing delivery options operations in Omnitron. ## Step 1: Access to Omnitron * Get access to the **Omnitron** panel. * Enter your *Username* and *Password*, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Delivery Options Page * Follow the **Sales Channels > Sales Channel Settings** steps and click on the **Delivery Options** cardbox. {% hint style="info" %} **Delivery Options** cardbox appears only when the selected sales channel type is web. In other words, for *shop-type* of sales channels, this cardboard appears. {% endhint %}

* This page displays Delivery Options that the related brand supports (such as Delivery to Customer, Delivery from the Store etc.).

## Step 3: Add a Delivery Option * To add a new delivery option, click the **+ New Delivery Option** button.

* Complete the form by filling in the following fields: * **Name:** Specify the name for this Delivery Option. * **Slug:** Define a unique slug for this Delivery Option. * **Sorting:** Define the order in which this Delivery Option will be listed. * **Delivery Type:** Select one of the pre-defined Delivery Types (Customer, Pickup Location, Retail Store) to which this Delivery Option will be related. * **Status:** Define the status of this Delivery Option (Active/Passive).

## Step 4: Edit a Delivery Option * To edit a Delivery Option, just click on the related Delivery Option to reach the **Add/Edit Delivery Option** form. * Complete the Edit action by updating the relevant inputs, described at Step 3. # How to Manage Easy Return Shipping Options in Omnitron? This tutorial provides step-by-step instructions for managing Easy Return Shipping Options in Omnitron. ## Step 1: Access to Omnitron * Get access to the **Omnitron** panel. * Enter your *Username* and *Password*, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FL1sAi0Wa7yceeQM3tJhA%2Fimage.png?alt=media\&token=f21533e2-c19c-4fa3-8506-b56dab42f399) ## Step 2: Navigate to Easy Return Shipping Options Page * Follow the **Sales Channels > Sales Channels Settings** sidebar and click the **Easy Return Shipping Options** page.

* This page displays the easy return shipping options that are essential for return processes related to the selected sales channel. Users are granted the capability to modify existing options or create new ones.

## Step 3: Adding a New Easy Return Shipping Option To add a new option, click the **+ Easy Return Shipping Option** button. Complete the form by filling in the following fields: * **Shipping Company:** Select a shipping company for this integration. * **Shipping Company Auth Code:** Enter the required authorization values for the shipping company. If you desire to transmit additional information such as package weight and cubic volume, you can input a JSON configuration to read the attribute values from the product. *Example JSON Config for Non-Extension Cargos:* ``` {"url":"https://webservices.akinonkargo.com","client_password":"pasword","client_id":"client_id"} ``` *Example JSON Config for Extension Cargos:* ``` {"username":"akinon","url":"extension_url","easy_return_product_attributes":{"category":"category","deci":"deci"},"send_user_address":true,"password":"password"} ``` * **Start Date Gap:** Specifies the number of days after initiating the return request for the return to be processed. If you desire the easy return start date to be the same day as the return request is created, enter 0. *(It is not applicable for extension cargo, so any value can be entered.)* * **Delivery Time:** Indicates the deadline for return shipping completion. Enter the maximum number of days after initiating the return request within which the return should be delivered. *(It is not applicable for extension cargo, so any value can be entered.)* * **Shipping Company Prefix:** Enter the prefix to be added when generating the easy return code. *(It is not applicable for extension cargo, so any value can be entered.)* * **Shipping Company Rules:** Filter items for easy returns based on specific rules by examining product attributes. Ensure the 'Rule' field is not left blank. See the example JSON below. *Example JSON Rule:* ``` {"product": {"field_key": "attributes__", "field_values": [[null]]}} ``` An easy return code can be generated based on the shipping address country. The following JSON rule can be referred to for guidance. ``` {"country":{"field_key":"code","field_values":["country_id"]},"product":{"field_key":"attributes__easy_return_method","field_values":[["",null]]},"package_rule":"country"} ``` * **Status:** Toggle the easy return shipping option between active and passive states. Once the relevant fields are completed, click the **Save** button.

# Integration # Pending Products This tutorial provides step-by-step instructions for managing Pending Products in Omnitron. ## Step 1: Access to Omnitron * Get access to the Omnitron panel. * Enter your Username and Password, and then click the **Sign In** button.\ ![](https://3333414532-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIbwGN7KwvYi0iLbjtnXz%2Fuploads%2FSm1Cc5pafA0lLxEnP9Xm%2Fimage1.png?alt=media\&token=4608fc68-3773-4d86-8542-8beae387d43d) ## Step 2: Navigate to Pending Products Page * Follow the **Integration** sidebar and click the **Pending Products** page.

* This page is used to view and manage Pre Products that have been transferred from the client’s ERP system to Omnitron through services but are yet to be fully productized. Any products added from the ERP system are automatically displayed on this page. This screen includes a filtering area and a list of pending products. {% hint style="info" %} In order to automatically fetch products onto the pending product list, products need to be active and assigned with related information (such as SKU, Base Code, and Product Name) on the client’s ERP system. {% endhint %}

* By default, the system allows users to filter products based on various criteria such as SKU, Base Code, Product Name, Attribute Set Name, Image, and whether the product has an Attribute Set. To customize these filters, users can click the filter icon located in the top-right corner, where additional filters can be added or removed according to their preferences. * Upon selecting a filter, it is promptly incorporated into both the filtering area and the product list tabs. Moreover, users have the option to employ Exclude filters when listing products. Alternatively, filtering can be achieved by uploading a file in either CSV or XLS format, a feature also accessible in the top-right corner. * For file uploads, adherence to a specific template is required. This template can be obtained at the bottom of the page by clicking the **Download Pending Products Template** button. * To export a list of selected products, users can choose the "Export to Excel" option from the Action Select menu, resulting in the generation of an Excel file. Likewise, the "Export to CSV" option allows for downloading the list in CSV format. To remove selected products, users can utilize the "Delete Selected" option found within the same drop-down menu. ## Step 3: Adding Bulk New Product Click the **+ New Product** button on the Pending Products page. This button is used to add products before integration between the client's ERP platform and Omnitron. Click the button to upload a CSV file with the related information of the products to be added. The CSV file must include **Product Name** and **SKU** information.

## Step 4: Bulk Product Update Located in the upper-right corner, the **Bulk Product Update** button can be used for updating pending products in bulk. In order to use this feature, begin by filtering and selecting the desired products from the list. Navigate to the **Select Action** drop-down menu, select **Export Selected to CSV**, and click the **Apply** button. Once you've entered the updated information into the file, proceed to click the **Bulk Product Update** button and upload the new file.

## Step 5: Productization of Pending Products ### Selecting an Attribute Set To initiate the process, start by defining attribute sets containing mandatory information like size and color for the pre-products received from the client's ERP software. These sets can be defined within the **Product Attributes** menu under the **Products and Catalogs** module. For example, in the clothing category, attributes such as color and size can be defined. Refer to the related document for detailed information on [Product Attributes & Product Attribute Sets](/tutorials/omnitron/products-and-catalogs/how-to-create-product-attributes-and-attribute-sets-in-omnitron). Once attribute sets are defined, filter the pending product list to focus on products that require an attribute set selection. Subsequently, select the desired products from the list. Navigate to the **Select Action** drop-down menu, select the **Select Attribute Set** action, and then click the **Apply** button. A new side menu will appear, displaying attribute sets pre-defined in the **Products and Catalogs** module. Here, select the appropriate attribute set for the product's attributes (e.g., color, size) and assign it to the product. For example, select "Size-Color," which includes both "color" and "size" attributes for an undershirt.

### Approving Products To approve products, begin by filtering the pending products list to include those with selected attribute sets. Navigate to the **Select Action** drop-down menu, select the **Approve Selected** option, and click the **Apply** button. Through this process, pre-products that have been approved are productized and moved to the **Product Pool** within the **Products and Catalogs** module. It's important to note that products without selected attribute sets are not approved through this step. In the event of an error during the approval process, the system generates an Excel file containing a list of products with errors. This file includes detailed information such as the error reason, as well as the product's base code and SKU number.

### Approving All Products To approve all products on the pending list, first, filter products with selected attribute sets. Then, select the **Approve All Products** option from the **Select Action** drop-down menu and click the **Apply** button. This process results in all pre-products being productized and moved to the **Product Pool** within the **Products and Catalogs** module. If any errors occur during the approval, they are processed within the **Errors and Warnings** panel located to the right of the Omnitron panel. Users can view errors here and export them as a CSV file, which includes the error reason, base code, and SKU number of the affected products. For specific errors: * For the error **"Product is not valid, missing attributes"**: Users should enter the errored attribute in the Integration>Mapping field. * For the error **"No defined attribute value"**: Users should enter the attribute in the Products and Catalogs>Product Attributes>Attributes field. * For the error **"... attribute already exists"**: Users should check the base code via the product pool. If another product with the same attributes exists, it cannot be imported with a different SKU. {% hint style="info" %} Three possible reasons for errors during the approval process: no defined attribute value, no mapping, and products previously added to the product pool. For example, if an error occurs while approving red shoes with color and size attributes, possible reasons include overlooking the definition of "Red" as a value for the "Color" attribute on the “Product Attributes” page, missing mapping for the color "Red," on the “Mapping” page or having a product with the same attributes but a different SKU in the product pool. In such cases, users need to investigate the SKU value in the product pool to resolve the error. {% endhint %} # City/District Mapping Error Logs This page provides a guide to the City/District Mapping Error Logs section under the Integration module. ## Step 1: Navigate to City/District Mapping Error Logs Page * Get access to the Omnitron panel and log into your account. * Follow the **Integration** sidebar and click the **City/District Mapping Error Logs** page.

## Step 2: Solve Error Logs * Error logs related to orders with missing city/district data are presented in two separate datatables. * For incorrect addresses, corrections can be applied. Each row displays the **Country**, **City**, **District**, **Log History**, **Value to Map**, **Error Message**, and available **Transaction**.

* At the end of each row, there are **Resolve** and **Remove** buttons. * Click the **Resolve** button to correct the address. In the ensuing popup window, make the necessary corrections, and clicking the **Resolve** button in the popup saves the corrected data to the system.

* Click the **Remove** button to remove the error log from the list.

--- [Next Page](/llms-full.txt/1)