Akinon Release Notes (05/12/2025) are now live! Click here to learn what's new.
LogoLogo
API Reference
  • Home
  • Quick Start
  • Tutorials
  • Technical Guides
  • Release Notes
  • Glossary
  • Welcome to Akinon 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
    • Promotions
  • 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
  • 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
  • 1. Fetch Orders
  • 2. Update Orders
  • 3. Check Orders
  • 4. Fetch & Create Cancel
  • 5. Fetch & Update Order Items
  • 6. Fetch & Create Cancellation Requests
  • 7. Update Cancellation Requests

Was this helpful?

  1. Channel App Template
  2. Development Steps
  3. Encoding the Sales Channel

Orders

Tasks running under channel_app_template.app.tasks related to order integration:

1. Fetch Orders

The command located at channel.commands.orders.orders.GetOrders is executed to retrieve newly created orders from the sales channel and process them in Akinon. This command reads the orders generated in the sales channel and ensures their creation in Akinon in the desired format.

The process is managed using the fetch_and_create_order function within the OrderService.

To retrieve orders from the sales channel and convert them to the desired format, this command should be prepared according to the explanations listed below.

2. Update Orders

This command retrieves orders that need to be updated from Akinon to the sales channel and sends this data to the command located at channel.commands.orders.orders.SendUpdatedOrders. With this command, updated order information is communicated to the sales channel.

Using the command associated with the update_orders function within the OrderService, updated order information from Akinon can be sent to the sales channel.

Parameters of the update_orders function within the Order Service:

is_sync: Indicates whether the status is immediately obtained when the update on the order is sent to the sales channel. TIt specifies whether the process is Synchronous or Asynchronous.

3. Check Orders

This command retrieves the batch requests of order updates that have been asynchronously sent to the sales channel from Akinon and sends this data to the command located at channel.commands.orders.orders.CheckOrders. With this command, the current status information of the order, for which an update request has been made from the sales channel, is read.

4. Fetch & Create Cancel

Newly created cancellation order records from the sales channel are obtained via the channel.commands.orders.orders.GetCancelledOrders command and sent to Akinon. This is used with the fetch_and_create_cancel function within the OrderService.

The cancellation order data is fetched and formatted according to the parameter values listed below.

5. Fetch & Update Order Items

This command is executed to retrieve updated orders from the sales channel and transfer them to Omnitron on an OrderItem basis using the command located at channel.commands.orders.orders.GetUpdatedOrderItems, providing data in the desired format (ChannelUpdateOrderItemDto). This command ensures that the updated orders from the sales channel are read and transferred to Omnitron.

The process is managed using the fetch_and_update_order_items function within the OrderService.

To retrieve updated orders from the sales channel and convert them to the desired format, this command should be prepared according to the explanations listed below.

6. Fetch & Create Cancellation Requests

This command is used to obtain cancellation or return requests initiated in the sales channel and transfer them to Omnitron.

For this process to function correctly, the "reason_mapping" setting must be added as JSON in the update_channel_conf_schema. When filling out this value, the key should be the cancellation/return reason from the sales channel, and the value should be the primary key value corresponding to the cancellation/return reason in Akinon. The cancellation and return reasons in Akinon can be accessed from the Omnitron -> Settings menu.

The process is managed using the fetch_and_create_cancellation_requests function located within app.tasks.

The command located at channel.commands.orders.orders.GetCancellationRequests is executed to retrieve cancellation or return requests, providing data in the desired format (CancellationRequestDto).

To retrieve cancellation or return requests from the sales channel and convert them to the desired format, this command should be prepared according to the explanations listed below.

7. Update Cancellation Requests

In the case of updating cancellation or return requests previously created by the fetch_and_create_cancellation_requests function, this data is retrieved from Omnitron and sent to the sales channel.

For this process to function correctly, the "reason_mapping" setting must be added as JSON in the update_channel_conf_schema. When filling out this value, the key should be the cancellation/return reason from the sales channel, and the value should be the primary key value corresponding to the cancellation/return reason in Akinon. The cancellation and return reasons in Akinon can be accessed from the Omnitron -> Settings menu.

The process is managed using the update_cancellation_requests function located within app.tasks.

The command located at channel.commands.orders.orders.UpdateCancellationRequest is executed, providing data in the desired format to the sales channel.

When cancellation or return requests are updated by the companies, this information is processed in Omnitron. Only records of requests that were previously created with the fetch_and_create_cancellation_requests task will trigger this method when updated.

For example, after a return request has been opened, the company may have accepted or rejected it. This method is used to communicate that action to the relevant sales channel.

The channel.commands.orders.orders.UpdateCancellationRequest class that needs to be implemented is specified below.

PreviousProduct ImageNextProduct Data

Last updated 23 days ago

Was this helpful?