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

Returns

PreviousReceivingsNextShipper service codes

Last updated 4 months ago

You may find descriptions of endpoints for work with returned orders bellow.

馃摗
  • POSTFilter returns
  • GETGet return
  • POSTCreate return
  • PUTUpdate return

Get return

get
Authorizations
Path parameters
eshopReturnIdstringRequired
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/returns/{eshopReturnId} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Accept: */*

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "eshopReturnId": "eshopReturnId",
    "eshopOrderId": "eshopOrderId",
    "note": "text",
    "eshopNote": "text",
    "description": "Wrong shoe size",
    "shipper": "DHL",
    "trackingNumber": "AB12345",
    "shipperServiceCode": "DHLEU",
    "orderType": "b2c",
    "returnedOrderProducts": [
      {
        "quantity": 1,
        "received": 1,
        "returnReason": "exchange",
        "resolution": "returnToInventory",
        "sku": "text",
        "lineState": "text"
      }
    ],
    "files": [
      {
        "data": "someBase64",
        "type": "invoice",
        "fileName": "123456.PDF",
        "fileType": "PDF",
        "fileSize": "text",
        "id": 1
      }
    ],
    "rma": "RMA-123",
    "createdAt": "2022-05-23T18:43:10.000Z",
    "status": "received"
  }
}

Filter returns

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/returns/filter HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "page": 1,
  "items": 30,
  "columns": [
    "eshopReturnId",
    "shipper",
    "status"
  ],
  "sorts": [
    {
      "column": "eshopReturnId",
      "direction": "DESC"
    }
  ],
  "filters": [
    [
      {
        "column": "orderType",
        "operator": "eq",
        "value": "b2c"
      }
    ]
  ]
}
{
  "statusCode": 200,
  "message": "text",
  "data": {
    "data": [
      {
        "eshopReturnId": "eshopReturnId",
        "eshopOrderId": "eshopOrderId",
        "note": "text",
        "eshopNote": "text",
        "description": "Wrong shoe size",
        "shipper": "DHL",
        "trackingNumber": "AB12345",
        "shipperServiceCode": "DHLEU",
        "orderType": "b2c",
        "returnedOrderProducts": [
          {
            "quantity": 1,
            "returnReason": "exchange",
            "resolution": "returnToInventory",
            "sku": "text",
            "lineState": "E"
          }
        ],
        "files": [
          {
            "data": "someBase64",
            "type": "invoice",
            "fileName": "123456.PDF",
            "fileType": "PDF",
            "fileSize": "text",
            "id": 1
          }
        ]
      }
    ],
    "request": {
      "page": 1,
      "items": 30,
      "columns": [
        "eshopReturnId",
        "shipper",
        "status"
      ],
      "sorts": [
        {
          "column": "eshopReturnId",
          "direction": "DESC"
        }
      ],
      "filters": [
        [
          {
            "column": "orderType",
            "operator": "eq",
            "value": "b2c"
          }
        ]
      ]
    },
    "totalCount": 430
  }
}

Create return

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
eshopReturnIdstringRequiredExample: eshopReturnId
eshopOrderIdstring 路 min: 1OptionalExample: eshopOrderId
notestringOptional
eshopNotestringOptional
descriptionstring 路 min: 1OptionalExample: Wrong shoe size
shipperstring 路 min: 1OptionalExample: DHL
trackingNumberstring 路 min: 1OptionalExample: AB12345
shipperServiceCodestringOptionalExample: DHLEU
orderTypestring 路 enumRequiredExample: b2cPossible values:
Responses
200
Success response
application/json
401
Unauthorized response
application/json
409
Conflict response
application/json
post
POST /v2/returns HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 455

{
  "eshopReturnId": "eshopReturnId",
  "eshopOrderId": "eshopOrderId",
  "note": "text",
  "eshopNote": "text",
  "description": "Wrong shoe size",
  "shipper": "DHL",
  "trackingNumber": "AB12345",
  "shipperServiceCode": "DHLEU",
  "orderType": "b2c",
  "returnedOrderProducts": [
    {
      "quantity": 1,
      "returnReason": "exchange",
      "resolution": "returnToInventory",
      "sku": "text",
      "lineState": "E"
    }
  ],
  "files": [
    {
      "data": "someBase64",
      "type": "invoice",
      "fileName": "123456.PDF",
      "fileType": "PDF",
      "fileSize": "text"
    }
  ]
}
{
  "statusCode": 200,
  "message": "text",
  "data": {
    "eshopReturnId": "eshopReturnId",
    "eshopOrderId": "eshopOrderId",
    "note": "text",
    "eshopNote": "text",
    "description": "Wrong shoe size",
    "shipper": "DHL",
    "trackingNumber": "AB12345",
    "shipperServiceCode": "DHLEU",
    "orderType": "b2c",
    "returnedOrderProducts": [
      {
        "quantity": 1,
        "received": 1,
        "returnReason": "exchange",
        "resolution": "returnToInventory",
        "sku": "text",
        "lineState": "text"
      }
    ],
    "files": [
      {
        "data": "someBase64",
        "type": "invoice",
        "fileName": "123456.PDF",
        "fileType": "PDF",
        "fileSize": "text",
        "id": 1
      }
    ],
    "rma": "RMA-123",
    "createdAt": "2022-05-23T18:43:10.000Z",
    "status": "received"
  }
}

Update return

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

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
eshopReturnIdstringRequiredExample: eshopReturnId
eshopOrderIdstring 路 min: 1OptionalExample: eshopOrderId
notestringOptional
eshopNotestringOptional
descriptionstring 路 min: 1OptionalExample: Wrong shoe size
shipperstring 路 min: 1OptionalExample: DHL
trackingNumberstring 路 min: 1OptionalExample: AB12345
shipperServiceCodestringOptionalExample: DHLEU
orderTypestring 路 enumRequiredExample: b2cPossible values:
statusstring 路 enumOptionalPossible values:
Responses
200
Success response
application/json
401
Unauthorized response
application/json
404
Not found response
application/json
put
PUT /v2/returns/{eshopReturnId} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 482

{
  "eshopReturnId": "eshopReturnId",
  "eshopOrderId": "eshopOrderId",
  "note": "text",
  "eshopNote": "text",
  "description": "Wrong shoe size",
  "shipper": "DHL",
  "trackingNumber": "AB12345",
  "shipperServiceCode": "DHLEU",
  "orderType": "b2c",
  "returnedOrderProducts": [
    {
      "quantity": 1,
      "returnReason": "exchange",
      "resolution": "returnToInventory",
      "sku": "text",
      "lineState": "E"
    }
  ],
  "files": [
    {
      "data": "someBase64",
      "type": "invoice",
      "fileName": "123456.PDF",
      "fileType": "PDF",
      "fileSize": "text",
      "id": 1
    }
  ],
  "status": "canceled"
}
{
  "statusCode": 200,
  "message": "text",
  "data": {
    "eshopReturnId": "eshopReturnId",
    "eshopOrderId": "eshopOrderId",
    "note": "text",
    "eshopNote": "text",
    "description": "Wrong shoe size",
    "shipper": "DHL",
    "trackingNumber": "AB12345",
    "shipperServiceCode": "DHLEU",
    "orderType": "b2c",
    "returnedOrderProducts": [
      {
        "quantity": 1,
        "received": 1,
        "returnReason": "exchange",
        "resolution": "returnToInventory",
        "sku": "text",
        "lineState": "text"
      }
    ],
    "files": [
      {
        "data": "someBase64",
        "type": "invoice",
        "fileName": "123456.PDF",
        "fileType": "PDF",
        "fileSize": "text",
        "id": 1
      }
    ],
    "rma": "RMA-123",
    "createdAt": "2022-05-23T18:43:10.000Z",
    "status": "received"
  }
}