LogoLogo
  • Welcome to Akinon Documentation
  • Products
    • ACC
    • Omnitron
    • Commerce
    • Order Management System (OMS)
    • Instore
    • Integrator
    • Marketplace Dashboard (MPD)
    • Project Zero (PZ)
    • Seller Center
    • Akifast
    • App Maker
  • API Reference
    • Welcome to Akinon API Reference
  • Omnitron
    • Getting Started
    • Integration
      • Product
        • Product
        • Pre-Product
        • Attribute
        • Attribute Value
        • Attribute Set
        • Product Image
      • Price
        • Price List
        • Product Price
        • Currency Unit Table
      • Stock
        • Stock List
        • Product Stock
      • Order
        • Get Orders
        • Search Order
        • Get Order Detail by Order Number
        • Get Order Item Detail
        • Orders ID Detail Integration
        • Orders Waiting to Send to ERP
        • Update Order and Order Item
        • Stock Reservation Release
        • Order Cancellation
        • Cancellation & Refund Pending Orders
        • Order Discount Items
        • Order Status Codes & Cancellation Statuses
      • Migration
        • Getting Started
        • User Migration
        • Address Migration
        • Old Order Migration
        • Old Order Item Migration
        • View Migration Progress
        • Currency Options
    • PIM
      • Attributes & Sets
      • Mapping
      • Localization
      • Media
    • Catalogue
      • Introduction
      • Price List
      • Stock List
      • Catalogue Item
      • Category Trees
      • Product Collection
      • Product Sorting
    • Channels
      • Introduction
      • Payments
      • Customers
    • Order
      • Getting Started
      • Fulfillment
      • Cancellations & Refunds
    • Retail Stores
      • Retail Stores
    • User Management
      • Roles & Permissions
      • Add & Remove
    • Whippy Ware
      • Introduction
      • Stock
      • Stock Lists
      • Stock List Rules
      • Stock Providers
      • Stock Locations
  • Omnitron OpenAPIs
    • Without Server
      • Customers
      • Reporting
      • Deleted Items
      • Pos
      • AttributeValues
      • Attribute Values
      • Providers
      • LDAPProviders
      • Healthcheck
      • LoyaltyTransactions
      • Policies
      • Exports
      • Dashboard
      • AuthTOTP
      • Price Lists
      • ProductPrices
      • Districts
      • Cities
      • Countries
      • Townships
      • PrometheusMetrics
      • Language
      • Content Types
      • Mappings
      • Applications
      • ApplicationPermissions
      • Error Reports
      • MailTemplates
      • UploadLogo
      • SalesChannelMarketPlaceAttributeSetConfig
      • SalesChannelCancellationRequestImage
      • SalesChannelCities
      • SalesChannelCancellationReasons
      • SalesChannelCargoCompany
      • SalesChannelProductImage
      • SalesChannelAttributeConfig
      • SalesChannelAttributeValueConfig
      • SalesChannelTownships
      • SalesChannelCustomers
      • SalesChannelFailedIntegrations
      • SalesChannelGetStockList
      • SalesChannelRetailStore
      • IntegrationActions
      • SalesChannelOrderShippingInfo
      • SalesChannelBatchRequests
      • SalesChannelAddresses
      • SalesChannelMarketPlaceAttributeSet
      • SalesChannelErrorReports
      • SalesChannelCategoryNodes
      • SalesChannelDistricts
      • SalesChannelProductStock
      • SalesChannelExtraProductStock
      • SalesChannelOrders
      • SalesChannelCancellationPlans
      • SalesChannelExtraProductPrices
      • SalesChannelProduct
      • SalesChannelAttributeSchemas
      • SalesChannelProductCategories
      • SalesChannelCancellationRequests
      • SalesChannelMarketPlaceAttributeValue
      • SalesChannelMappedProduct
      • SalesChannelMarketPlaceAttribute
      • SalesChannelOrderItem
      • SalesChannelProductPrice
      • SalesChannelCreateOrder
      • GetPriceList
      • SalesChannelCountries
      • SalesChannelGetPriceList
      • SalesChannelCategoryTree
    • With Server
      • Customers
      • Reporting
      • Deleted Items
      • Pos
      • AttributeValues
      • Attribute Values
      • Providers
      • LDAPProviders
      • Healthcheck
      • LoyaltyTransactions
      • Policies
      • Exports
      • Dashboard
      • AuthTOTP
      • Price Lists
      • ProductPrices
      • Districts
      • Cities
      • Countries
      • Townships
      • PrometheusMetrics
      • Language
      • Mappings
      • Content Types
      • Applications
      • ApplicationPermissions
      • Error Reports
      • MailTemplates
      • UploadLogo
      • SalesChannelMarketPlaceAttributeSetConfig
      • SalesChannelCancellationRequestImage
      • SalesChannelCities
      • SalesChannelCancellationReasons
      • SalesChannelCargoCompany
      • SalesChannelProductImage
      • SalesChannelAttributeConfig
      • SalesChannelAttributeValueConfig
      • SalesChannelTownships
      • SalesChannelCustomers
      • SalesChannelFailedIntegrations
      • SalesChannelGetStockList
      • IntegrationActions
      • SalesChannelRetailStore
      • SalesChannelOrderShippingInfo
      • SalesChannelBatchRequests
      • SalesChannelAddresses
      • SalesChannelMarketPlaceAttributeSet
      • SalesChannelErrorReports
      • SalesChannelDistricts
      • SalesChannelCategoryNodes
      • SalesChannelProductStock
      • SalesChannelExtraProductStock
      • SalesChannelCountries
      • SalesChannelOrders
      • SalesChannelProduct
      • SalesChannelCancellationPlans
      • SalesChannelExtraProductPrices
      • SalesChannelProductCategories
      • SalesChannelAttributeSchemas
      • SalesChannelCancellationRequests
      • SalesChannelMarketPlaceAttributeValue
      • SalesChannelMappedProduct
      • SalesChannelMarketPlaceAttribute
      • SalesChannelOrderItem
      • SalesChannelProductPrice
      • SalesChannelCreateOrder
      • GetPriceList
      • SalesChannelGetPriceList
      • SalesChannelCategoryTree
  • Commerce
    • Users
      • Getting Started
      • User Management & Authentication
      • Password & OTP Operations
      • User Profile & Segment Management
      • User Payment & Card Management
      • User Orders & Cancellations
      • Anonymous User Orders & Cancellations
      • User Support & Conversation
      • Captcha Validation
      • Currency & Akifast Operations
    • Checkout
      • Payment Related
      • Payment Strategy Related
      • Shipping Related
      • Independent Pages
    • Product
    • User Collections
    • Basket
    • Discount
    • Autocomplete
    • Breadcrumb
    • Pretty URLs
    • Menu
    • Widgets
    • Loyalty Accounts
    • Address Migration
    • Index Configuration
    • Favourite Products
    • User Address
    • Data Warehouse
    • Introduction
      • Filtering Parameters
    • Data Warehouse
    • Default
  • OMS
    • Package Services
    • Package Item Services
    • Package Denial Reason Services
    • Order Services
    • Order Item Services
    • Transfer Order Services
    • Transfer Item Services
    • Channel Services
    • Cancellation Plan Services
    • Cancellation Reason Services
    • Address Setup Services
    • City Services
    • District Services
    • Township Services
    • Stock Location Address Services
    • Webhook Setup Services
    • Webhook Event Services
    • Omnitron Order Webhooks
    • Undelivered Webhook Event Services
    • Inventory Discrepancy Services
    • OMS Setup Services
    • UI Settings Services
    • OMS Audit Events Service
    • Customer Address Services
    • Application Settings Services
    • Content Type Services
    • Customer Services
    • Channel Setup Services
    • Demo Data Service
    • Order Execution Plan Services
    • Invoice Services
    • Localization Services
    • Action Log Services
    • Order Log Services
    • Celery Metrics Service
    • Stock Location Services
    • Stock Location Address Services
    • Stock Location Sender Address Services
    • Stock Location Sender Address Setup Services
    • Cargo Company Condition Services
    • Permission Group Services
  • Instore
    • Password Reset Services
  • Integrator
    • Projects
    • Flows
    • Logs
  • Seller Center
    • Languages
    • Categories
    • Introduction
    • Products
    • Packages
    • Orders
    • Claims
    • Shipping Methods
  • Akifast
    • Authentication
  • B2B
    • Quotation
    • Basket
    • Division
    • User
    • Staff User
    • Groups
    • Notification
    • Notification Template
  • Flows
    • Shipment Flows
    • Payment Flows
    • SMS Flows
    • Basket Offer Flows
