Retrieve return portal settings
GET {{baseUrl}}/brand/:brand_domain/return-portal?language=en-GB
This endpoint will retrieve information about the settings you have configured for your Sendcloud-hosted Returns Portal. This includes branding details, delivery options and return methods. Due to the public nature of this API, you could potentially utilize these for your own self-hosted returns solution.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
language | string | Loads the returns portal and the corresponding context translated to the selected language |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"portal":{"reasons":[{"id":29,"description":"No longer needed"}],"support_url":"\u003curi\u003e","return_policy_url":"\u003curi\u003e","brand":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","domain":"\u003cstring\u003e","features":{"tracking_page":"\u003cboolean\u003e","tracking_email":"\u003cboolean\u003e","tracking_sms":"\u003cboolean\u003e","tracking_whatsapp":"\u003cboolean\u003e","returns_portal":"\u003cboolean\u003e"},"color":"#329EAB","secondary_color":"#38011B","website":"\u003curi\u003e","screen_logo":{"url":"\u003curi\u003e"},"overlay_logo":{},"print_logo":{"url":"\u003curi\u003e"},"overlay_thumb":{},"screen_thumb":"\u003curi\u003e","print_thumb":"\u003curi\u003e","notify_reply_to_email":"\u003cemail\u003e","notify_bcc_email":"\u003cemail\u003e","hide_powered_by":false,"google_analytics_id":"G-7252046059","customization_settings":{"header":{"faq_url":"\u003curi\u003e","contact_url":"\u003curi\u003e","shop_url":"\u003curi\u003e","font_color":"\u003cstring\u003e","homepage_url":"\u003curi\u003e","background_color":"\u003cstring\u003e"},"footer":{"city":"\u003cstring\u003e","street":"\u003cstring\u003e","country":"\u003cstring\u003e","font_color":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","social_media":{"twitter":"\u003cstring\u003e","facebook":"\u003cstring\u003e","linkedin":"\u003cstring\u003e","instagram":"\u003cstring\u003e","pinterest":"\u003cstring\u003e"},"support_email":"\u003cemail\u003e","background_color":"\u003cstring\u003e","whatsapp_business":"\u003cstring\u003e"}}},"enable_refunds":"\u003cboolean\u003e","refund_options":[{"code":"exchange","label":"\u003cstring\u003e","require_message":false}],"return_fee":"\u003cstring\u003e","return_fee_currency":"EUR","delivery_options":["pickup","in_store"],"return_address":{"country":"\u003cstring\u003e"},"enable_branded_footer":false,"enable_branded_header":false,"layout":{"type":"background_image","helper_text":"\u003cstring\u003e","background_image":"\u003cnull,string-uri\u003e"},"enable_paid_returns":false},"return_locations":[{"id":"\u003cinteger\u003e","country_name":"\u003cstring\u003e","company_name":"\u003cstring\u003e","address_1":"\u003cstring\u003e","house_number":"\u003cstring\u003e","address_2":"\u003cstring\u003e","city":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","country_state":"\u003cstring,null\u003e","senderaddress_labels":["\u003cstring\u003e","\u003cstring\u003e"]},{"id":"\u003cinteger\u003e","country_name":"\u003cstring\u003e","company_name":"\u003cstring\u003e","address_1":"\u003cstring\u003e","house_number":"\u003cstring\u003e","address_2":"\u003cstring\u003e","city":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","country_state":"\u003cstring,null\u003e","senderaddress_labels":["\u003cstring\u003e","\u003cstring\u003e"]}]}