Claims

CLM001: Get Claims

get
Authorizations
AuthorizationstringRequired
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:
cancelled_byinteger · enumOptional

Filters the claims by who initiated the cancellation.

  • 1: Customer
  • 2: Seller
Example: 1Possible 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
chevron-right
200

OK

application/json
get
/i2/claims/

CLM002: Approve Claim

post
Authorizations
AuthorizationstringRequired
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
post
/i2/claims/{id}/approve/

No content

CLM003: Reject Claim

post
Authorizations
AuthorizationstringRequired
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
post
/i2/claims/{id}/reject/

No content

CLM004: Get Claim Reasons

get
Authorizations
AuthorizationstringRequired
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
chevron-right
200

OK

application/json
get
/i2/claim-reasons/

Last updated

Was this helpful?