curl --request GET \
--url https://panel.sendcloud.sc/api/v2/returns/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v2/returns/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://panel.sendcloud.sc/api/v2/returns/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://panel.sendcloud.sc/api/v2/returns/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://panel.sendcloud.sc/api/v2/returns/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://panel.sendcloud.sc/api/v2/returns/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v2/returns/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": 1,
"created_at": "2022-06-07T16:36:49.419457+02:00",
"reason": 1,
"outgoing_parcel": 1,
"incoming_parcel": 1,
"message": "Not good enough for me",
"refund": {
"total_refund": "\"10.00\"",
"refunded_at": 1654683771746,
"message": "Exchange for size M",
"refund_type": {
"code": "money",
"label": "Money back",
"require_message": true
}
},
"is_cancellable": true,
"return_fee": 3.5,
"return_fee_currency": "EUR",
"label_cost": 6.95,
"label_currency": "EUR",
"items_cost": 48.95,
"delivered_at": "2022-06-07T16:36:49.419457+02:00",
"delivery_option": "drop_off_point",
"store_location": 1,
"images": [],
"rule_modifications": [
{
"rule_name": "my_ship_with_rule",
"field": "ship_with",
"value": "PostNL Return",
"action": "ship_with",
"friendly_name": "Return method",
"priority": 1,
"item_id": null
}
],
"outgoing_parcel_data": {
"tracking_url": "https://tracking.sendcloud.sc/forward?carrier=dhl&code=JVGL1234567800000049",
"tracking_number": "JVGL1234567800000049",
"parcel_status": 11,
"global_status_slug": "delivered",
"brand_name": "My Brand",
"order_number": "EU2548657452",
"from_email": "contact@sendcloud.com",
"deleted": true,
"collo_count": 1,
"from_country": "NL",
"from_name": "Jane Doe",
"shipping_method": 994,
"extra_data": {}
},
"incoming_parcel_data": {
"tracking_url": "https://tracking.sendcloud.sc/forward?carrier=dhl&code=JVGL1234567800000049",
"tracking_number": "JVGL1234567800000049",
"parcel_status": 11,
"global_status_slug": "delivered",
"brand_name": "My Brand",
"order_number": "EU2548657452",
"from_email": "contact@sendcloud.com",
"deleted": true,
"collo_count": 1,
"from_country": "NL",
"from_name": "Jane Doe",
"shipping_method": 994,
"extra_data": {},
"rules": [
{
"name": "my_ship_with_rule",
"priority": 1,
"item_id": null,
"modifications": [
{
"field": "ship_with",
"value": "PostNL Return",
"action": "ship_with",
"friendly_name": "Return method"
}
]
}
]
},
"incoming_parcel_status": {
"id": 1,
"message": "Delivered",
"global_status_slug": "delivered"
}
}{
"error": {
"code": 123,
"request": "<string>",
"message": "<string>"
}
}Retrieve a return
Retrieve the details of a specific return by its unique identifier.
curl --request GET \
--url https://panel.sendcloud.sc/api/v2/returns/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://panel.sendcloud.sc/api/v2/returns/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://panel.sendcloud.sc/api/v2/returns/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://panel.sendcloud.sc/api/v2/returns/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://panel.sendcloud.sc/api/v2/returns/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://panel.sendcloud.sc/api/v2/returns/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v2/returns/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": 1,
"created_at": "2022-06-07T16:36:49.419457+02:00",
"reason": 1,
"outgoing_parcel": 1,
"incoming_parcel": 1,
"message": "Not good enough for me",
"refund": {
"total_refund": "\"10.00\"",
"refunded_at": 1654683771746,
"message": "Exchange for size M",
"refund_type": {
"code": "money",
"label": "Money back",
"require_message": true
}
},
"is_cancellable": true,
"return_fee": 3.5,
"return_fee_currency": "EUR",
"label_cost": 6.95,
"label_currency": "EUR",
"items_cost": 48.95,
"delivered_at": "2022-06-07T16:36:49.419457+02:00",
"delivery_option": "drop_off_point",
"store_location": 1,
"images": [],
"rule_modifications": [
{
"rule_name": "my_ship_with_rule",
"field": "ship_with",
"value": "PostNL Return",
"action": "ship_with",
"friendly_name": "Return method",
"priority": 1,
"item_id": null
}
],
"outgoing_parcel_data": {
"tracking_url": "https://tracking.sendcloud.sc/forward?carrier=dhl&code=JVGL1234567800000049",
"tracking_number": "JVGL1234567800000049",
"parcel_status": 11,
"global_status_slug": "delivered",
"brand_name": "My Brand",
"order_number": "EU2548657452",
"from_email": "contact@sendcloud.com",
"deleted": true,
"collo_count": 1,
"from_country": "NL",
"from_name": "Jane Doe",
"shipping_method": 994,
"extra_data": {}
},
"incoming_parcel_data": {
"tracking_url": "https://tracking.sendcloud.sc/forward?carrier=dhl&code=JVGL1234567800000049",
"tracking_number": "JVGL1234567800000049",
"parcel_status": 11,
"global_status_slug": "delivered",
"brand_name": "My Brand",
"order_number": "EU2548657452",
"from_email": "contact@sendcloud.com",
"deleted": true,
"collo_count": 1,
"from_country": "NL",
"from_name": "Jane Doe",
"shipping_method": 994,
"extra_data": {},
"rules": [
{
"name": "my_ship_with_rule",
"priority": 1,
"item_id": null,
"modifications": [
{
"field": "ship_with",
"value": "PostNL Return",
"action": "ship_with",
"friendly_name": "Return method"
}
]
}
]
},
"incoming_parcel_status": {
"id": 1,
"message": "Delivered",
"global_status_slug": "delivered"
}
}{
"error": {
"code": 123,
"request": "<string>",
"message": "<string>"
}
}Authorizations
Basic Authentication using API key and secrets is currently the main authentication mechanism.
Path Parameters
The unique identifier of this return object
1
Response
OK
An object representing a Return.
This includes details of the original outgoing parcel, the incoming parcel and the returned items.
The unique identifier of this Return object
x >= 11
The creation date of this Return, in ISO 8601 format
"2022-06-07T16:36:49.419457+02:00"
Identifier of the reason for this return
x >= 11
Identifier of the original outgoing Parcel object
x >= 11
Identifier of the incoming return Parcel object
x >= 11
Return reason message as written by the customer
"Not good enough for me"
The type of compensation the customer chose for the returned items
Show child attributes
Show child attributes
Whether the incoming return parcel can still be cancelled
The fee associated with this return
x >= 03.5
Currency of the return fee in three-letter ISO 4217 format
"EUR"
Cost of the label for the incoming return parcel
x >= 06.95
Currency of the label cost in three-letter ISO 4217 format
"EUR"
Total cost of the returned items
x >= 048.95
Delivery date of the incoming return parcel
"2022-06-07T16:36:49.419457+02:00"
The options the customer has for returning this parcel:
- drop_off_point: At a drop-off point - Print at home
- drop_off_labelless: At a drop-off point - No printer needed
- in_store: Return in store
- pickup: Arrange a pick-up
drop_off_point, drop_off_labelless, in_store, pickup The identifier of the in-store return address
x >= 11
An object representing the details of a Parcel
Show child attributes
Show child attributes
An object representing the details of a Parcel
Show child attributes
Show child attributes
Object describing the status of the incoming return parcel
Show child attributes
Show child attributes
A list of images attached to a return
Show child attributes
Show child attributes
List of return rules applied to this Return
Show child attributes
Show child attributes