Skladon - Developers
  • Skladon docs
  • 馃摗Integration
    • API
      • API usage tips and limits
      • Authentication
      • Claims
      • Files
      • Orders
      • Products
      • Products availability
      • Products sets
      • Receivings
      • Returns
      • Shipper service codes
      • Webhooks
      • Stock movements
    • Webhooks
  • Report a Bug
Powered by GitBook
On this page
  1. Integration
  2. API

Claims

PreviousAuthenticationNextFiles

Last updated 1 year ago

You may find descriptions of endpoints for work with claims bellow.

馃摗
  • POSTFilter claims
  • GETGet claim
  • POSTCreate claim
  • PUTUpdate claim

Get claim

get
Authorizations
Path parameters
eshopClaimIdstringRequired
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Responses
200
Success response
application/json
401
Unauthorized response
application/json
404
Not found response
application/json
get
GET /v2/claims/{eshopClaimId} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Accept: */*

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "eshopClaimId": "text",
    "eshopOrderId": "text",
    "description": "text",
    "note": "text",
    "eshopNote": "text",
    "claimCause": "lost",
    "claimCauseOthersType": "text",
    "files": [
      {
        "fileName": "invoice.pdf",
        "fileType": "invoice",
        "fileSize": "text",
        "type": "invoice",
        "data": "someBase64",
        "id": 1
      }
    ],
    "products": [
      {
        "claimedQuantity": 1,
        "sku": "text",
        "lineState": "E",
        "resendQuantity": 1
      }
    ],
    "transportPrice": 2990,
    "goodsPrice": 2990,
    "totalServicePrice": 2990,
    "compensationCurrency": "CZK",
    "status": "received"
  }
}

Filter claims

post
Authorizations
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
pageinteger 路 min: 1Optional

Page number, can be used for pagination

Default: 1Example: 1
itemsinteger 路 min: 1 路 max: 1000Optional

items per page

Default: 10Example: 30
Responses
200
Success response
application/json
401
Unauthorized response
application/json
post
POST /v2/claims/filter HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "page": 1,
  "items": 30,
  "columns": [
    "eshopClaimId",
    "claimCause",
    "status"
  ],
  "sorts": [
    {
      "column": "eshopClaimId",
      "direction": "DESC"
    }
  ],
  "filters": [
    [
      {
        "column": "claimCause",
        "operator": "eq",
        "value": "lost"
      }
    ]
  ]
}
{
  "statusCode": 200,
  "message": "text",
  "data": {
    "data": [
      {
        "eshopClaimId": "text",
        "eshopOrderId": "text",
        "description": "text",
        "note": "text",
        "eshopNote": "text",
        "claimCause": "lost",
        "claimCauseOthersType": "text",
        "files": [
          {
            "fileName": "invoice.pdf",
            "fileType": "invoice",
            "fileSize": "text",
            "type": "invoice",
            "data": "someBase64",
            "id": 1
          }
        ],
        "products": [
          {
            "claimedQuantity": 1,
            "sku": "text",
            "lineState": "E"
          }
        ]
      }
    ],
    "request": {
      "page": 1,
      "items": 30,
      "columns": [
        "eshopClaimId",
        "claimCause",
        "status"
      ],
      "sorts": [
        {
          "column": "eshopClaimId",
          "direction": "DESC"
        }
      ],
      "filters": [
        [
          {
            "column": "claimCause",
            "operator": "eq",
            "value": "lost"
          }
        ]
      ]
    },
    "totalCount": 430
  }
}

Create claim

post
Authorizations
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
eshopClaimIdstring 路 min: 1Required
eshopOrderIdstring 路 min: 1Required
descriptionstring 路 min: 1Required
notestring 路 min: 1Optional
eshopNotestringOptional
claimCausestring 路 enumRequiredPossible values:
claimCauseOthersTypestring 路 min: 1Optional
Responses
200
Success response
application/json
401
Unauthorized response
application/json
404
Not found response
application/json
409
Conflict response
application/json
post
POST /v2/claims HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 326

{
  "eshopClaimId": "text",
  "eshopOrderId": "text",
  "description": "text",
  "note": "text",
  "eshopNote": "text",
  "claimCause": "lost",
  "claimCauseOthersType": "text",
  "files": [
    {
      "fileName": "invoice.pdf",
      "fileType": "invoice",
      "fileSize": "text",
      "type": "invoice",
      "data": "someBase64"
    }
  ],
  "products": [
    {
      "claimedQuantity": 1,
      "sku": "text",
      "lineState": "E"
    }
  ]
}
{
  "statusCode": 200,
  "message": "text",
  "data": {
    "eshopClaimId": "text",
    "eshopOrderId": "text",
    "description": "text",
    "note": "text",
    "eshopNote": "text",
    "claimCause": "lost",
    "claimCauseOthersType": "text",
    "files": [
      {
        "fileName": "invoice.pdf",
        "fileType": "invoice",
        "fileSize": "text",
        "type": "invoice",
        "data": "someBase64",
        "id": 1
      }
    ],
    "products": [
      {
        "claimedQuantity": 1,
        "sku": "text",
        "lineState": "E",
        "resendQuantity": 1
      }
    ],
    "transportPrice": 2990,
    "goodsPrice": 2990,
    "totalServicePrice": 2990,
    "compensationCurrency": "CZK",
    "status": "received"
  }
}

Update claim

put
Authorizations
Path parameters
eshopClaimIdstringRequired
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
eshopClaimIdstring 路 min: 1Required
eshopOrderIdstring 路 min: 1Required
descriptionstring 路 min: 1Required
notestring 路 min: 1Optional
eshopNotestringOptional
claimCausestring 路 enumRequiredPossible values:
claimCauseOthersTypestring 路 min: 1Optional
Responses
200
Success response
application/json
401
Unauthorized response
application/json
404
Not found response
application/json
put
PUT /v2/claims/{eshopClaimId} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 333

{
  "eshopClaimId": "text",
  "eshopOrderId": "text",
  "description": "text",
  "note": "text",
  "eshopNote": "text",
  "claimCause": "lost",
  "claimCauseOthersType": "text",
  "files": [
    {
      "fileName": "invoice.pdf",
      "fileType": "invoice",
      "fileSize": "text",
      "type": "invoice",
      "data": "someBase64",
      "id": 1
    }
  ],
  "products": [
    {
      "claimedQuantity": 1,
      "sku": "text",
      "lineState": "E"
    }
  ]
}
{
  "statusCode": 200,
  "message": "text",
  "data": {
    "eshopClaimId": "text",
    "eshopOrderId": "text",
    "description": "text",
    "note": "text",
    "eshopNote": "text",
    "claimCause": "lost",
    "claimCauseOthersType": "text",
    "files": [
      {
        "fileName": "invoice.pdf",
        "fileType": "invoice",
        "fileSize": "text",
        "type": "invoice",
        "data": "someBase64",
        "id": 1
      }
    ],
    "products": [
      {
        "claimedQuantity": 1,
        "sku": "text",
        "lineState": "E",
        "resendQuantity": 1
      }
    ],
    "transportPrice": 2990,
    "goodsPrice": 2990,
    "totalServicePrice": 2990,
    "compensationCurrency": "CZK",
    "status": "received"
  }
}