Returns

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

Filter returns

post

Authorizations

XApiKey & authorization

x-api-keystringRequired

authorizationstringRequired

Header parameters

x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body

application/json

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

statusCodenumberRequiredDefault: 200

messagestringRequired

401

Unauthorized response

application/json

post

/returns/filter

HTTPcURLJavaScriptPython

POST /v2/returns/filter HTTP/1.1
Host: gw.new.skladon.net
x-api-key: text
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "page": 1,
  "items": 30,
  "columns": [
    "eshopReturnId",
    "shipper",
    "status"
  ],
  "sorts": [
    {
      "column": "description",
      "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": "SKU1",
            "lineState": "E"
          }
        ],
        "files": [
          {
            "data": "someBase64",
            "type": "invoice",
            "fileName": "123456.PDF",
            "fileType": "PDF",
            "fileSize": "text",
            "id": 1
          }
        ],
        "canceledAt": "2022-05-23T18:43:10.000Z",
        "confirmedAt": "2022-05-23T18:43:10.000Z",
        "receivedAt": "2022-05-23T18:43:10.000Z"
      }
    ],
    "request": {
      "page": 1,
      "items": 30,
      "columns": [
        "eshopReturnId",
        "shipper",
        "status"
      ],
      "sorts": [
        {
          "column": "description",
          "direction": "DESC"
        }
      ],
      "filters": [
        [
          {
            "column": "orderType",
            "operator": "eq",
            "value": "b2c"
          }
        ]
      ]
    },
    "totalCount": 430
  }
}

Get return

get

Authorizations

XApiKey & authorization

x-api-keystringRequired

authorizationstringRequired

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

statusCodenumberRequiredDefault: 200

messagestringRequired

401

Unauthorized response

application/json

404

Not found response

application/json

get

/returns/{eshopReturnId}

HTTPcURLJavaScriptPython

GET /v2/returns/{eshopReturnId} HTTP/1.1
Host: gw.new.skladon.net
x-api-key: text
authorization: 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": "SKU1",
        "lineState": "E",
        "serialNumber": "123456789"
      }
    ],
    "files": [
      {
        "data": "someBase64",
        "type": "invoice",
        "fileName": "123456.PDF",
        "fileType": "PDF",
        "fileSize": "text",
        "id": 1
      }
    ],
    "rma": "RMA-123",
    "createdAt": "2022-05-23T18:43:10.000Z",
    "canceledAt": "2022-05-23T18:43:10.000Z",
    "confirmedAt": "2022-05-23T18:43:10.000Z",
    "receivedAt": "2022-05-23T18:43:10.000Z",
    "status": "received",
    "sourceSys": "skladon",
    "transportPaidBy": "customer",
    "orderId": 12345,
    "senderStreet": "Ulice 123s",
    "senderCity": "Praha",
    "senderState": "CZ",
    "senderPostcode": "11000",
    "senderPhone": "[phone]"
  }
}

Create return

post

Authorizations

XApiKey & authorization

x-api-keystringRequired

authorizationstringRequired

Header parameters

x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body

application/json

eshopReturnIdstringRequiredExample: eshopReturnId

eshopOrderIdstring · min: 1OptionalExample: eshopOrderId

notestringOptional

eshopNotestringOptional

Note from e-shop that is not shown to the customer

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

statusCodenumberRequiredDefault: 200

messagestringRequired

401

Unauthorized response

application/json

409

Conflict response

application/json

post

/returns

HTTPcURLJavaScriptPython

POST /v2/returns HTTP/1.1
Host: gw.new.skladon.net
x-api-key: text
authorization: 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": "SKU1",
      "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": "SKU1",
        "lineState": "E",
        "serialNumber": "123456789"
      }
    ],
    "files": [
      {
        "data": "someBase64",
        "type": "invoice",
        "fileName": "123456.PDF",
        "fileType": "PDF",
        "fileSize": "text",
        "id": 1
      }
    ],
    "rma": "RMA-123",
    "createdAt": "2022-05-23T18:43:10.000Z",
    "canceledAt": "2022-05-23T18:43:10.000Z",
    "confirmedAt": "2022-05-23T18:43:10.000Z",
    "receivedAt": "2022-05-23T18:43:10.000Z",
    "status": "received",
    "sourceSys": "skladon",
    "transportPaidBy": "customer",
    "orderId": 12345,
    "senderStreet": "Ulice 123s",
    "senderCity": "Praha",
    "senderState": "CZ",
    "senderPostcode": "11000",
    "senderPhone": "[phone]"
  }
}

Update return

put

Authorizations

XApiKey & authorization

x-api-keystringRequired

authorizationstringRequired

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

application/json

eshopReturnIdstringRequiredExample: eshopReturnId

eshopOrderIdstring · min: 1OptionalExample: eshopOrderId

notestringOptional

eshopNotestringOptional

Note from e-shop that is not shown to the customer

descriptionstring · min: 1OptionalExample: Wrong shoe size

shipperstring · min: 1OptionalExample: DHL

trackingNumberstring · min: 1OptionalExample: AB12345

shipperServiceCodestringOptionalExample: DHLEU