Powered by GitBook

© 2025 Akinon. All rights reserved.

On this page

Was this helpful?

  1. Omnitron OpenAPIs
  2. With Server

ApplicationPermissions

PreviousApplicationsNextError Reports

Was this helpful?

Delete Application Permission

delete

Deletes an existing Application Permission object.

Authorizations
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
204
Application Permission Deleted
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
500
Server Error
delete
DELETE /api/v1/application_permissions/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Retrieve detailed application permission

get

Get detailed information of a specific application permission

Authorizations
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
200
Detailed application permission details
application/json
403
Forbidden
404
The given resource or object was not found or does not exist.
application/json
get
GET /api/v1/application_permissions/{id}/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "pk": 1,
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": {
    "pk": 1,
    "name": "Instore application permission for store staff",
    "path": "/test/path",
    "label": "update",
    "parent": 2,
    "application": 1,
    "created_date": "2025-05-22T09:24:49.634Z",
    "modified_date": "2025-05-22T09:24:49.634Z"
  },
  "application": 1,
  "created_date": "2025-05-22T09:24:49.634Z",
  "modified_date": "2025-05-22T09:24:49.634Z"
}

List application permissions

get

Get a list of all application permissions

Authorizations
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
namestringOptional

Filters by name

applicationintegerOptional

