Docs Portal

Claims

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
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-08-29T20:42:54.404Z",
      "created_at": "2025-08-29T20:42:54.404Z"
    }
  ]
}

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

No content
post
POST /api/i2/claims/{id}/approve/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

No content

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

No content
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

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
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-08-29T20:42:54.404Z",
      "created_at": "2025-08-29T20:42:54.404Z"
    }
  ]
}
PreviousOrdersNextShipping Methods

Was this helpful?