orderTypestring · enumRequiredExample: b2cPossible values:

canceledAtstring · dateOptionalExample: 2022-05-23T18:43:10.000Z

confirmedAtstring · dateOptionalExample: 2022-05-23T18:43:10.000Z

receivedAtstring · dateOptionalExample: 2022-05-23T18:43:10.000Z

statusstring · enumOptional

You can update only to canceled status, other statuses are not allowed. This field is optional.

Possible values:

Responses

200

Success response

application/json

statusCodenumberRequiredDefault: 200

messagestringRequired

401

Unauthorized response

application/json

404

Not found response

application/json

put

/returns/{eshopReturnId}

HTTPcURLJavaScriptPython

PUT /v2/returns/{eshopReturnId} HTTP/1.1
Host: gw.new.skladon.net
x-api-key: text
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 603

{
  "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": "SKU1",
      "lineState": "E"
    }
  ],
  "files": [
    {
      "data": "someBase64",
      "type": "invoice",
      "fileName": "123456.PDF",
      "fileType": "PDF",
      "fileSize": "text",
      "id": 1
    }
  ],
  "canceledAt": "2022-05-23T18:43:10.000Z",
  "confirmedAt": "2022-05-23T18:43:10.000Z",
  "receivedAt": "2022-05-23T18:43:10.000Z",
  "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": "SKU1",
        "lineState": "E",
        "serialNumber": "123456789"
      }
    ],
    "files": [
      {
        "data": "someBase64",
        "type": "invoice",
        "fileName": "123456.PDF",
        "fileType": "PDF",
        "fileSize": "text",
        "id": 1
      }
    ],
    "rma": "RMA-123",
    "createdAt": "2022-05-23T18:43:10.000Z",
    "canceledAt": "2022-05-23T18:43:10.000Z",
    "confirmedAt": "2022-05-23T18:43:10.000Z",
    "receivedAt": "2022-05-23T18:43:10.000Z",
    "status": "received",
    "sourceSys": "skladon",
    "transportPaidBy": "customer",
    "orderId": 12345,
    "senderStreet": "Ulice 123s",
    "senderCity": "Praha",
    "senderState": "CZ",
    "senderPostcode": "11000",
    "senderPhone": "[phone]"
  }
}

Partially update return

patch

Authorizations

XApiKey & authorization

x-api-keystringRequired

authorizationstringRequired

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

application/json

eshopReturnIdstringRequiredExample: eshopReturnId

eshopOrderIdstring · min: 1OptionalExample: eshopOrderId

notestringOptional

eshopNotestringOptional

Note from e-shop that is not shown to the customer

descriptionstring · min: 1OptionalExample: Wrong shoe size

shipperstring · min: 1OptionalExample: DHL

trackingNumberstring · min: 1OptionalExample: AB12345

shipperServiceCodestringOptionalExample: DHLEU

orderTypestring · enumRequiredExample: b2cPossible values:

canceledAtstring · dateOptionalExample: 2022-05-23T18:43:10.000Z

confirmedAtstring · dateOptionalExample: 2022-05-23T18:43:10.000Z

receivedAtstring · dateOptionalExample: 2022-05-23T18:43:10.000Z

statusstring · enumOptional

You can update only to canceled status, other statuses are not allowed. This field is optional.

Possible values:

Responses

200

Success response

application/json

statusCodenumberRequiredDefault: 200

messagestringRequired

401

Unauthorized response

application/json

404

Not found response

application/json

patch

/returns/{eshopReturnId}

HTTPcURLJavaScriptPython

PATCH /v2/returns/{eshopReturnId} HTTP/1.1
Host: gw.new.skladon.net
x-api-key: text
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 603

{
  "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": "SKU1",
      "lineState": "E"
    }
  ],
  "files": [
    {
      "data": "someBase64",
      "type": "invoice",
      "fileName": "123456.PDF",
      "fileType": "PDF",
      "fileSize": "text",
      "id": 1
    }
  ],
  "canceledAt": "2022-05-23T18:43:10.000Z",
  "confirmedAt": "2022-05-23T18:43:10.000Z",
  "receivedAt": "2022-05-23T18:43:10.000Z",
  "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": "SKU1",
        "lineState": "E",
        "serialNumber": "123456789"
      }
    ],
    "files": [
      {
        "data": "someBase64",
        "type": "invoice",
        "fileName": "123456.PDF",
        "fileType": "PDF",
        "fileSize": "text",
        "id": 1
      }
    ],
    "rma": "RMA-123",
    "createdAt": "2022-05-23T18:43:10.000Z",
    "canceledAt": "2022-05-23T18:43:10.000Z",
    "confirmedAt": "2022-05-23T18:43:10.000Z",
    "receivedAt": "2022-05-23T18:43:10.000Z",
    "status": "received",
    "sourceSys": "skladon",
    "transportPaidBy": "customer",
    "orderId": 12345,
    "senderStreet": "Ulice 123s",
    "senderCity": "Praha",
    "senderState": "CZ",
    "senderPostcode": "11000",
    "senderPhone": "[phone]"
  }
}