Returns
You may find descriptions of endpoints for work with returned orders bellow.
This is the eshop key you receive during onboarding.
Token you get from calling /users/login
Page number, can be used for pagination
1
Example: 1
items per page
10
Example: 30
Success response
Unauthorized response
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
}
}
This is the eshop key you receive during onboarding.
Token you get from calling /users/login
Success response
Unauthorized response
Not found response
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",
"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",
"status": "received"
}
}
This is the eshop key you receive during onboarding.
Token you get from calling /users/login
eshopReturnId
eshopOrderId
Note from e-shop that is not shown to the customer
Wrong shoe size
DHL
AB12345
DHLEU
b2c
Possible values: Success response
Unauthorized response
Conflict response
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",
"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",
"status": "received"
}
}
This is the eshop key you receive during onboarding.
Token you get from calling /users/login
Success response
Unauthorized response
Not found response
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",
"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",
"status": "received"
}
}
Last updated