Skip to main content
GET
/
brand
/
{brand_domain}
/
return-portal
Retrieve return portal settings
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portal
{
  "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"
      ]
    }
  ]
}
Due to the public nature of this API, you could potentially use this data for your own self-hosted returns solution.

Path Parameters

​
brand_domain
string
required

The domain of the brand configured for your return portal.

Minimum string length: 1
Example:

"my-shop"

Query Parameters

​
language
enum<string>

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"

Response

OK

​
portal
object
required
​
return_locations
object[]
required

A list of return addresses marked as store locations.