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
  • OMS OpenAPIs
    • Package Services
      • Default
    • Transfer Order Services
      • Default
  • 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. Seller Center

Claims

PreviousOrdersNextShipping Methods

Was this helpful?

CLM001: Get Claims

get
Authorizations
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset.

Default: 1
limitinteger · min: 1Optional

Specifies the row count of the current page.

Default: 10
typestring · enumOptional

Filters the claims by type.

Example: cancelPossible values:
statusstring · enumOptional

Filters the claims by status. Possible values are:

  • open: The claim is open.
  • waiting: The claim is waiting for approval.
  • approved: The claim has been approved.
  • rejected: The claim has been rejected.
  • completed: The claim has been completed.
Example: waitingPossible values:
status__instring[]Optional

Multiple values can be provided with a comma-separated list. Filters the claims by status. Possible values are:

  • open: The claim is open.
  • waiting: The claim is waiting for approval.
  • approved: The claim has been approved.
  • rejected: The claim has been rejected.
  • completed: The claim has been completed.
updated_atstring · date-timeOptional

Filters data where the "updated_at" field is exactly equal to a specified value.

updated_at__gtestring · date-timeOptional

Filters data where the "updated_at" field is greater than or equal to a specified value.

updated_at__ltestring · date-timeOptional

Filters data where the "updated_at" field is less than or equal to a specified value.

created_atstring · date-timeOptional

Filters data where the "created_at" field is exactly equal to a specified value.

created_at__gtestring · date-timeOptional

Filters data where the "created_at" field is greater than or equal to a specified value.

created_at__ltestring · date-timeOptional

Filters data where the "created_at" field is less than or equal to a specified value.

Header parameters
Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses
200
OK
application/json
Responseall of
401
Unauthorized
application/json
500
Unexpected error.
get
GET /api/i2/claims/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "count": 1,
  "next": "https://seller-center.akinon.com/api/i2/resource?page=2&limit=10",
  "previous": null,
  "results": [
    {
      "id": "f3909f53-a535-40cc-8d50-de0cd047aedd",
      "package_item": "2595053219311870-1",
      "product": "AKN-TSHRT-RD",
      "reason": {
        "id": "8b33a4f8-a580-42e1-879f-6f31e296eb1b",
        "subject": "Damaged",
        "translations": {
          "en-us": "Damaged",
          "en-gb": "Damaged"
        }
      },
      "detail": "The product was damaged during shipment.",
      "return_code": "R-5124412",
      "return_tracking_number": "3457623412",
      "return_tracking_url": "https://akinon.com/track/3457623412",
      "type": "refund",
      "status": "waiting",
      "updated_at": "2025-05-22T11:36:17.718Z",
      "created_at": "2025-05-22T11:36:17.718Z"
    }
  ]
}

CLM002: Approve Claim

post
Authorizations
Path parameters
idstring · uuidRequired

Unique identifier for the claim.

Example: f3909f53-a535-40cc-8d50-de0cd047aedd
Header parameters
Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses
204
No Content
400
Missing required field(s), invalid data or invalid action.
application/json
401
Unauthorized
application/json
404
Given resource or object is not found or available.
application/json
500
Unexpected error.
post
POST /api/i2/claims/{id}/approve/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

No content

CLM004: Get Claim Reasons

get
Authorizations
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset.

Default: 1
limitinteger · min: 1Optional

Specifies the row count of the current page.

Default: 10
Header parameters
Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses
200
OK
application/json
Responseall of
401
Unauthorized
application/json
500
Unexpected error.
get
GET /api/i2/claim-reasons/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "count": 1,
  "next": "https://seller-center.akinon.com/api/i2/resource?page=2&limit=10",
  "previous": null,
  "results": [
    {
      "id": "a308d734-96d2-4f1e-a804-0f8f01bbc20d",
      "subject": "Damaged",
      "translations": {
        "en-us": "Damaged",
        "en-gb": "Damaged"
      },
      "type": "refund",
      "updated_at": "2025-05-22T11:36:17.718Z",
      "created_at": "2025-05-22T11:36:17.718Z"
    }
  ]
}
  • GETCLM001: Get Claims
  • POSTCLM002: Approve Claim
  • POSTCLM003: Reject Claim
  • GETCLM004: Get Claim Reasons

CLM003: Reject Claim

post
Authorizations
Path parameters
idstring · uuidRequired

Unique identifier for the claim.

Example: f3909f53-a535-40cc-8d50-de0cd047aedd
Header parameters
Accept-LanguagestringOptional

Specifies the communication language of the API.

Body
reasonstringRequired

Reason for rejecting the claim.

Example: Damaged
imagesstring · uri[]Optional

URL for the image associated with the claim.

Example: https://akinon.com/images/claim/2595053219311870-1.jpg
Responses
204
No Content
400
Missing required field(s), invalid data or invalid action.
application/json
401
Unauthorized
application/json
404
Given resource or object is not found or available.
application/json
500
Unexpected error.
post
POST /api/i2/claims/{id}/reject/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "reason": "Damaged",
  "images": [
    "https://akinon.com/images/claim/2595053219311870-1.jpg"
  ]
}

No content