Akinon Release Notes (05/26/2025) are now live! Click here to learn what's new.
LogoLogo
API Reference
  • Home
  • Quick Start
  • Tutorials
  • Technical Guides
  • Release Notes
  • Glossary
  • Welcome to Akinon Technical Guides
  • ACC
    • ACC CLI
    • Create Application via CLI
    • Deploy Environment Variables
    • App Store for Developers
  • Omnitron
    • Product Types
    • Product Categorization
    • Splitting a Merged Order Item
  • Commerce
    • Shipping Rules Calculator
    • Data Source Shipping Options
    • Attribute Based Shipping Options
    • Filtering Products
    • Conversation & Messages
    • Sitemap Configuration
    • Weight-Based Product Sales
    • Group Attribute Sets
    • Contract Management
    • Find in Store for Whippy Ware
    • Plugins
    • Remote Price
    • E-mail Templates
    • Loyalty Accounts
    • Search Structure
    • User Segmentation & Rules
    • Configuring User Segmentation
    • Promotions
    • Email Redirection in Multi-Frontend Structure
  • OMS
    • Getting Started with OMS
    • Basic Setup
    • Scenarios
    • Capacity Feature
    • Package Management
      • Packages
      • Transfer
      • States
    • Commands
      • Packages
        • Package Command Parameters
        • DeAllocate Package Reservations Command
        • Channel Based Complete Packaging without Shipment Command
        • Complete Packaging with Shipment Command
        • Complete Packaging without Shipment Command
        • Package Refuse with Denial Reason Command
        • Product Not Found & Wrong Product Command
        • Product Not Found & Wrong Product Command Advanced
        • Package Packed for Refund Command
        • Block The Package For Action Command
        • Unblock the Package For Action Command
        • Update The Package’s Invoice
        • Manual Planning Command
      • Transfer
        • Transfer Order Advanced Command
        • Product for Transfer Not Found & Wrong Product Command
        • Transfer Delivered Command
        • Transfer Dispatch Command
        • Transfer Ready for Dispatch Command
        • Transfer Out Of Stock
      • Shipment
        • Shipment Order Command
        • Package Advanced Shipment Command
        • Ship The Package Command
        • Ship The Package without Shipment Integration Command
        • Update The Package’s Shipment Status Command
        • Update Shipment Info of Package Command
    • Inventory Locations & Engine
      • Properties & Domain Relation
      • Customization
      • Inventory Engine
    • Fulfillment
      • Shipments
      • Invoice Integration
    • Webhooks
      • Webhook Examples
        • Order Webhook
        • Package Webhook
        • Shipment Webhook
        • Stock Location Webhook
        • Transfer Webhook
    • Integrating OMS with Seller Center
  • Instore
    • Getting Started
    • Cash Register Integration
    • OTP (One Time Password) Process
    • Services
      • Password Reset Services
  • Marketplace Dashboard
    • N11 Marketplace Setup Configurations
    • Trendyol Marketplace Setup Configurations
    • Walmart Marketplace Setup Configurations
    • Amazon Marketplace Setup Configurations
    • Hepsiburada Marketplace Setup Configurations
    • Fashfed Marketplace Setup Configurations
    • Mono Marketplace Setup Configurations
    • Package Splitting Flow
    • Marketplace Dashboard Flow Trigger
  • Project Zero
    • Django
      • Basic Setup
      • Project Structure
        • Templates & Components
        • Private Dependencies
        • Omnife Project Submodule
        • Webpack
        • ESLint Rules
        • Bundles
        • Multilanguage & Translation
        • Environmental File
        • Custom Error Pages
        • Icon Font
      • Page Types
        • Static Pages & Flatpages
        • Account Page
          • Template Rendering in Account Pages
          • Forms & Validation
        • Basket Page
          • Redux Basket State
          • Basket Page - View
        • Checkout
          • Redux Checkout State
          • View & Template Rendering
          • Masking & Validation
      • Theming & Styling
      • Widgets
      • SEO Management
      • Extending Project Zero
    • Next.js
      • Basic Setup
      • Deployment
      • Static Assets
      • Plugins
      • Widgets
      • Icons
      • Localization
      • SEO Management
      • Advanced Usage
      • Data Fetching
        • Client
          • Account
          • Address
          • Basket
          • Checkout
          • Misc
          • Product
          • User
          • Wishlist
        • Server
          • Category
          • Flat Page
          • List
          • Menu
          • Product
          • SEO
          • Special Page
          • Widget
  • App Maker
    • Setup Your Environment
    • Plugin Quickstart
    • Create Project
    • Setup Existing Project
    • Deploy Project
    • Users and Roles
    • Add Public Key
    • App Maker CLI
    • Create App on Stores
      • Creating App on Apple App Store
      • Creating App on Google Play Store
    • Mobile App Framework
      • Configuration
      • Framework
      • Project Structure
        • Structure
        • Data Containers
        • Pages
      • Dependency Integration
        • Plugins
        • Akinon Plugin Adapter
  • Akifast
    • HPP
      • Getting Started
      • Authorization
      • Payment Session Creation
        • Key Points Before Creating a Payment Session
        • Creating Payment Session
        • Redirecting to the Payment Page
        • Errors Encountered During Payment Session Creation
      • Merchant Services
        • Shipping Query URL
        • Agreement Query URL
        • Other URLs
  • B2B
    • Getting Started
    • B2B Setup
  • Adds-on
    • Invoicer
      • Introduction
      • Invoice & Pay On Delivery Service
  • Channel App Template
    • Introduction
    • Installation and Usage
    • Development Steps
      • Folder Structure
      • Starting Step
      • Encoding the Sales Channel
        • Introduction
        • Setup
        • Products
        • Product Price
        • Product Stock
        • Product Image
        • Orders
        • Product Data
      • Adding a New Command to Akinon
      • Listening for External Requests
    • Architecture
      • Introduction
      • Integration
      • Services (Flows)
        • Introduction
        • Product Service
        • Price Service
        • Stock Service
        • Image Service
        • Order Service
  • Multi Regional Settings
    • Multi Regional Settings
