Retrieve return portal settings
curl --request GET \
--url https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portalimport requests
url = "https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portal"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portal', 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/brand/{brand_domain}/return-portal",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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/brand/{brand_domain}/return-portal"
req, _ := http.NewRequest("GET", url, nil)
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/brand/{brand_domain}/return-portal")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"portal": {
"reasons": [
{
"id": 1,
"description": "Changed my mind"
}
],
"support_url": "https://www.sendcloud.com/contact/",
"return_policy_url": "https://www.sendcloud.com/privacy-policy/",
"enable_branded_footer": false,
"enable_branded_header": false,
"layout": {
"type": "standard",
"helper_text": "Include # if present in your order number",
"background_image": null
},
"enable_paid_returns": false,
"brand": {
"id": 1,
"name": "Sendcloud B.V",
"color": "#112857",
"secondary_color": "#112855",
"website": "https://www.sendcloud.com",
"overlay_logo": {},
"screen_logo": {
"url": "https://media.sendcloud.sc/brands/1/Sendcloud.png"
},
"print_logo": {
"url": "https://media.sendcloud.sc/brands/1/Sendcloud.png"
},
"overlay_thumb": {},
"screen_thumb": "https://media.sendcloud.sc/brands/1/a05d525e580da030907607d901e10288_thumbnail.png",
"print_thumb": "https://media.sendcloud.sc/brands/1/a05d525e580da030907607d901e10288_thumbnail.png",
"notify_reply_to_email": "info@sendcloud.com",
"domain": "sendcloud-shop",
"notify_bcc_email": "info@sendcloud.com",
"hide_powered_by": false,
"google_analytics_id": "G-1234567890",
"features": {
"tracking_page": true,
"tracking_email": true,
"tracking_sms": false,
"tracking_whatsapp": false,
"returns_portal": true
},
"customization_settings": {
"header": {
"faq_url": "https://support.sendcloud.com/hc/en-us",
"contact_url": "https://sendcloud.com/contact",
"shop_url": "https://sendcloud.com/storefront",
"font_color": "#212121",
"homepage_url": "https://sendcloud.com",
"background_color": "#ffffff"
},
"footer": {
"city": "Eindhoven",
"street": "Stadhuisplein",
"country": "Netherlands",
"font_color": "#212121",
"postal_code": "5611 EM",
"phone_number": "+310612345678",
"social_media": {
"twitter": "sendcloud",
"facebook": "SendCloudNL",
"linkedin": "sendcloud",
"instagram": "sendcloud",
"pinterest": "sendcloud"
},
"support_email": "contact@sendcloud.com",
"background_color": "#ffffff",
"whatsapp_business": "+310612345678"
}
}
},
"enable_refunds": true,
"refund_options": [
{
"code": "money",
"label": "Money back",
"require_message": false
}
],
"return_fee": "0.00",
"return_fee_currency": "EUR",
"delivery_options": [
"drop_off_point"
],
"return_address": {
"country": "NL"
}
},
"return_locations": [
{
"id": 21487,
"country_name": "Netherlands",
"country_state": "string",
"company_name": "Sendcloud",
"address_1": "Stadhuisplein",
"house_number": "10",
"address_2": "string",
"city": "Eindhoven",
"postal_code": "5611 EM",
"senderaddress_labels": [
"string"
]
}
]
}{
"error": {
"code": 404,
"request": "api/v2/brand/brand_domain/return-portal",
"message": "No ReturnsPortal matches the given query"
}
}Return portal API
Retrieve return portal settings
Retrieve information about the settings you have configured for your Sendcloud-hosted Return portal, including branding details, delivery options and return methods.
GET
/
brand
/
{brand_domain}
/
return-portal
Retrieve return portal settings
curl --request GET \
--url https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portalimport requests
url = "https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portal"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portal', 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/brand/{brand_domain}/return-portal",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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/brand/{brand_domain}/return-portal"
req, _ := http.NewRequest("GET", url, nil)
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/brand/{brand_domain}/return-portal")
.asString();require 'uri'
require 'net/http'
url = URI("https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"portal": {
"reasons": [
{
"id": 1,
"description": "Changed my mind"
}
],
"support_url": "https://www.sendcloud.com/contact/",
"return_policy_url": "https://www.sendcloud.com/privacy-policy/",
"enable_branded_footer": false,
"enable_branded_header": false,
"layout": {
"type": "standard",
"helper_text": "Include # if present in your order number",
"background_image": null
},
"enable_paid_returns": false,
"brand": {
"id": 1,
"name": "Sendcloud B.V",
"color": "#112857",
"secondary_color": "#112855",
"website": "https://www.sendcloud.com",
"overlay_logo": {},
"screen_logo": {
"url": "https://media.sendcloud.sc/brands/1/Sendcloud.png"
},
"print_logo": {
"url": "https://media.sendcloud.sc/brands/1/Sendcloud.png"
},
"overlay_thumb": {},
"screen_thumb": "https://media.sendcloud.sc/brands/1/a05d525e580da030907607d901e10288_thumbnail.png",
"print_thumb": "https://media.sendcloud.sc/brands/1/a05d525e580da030907607d901e10288_thumbnail.png",
"notify_reply_to_email": "info@sendcloud.com",
"domain": "sendcloud-shop",
"notify_bcc_email": "info@sendcloud.com",
"hide_powered_by": false,
"google_analytics_id": "G-1234567890",
"features": {
"tracking_page": true,
"tracking_email": true,
"tracking_sms": false,
"tracking_whatsapp": false,
"returns_portal": true
},
"customization_settings": {
"header": {
"faq_url": "https://support.sendcloud.com/hc/en-us",
"contact_url": "https://sendcloud.com/contact",
"shop_url": "https://sendcloud.com/storefront",
"font_color": "#212121",
"homepage_url": "https://sendcloud.com",
"background_color": "#ffffff"
},
"footer": {
"city": "Eindhoven",
"street": "Stadhuisplein",
"country": "Netherlands",
"font_color": "#212121",
"postal_code": "5611 EM",
"phone_number": "+310612345678",
"social_media": {
"twitter": "sendcloud",
"facebook": "SendCloudNL",
"linkedin": "sendcloud",
"instagram": "sendcloud",
"pinterest": "sendcloud"
},
"support_email": "contact@sendcloud.com",
"background_color": "#ffffff",
"whatsapp_business": "+310612345678"
}
}
},
"enable_refunds": true,
"refund_options": [
{
"code": "money",
"label": "Money back",
"require_message": false
}
],
"return_fee": "0.00",
"return_fee_currency": "EUR",
"delivery_options": [
"drop_off_point"
],
"return_address": {
"country": "NL"
}
},
"return_locations": [
{
"id": 21487,
"country_name": "Netherlands",
"country_state": "string",
"company_name": "Sendcloud",
"address_1": "Stadhuisplein",
"house_number": "10",
"address_2": "string",
"city": "Eindhoven",
"postal_code": "5611 EM",
"senderaddress_labels": [
"string"
]
}
]
}{
"error": {
"code": 404,
"request": "api/v2/brand/brand_domain/return-portal",
"message": "No ReturnsPortal matches the given query"
}
}Path Parameters
The domain of the brand configured for your return portal.
Minimum string length:
1Example:
"my-shop"
Query Parameters
Loads the returns portal and the corresponding context translated to the selected language
Available options:
en-GB, de-DE, es-ES, fr-FR, nl-NL, it-IT, en-US Example:
"en-US"
⌘I