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
  • Inventory (Stock) Location APIs
  • GET Stock Location List​
  • POST Create Stock Location​
  • PATCH Update Stock Location​
  • PATCH Add Releated Adress​
  • DELETE Remove Related Address​
  • GET List Related Address​
  • GET List Stok Location Category​
  • POST Create Stock Location Category​

Was this helpful?

  1. OMS
  2. Inventory Locations & Engine

Customization

Inventory (Stock) Location APIs

GET Stock Location List​

Path: /api/v1/oms/stocklocations/

Response

{
  "count": 1,
  "next": "/api/v1/oms/stocklocations/?page=2",
  "previous": null,
  "results": [
    {
      "id": 0,
      "stock_location_type": "store",
      "address": {
        "id": 26930,
        "mapping": null,
        "country": {
          "pk": 1,
          "name": "Türkiye",
          "code": "tr",
          "is_active": true,
          "longitude": null,
          "latitude": null
        },
        "city": {
          "pk": 32,
          "name": "ESKİŞEHİR",
          "country": 1,
          "is_active": true,
          "longitude": null,
          "latitude": null
        },
        "township": {
          "pk": 370,
          "name": "ODUNPAZARI",
          "city": 32,
          "is_active": true,
          "longitude": null,
          "latitude": null
        },
        "district": {
          "pk": 28671,
          "name": " MAH",
          "city": 32,
          "township": 370,
          "is_active": true,
          "longitude": null,
          "latitude": null
        },
        "title": " Toprak",
        "is_active": true,
        "line": "--",
        "postcode": null,
        "notes": null,
        "longitude": "30.50768700",
        "latitude": "39.77443700"
      },
      "engine": 1,
      "category": null,
      "created_date": "2021-05-21T09:06:28.524204Z",
      "modified_date": "2021-05-21T09:06:28.524233Z",
      "omnitron_id": null,
      "name": "Kırmızı Toprak",
      "is_fulfillment_center": true,
      "is_pickup_location": false,
      "is_delivery_location": false,
      "is_return_available": false,
      "is_fast_delivery_available": null,
      "is_active": true,
      "priority": 1,
      "conf": {},
      "daytime_phone": "00000000000",
      "evening_phone": "00000000000",
      "fax_number": "",
      "email": "",
      "target_packing_interval": "5 00:00:00",
      "target_transfer_interval": "3 00:00:00",
      "erp_code": "--",
      "use_as_shipper_location": false
    }
  ]
}

POST Create Stock Location​

Path: /api/v1/oms/stocklocations/

{
    "stock_location_type":"store",
    "address" :{
        "city" : {
            "name":"Adana",
            "country":"Türkiye",
            "is_active":1,
            "longitude":1,
            "latitude":1
        },
        "country":{
            "code":"TR",
             "name":"Adana",
            "country":"Türkiye",
            "is_active":1,
            "longitude":1,
            "latitude":1
        },
        "township":{
            "name":"Adana",
            "country":"Türkiye",
            "is_active":1,
            "longitude":1,
            "latitude":1
        },
        "district":{
              "name":"Adana",
            "country":"Türkiye",
            "is_active":1,
            "longitude":1,
            "latitude":1,
            "township":11
        }
    }
}

PATCH Update Stock Location​

Path: /api/v1/oms/stocklocations/

{
    "stock_location_type":"store",
    "address" :{
        "city" : {
            "name":"Adana",
            "country":"Türkiye",
            "is_active":1,
            "longitude":1,
            "latitude":1
        },
        "country":{
            "code":"TR",
             "name":"Adana",
            "country":"Türkiye",
            "is_active":1,
            "longitude":1,
            "latitude":1
        },
        "township":{
            "name":"Adana",
            "country":"Türkiye",
            "is_active":1,
            "longitude":1,
            "latitude":1
        },
        "district":{
              "name":"Adana",
            "country":"Türkiye",
            "is_active":1,
            "longitude":1,
            "latitude":1,
            "township":11
        }
    }
}

PATCH Add Releated Adress​

Path: /api/v1/oms/stocklocations/{id}/related_address/

{
    "title": "New Adres",
    "is_active": true,
    "line": "Line lorem ipsum dolor sit amet.",
    "postcode": "600652",
    "notes": "Note lorem ipsum dolor sit amet.",
    "longitude": "41.56583730",
    "latitude": "41.75196010",
    "country":2,
    "city":11,
    "township":5,
    "district": 2
}

DELETE Remove Related Address​

Path: /api/v1/oms/stocklocations/{id}/related_address/{related_id}

Response

null

GET List Related Address​

Path: /api/v1/oms/stocklocations/{id}/related_address/

Response

{
    "title": "New Adres",
    "is_active": true,
    "line": "Line lorem ipsum dolor sit amet.",
    "postcode": "600652",
    "notes": "Note lorem ipsum dolor sit amet.",
    "longitude": "41.56583730",
    "latitude": "41.75196010",
    "country":2,
    "city":11,
    "township":5,
    "district": 2
}

GET List Stok Location Category​

Request

Path: /api/v1/oms/stocklocation-categories/

Response

{
    "count": 1,
    "next": "",
    "previous": "",
    "results": [  {
        "name":"xxx",
        "remote_id":"xxx"
    }]
}
 

POST Create Stock Location Category​

Path: /api/v1/oms/stocklocation-categories/

    {
        "name":"xxx",
        "remote_id":"xxx"
    }
PreviousProperties & Domain RelationNextInventory Engine

Last updated 23 days ago

Was this helpful?