Powered by GitBook

© 2025 Akinon. All rights reserved.

On this page
  • Steps to Configure User Segmentation
  • How to Send Requests from the Frontend
  • Sending Requests to Commerce
  • Additional Notes

Was this helpful?

  1. Commerce

Configuring User Segmentation

PreviousUser Segmentation & RulesNextPromotions

Last updated 10 days ago

Was this helpful?

User segmentation is a feature that allows businesses to define specific rules to categorize users into different groups based on their characteristics. This segmentation helps in assigning customized pricing and stock availability to different user groups. If a user qualifies for multiple segments, the system applies rules in order of priority, assigning the user to the first matching segment. This document outlines the necessary steps to configure user segmentation and how to make requests.

Steps to Configure User Segmentation

  1. Define Segmentation Rules (Required)

To start with user segmentation, you must define the rules that determine how users will be segmented. You can find more details on the rule configuration process in the document.

Rule-based segmentation: The first rule that matches a user will apply, so make sure to set priorities for your rules.

  1. Price and Stock Lists (Optional)

If you do not provide custom price and stock lists, the default catalog lists will be used.

You can create extra price and stock lists if needed. These lists should have a specific code and can be added through the UI or via a POST/PATCH request using .

  1. Priority Configuration

Each user can only belong to one segment. The priority determines which rule will be applied if a user fits multiple segments. Rules will be evaluated in order of priority, and the first matching rule will assign the user to a segment. More details about rule prioritization can be found .

  1. Custom Price and Stock List Management

To use custom price and stock lists, they need to be associated with a specific code. These custom lists should be added to the catalog. After adding, it may take some time for the lists to sync with the catalog, and only after syncing will they appear under the relevant segment’s price and stock lists.

If default price and stock lists should not be used, extra price and stock lists can be added. To enable segment-specific stock and price lists, the lists must be created with a code.

  • Currently, the code field appears only when ERP connection is selected in the UI, or it can be set via a PATCH request: .

  • The defined extra price and stock lists should be added to the catalog as extra lists.

  • It takes time for these lists to sync with the Commerce system. They will only appear under the relevant segment's price and stock lists after synchronization.

  • For products to be reflected under extra price and stock lists in Commerce, they must also be included in the default price and stock lists.

  1. Currency Handling in Price Lists

If you want to create price lists for different currencies, you need to update the following settings in the sales channel’s dynamics settings:

  • AVAILABLE_CURRENCIES

  • DEFAULT_CURRENCY

  • READ_CURRENCY_FROM_HEADER – Ensures currency is read from the FE request header.

How to Send Requests from the Frontend

Header-Based Configuration

All frontend requests that are dependent on user segmentation must include the following headers:

  • Authorization: Bearer token for user authentication and authorization.

  • Currency: Currency code (e.g., USD, EUR, TRY) to identify which price list to use.

Example Request:

GET /endpoint HTTP/1.1
Host: api.example.com
Authorization: Bearer <access_token>
Currency: USD

Sending Requests to Commerce

When making requests to Commerce, the correct header format should be followed to ensure the segmentation settings apply. Headers should include necessary values such as user segment information and currency to properly reflect the segmentation rules.

Required Headers for Commerce:

  • Authorization: JWT or OAuth2 bearer token

  • Currency: Active currency code

  • User-Segment: The segment code assigned to the user (e.g., premium_users). If not provided, Commerce evaluates based on user ID and rule matching.

Example Request to Commerce:

GET /comm-endpoint HTTP/1.1
Host: api.example.com
Authorization: Bearer <access_token>
User-Segment: premium_users
Currency: EUR

Additional Notes

Category Tree Usage

When making requests from the front end, relevant values should be included either in the request header as key-value pairs or in cookies. More details and examples on setting currency in the FE can be found .

All segments use the same .

If certain products need to be hidden within specific segments, dynamic exclude can be used: .

here
category tree
User Segmentation
this APIs
Update Price List
here
Dynamic Exclude