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

Was this helpful?

  1. Channel App Template
  2. Architecture
  3. Services (Flows)

Order Service

The Order Service handles actions such as creating, updating, and canceling orders. To perform these actions, it relies on the integrations with OmnitronIntegration and ChannelIntegration.

class OrderService (object)

Fetch and Create Order

(self, is_success_log=True)

This function first connects to the Sales Channel and fetches any existing orders. Afterward, it sends the orders to Akinon via the create_order function. If an error occurs during the process, an error_report is generated in the Sales Channel logs.

Create Order

(self, omnitron_integration: OmnitronIntegration, channel_order: ChannelCreateOrderDto) → Union[Order, None]

This function enables the transfer of orders from the Sales Channel to Akinon. It sequentially writes the customer and address information from the Sales Channel to Akinon, capturing the responses returned. It also reads the corresponding shipping carrier information from Akinon, ensuring that all the necessary details for creating the order are collected. Finally, the order information is sent to Akinon.

Update Orders

(self, is_sync=True, is_success_log=True)

This function first connects to Akinon Omnitron and fetches the updated orders that can be transmitted to the Sales Channel. Afterward, it sends these orders to the Sales Channel via the send_updated_orders command. Based on the value of the is_sync parameter, it determines whether the communication with the Sales Channel will be synchronous or asynchronous. If asynchronous, the necessary records are created via the batch_service. If an error occurs during the process, an error_report is generated in the Sales Channel logs.

Get Order Batch Requests

(self, is_success_log=False)

This function first connects to Akinon Omnitron and retrieves the batch_requests that have been sent to create or update orders and are currently in process. It then queries the Sales Channel using the check_orderscommand. If an error occurs during this process, an error_report is generated in the Sales Channel logs. Finally, the response from the Sales Channel is forwarded to Akinon Omnitron, completing the flow.

Fetch and Create Cancel

(self, is_success_log=True)

This function first connects to the Sales Channel and retrieves any canceled orders. It then sends the cancellations to Akinon via the create_cancel function. If an error occurs during this process, an error_report is generated in the Sales Channel logs.

Create Cancel

(self, omnitron_integration: OmnitronIntegration, cancel_order_dto: CancelOrderDto)

This function enables the transfer of order cancellations from the Sales Channel to Akinon. It sends the cancellations to Akinon through the create_order_cancelcommand, passing the relevant order cancellations as parameters.

Fetch and Update Order Items

(self, is_success_log=True)

This function first connects to the Sales Channel and fetches the updated orders. It then sends the updates to Omnitron via the update_order_items command, updating the details on an OrderItem basis. If an error occurs during this process, an error_report is generated in the Sales Channel logs.

PreviousImage ServiceNextMulti Regional Settings

Was this helpful?