Filter by application ID.

pathstringOptional

Filter by path

parentintegerOptional

Filter by parent product ID.

labelstringOptional

The display label of the attribute value

Example: Color
Responses
200
List of application permissions
application/json
403
Forbidden
get
GET /api/v1/application_permissions/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2025-05-22T09:24:49.634Z",
      "modified_date": "2025-05-22T09:24:49.634Z"
    }
  ]
}

List application permissions with details

get

Get a list of all application permissions with details

Authorizations
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
namestringOptional

Filters by name

applicationintegerOptional

Filter by application ID.

pathstringOptional

Filter by path

parentintegerOptional

Filter by parent product ID.

labelstringOptional

The display label of the attribute value

Example: Color
Responses
200
List of application permissions with details
application/json
get
GET /api/v1/application_permissions/detailed HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

List of application permissions with details

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2025-05-22T09:24:49.634Z",
      "modified_date": "2025-05-22T09:24:49.634Z"
    }
  ]
}

List application permission children

get

Get a list of all application permission children

Authorizations
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
applicationintegerOptional

Filter by application ID.

pathstringOptional

Filter by path

parentintegerOptional

Filter by parent product ID.

labelstringOptional

The display label of the attribute value

Example: Color
namestringOptional

Filters by name

Responses
200
List of application permission children
application/json
403
Forbidden
get
GET /api/v1/application_permissions/children/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
[
  {
    "pk": 1,
    "name": "Instore application permission for store staff",
    "path": "/test/path",
    "label": "update",
    "parent": 2,
    "application": 1,
    "created_date": "2025-05-22T09:24:49.634Z",
    "modified_date": "2025-05-22T09:24:49.634Z"
  }
]
  • GETRetrieve application permission
  • PUTUpdate Application Permission
  • DELETEDelete Application Permission
  • PATCHPartially Update Application Permission
  • GETRetrieve detailed application permission
  • GETList application permissions
  • POSTCreate Application Permission
  • GETList application permissions with details
  • GETList application permission children

Retrieve application permission

get

Get details of a specific application permission

Authorizations
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
200
Application permission details
application/json
403
Forbidden
404
The given resource or object was not found or does not exist.
application/json
get
GET /api/v1/application_permissions/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "pk": 1,
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1,
  "created_date": "2025-05-22T09:24:49.634Z",
  "modified_date": "2025-05-22T09:24:49.634Z"
}

Update Application Permission

put

Updates an existing Application Permission object.

Authorizations
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Body
namestringOptional

The name of the application permission.

Example: Instore application permission for store staff
pathstringOptional

The path of the application permission.

Example: /test/path
labelstringOptional

The label of the application permission.

Example: update
parentintegerOptional

Unique identifier for the parent application permission.

Example: 2
applicationintegerOptional

Unique identifier for the related application.

Example: 1
Responses
200
Application Permission Updated
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
put
PUT /api/v1/application_permissions/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1
}
{
  "pk": 1,
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1,
  "created_date": "2025-05-22T09:24:49.634Z",
  "modified_date": "2025-05-22T09:24:49.634Z"
}

Partially Update Application Permission

patch

Partially updates an existing Application Permission object.

Authorizations
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Body
namestringOptional

The name of the application permission.

Example: Instore application permission for store staff
pathstringOptional

The path of the application permission.

Example: /test/path
labelstringOptional

The label of the application permission.

Example: update
parentintegerOptional

Unique identifier for the parent application permission.

Example: 2
applicationintegerOptional

Unique identifier for the related application.

Example: 1
Responses
200
Application Permission Partially Updated
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
patch
PATCH /api/v1/application_permissions/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1
}
{
  "pk": 1,
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1,
  "created_date": "2025-05-22T09:24:49.634Z",
  "modified_date": "2025-05-22T09:24:49.634Z"
}

Create Application Permission

post

Creates a new Application Permission object.

Authorizations
Body
namestringOptional

The name of the application permission.

Example: Instore application permission for store staff
pathstringOptional

The path of the application permission.

Example: /test/path
labelstringOptional

The label of the application permission.

Example: update
parentintegerOptional

Unique identifier for the parent application permission.

Example: 2
applicationintegerOptional

Unique identifier for the related application.

Example: 1
Responses
201
Application Permission Created
application/json
400
Required field(s) are missing, data is invalid, or the action is not allowed.
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
500
Server Error
post
POST /api/v1/application_permissions/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1
}
{
  "pk": 1,
  "name": "Instore application permission for store staff",
  "path": "/test/path",
  "label": "update",
  "parent": 2,
  "application": 1,
  "created_date": "2025-05-22T09:24:49.634Z",
  "modified_date": "2025-05-22T09:24:49.634Z"
}