> ## Documentation Index > Fetch the complete documentation index at: https://sendcloud.dev/llms.txt > Use this file to discover all available pages before exploring further. # 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. **API v2 is entering maintenance mode.** New users should start with API v3 to access our latest features and improved performance. Already using v2? Don't worry, your current integration remains fully functional. Read more about [maintenance mode](/docs/getting-started/api-version-guide), or check out the [migration guide for API v3](/docs/getting-started/migration-guidelines-for-api-v3). Due to the public nature of this API, you could potentially use this data for your own self-hosted returns solution. ## OpenAPI ````yaml /.openapi/v2/return-portal/openapi.yaml get /brand/{brand_domain}/return-portal openapi: 3.1.0 info: title: Return portal version: 2.0.0 description: >- The Return portal API provides you with the tools to manage your own return portal, and create returns through that portal. contact: name: Sendcloud API Support url: https://www.sendcloud.dev email: contact@sendcloud.com termsOfService: https://www.sendcloud.com/terms-conditions/ license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://panel.sendcloud.sc/api/v2 description: Sendcloud Production security: [] tags: - name: Return portal description: Sendcloud's Return portal paths: /brand/{brand_domain}/return-portal: parameters: - schema: type: string minLength: 1 example: my-shop name: brand_domain in: path required: true description: The domain of the brand configured for your return portal. get: tags: - Returns Portal summary: Retrieve return portal settings description: >- Retrieve information about the settings you have configured for your Sendcloud-hosted Return portal, including branding details, delivery options and return methods. operationId: sc-public-v2-scp-get-returns_portal_details parameters: - schema: type: string enum: - en-GB - de-DE - es-ES - fr-FR - nl-NL - it-IT - en-US example: en-US in: query name: language description: >- Loads the returns portal and the corresponding context translated to the selected language responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReturnPortalSettings' examples: ReturnPortalSettings: summary: Return portal settings value: 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 '404': $ref: '#/components/responses/404' security: [] components: schemas: ReturnPortalSettings: type: object properties: portal: type: object required: - reasons - support_url - return_policy_url - brand - enable_refunds - refund_options - return_fee - return_fee_currency - delivery_options - return_address - enable_branded_footer - enable_branded_header - layout - enable_paid_returns properties: reasons: type: array uniqueItems: true minItems: 1 description: The selected return reasons for this portal items: $ref: '#/components/schemas/ReturnReasons' support_url: type: string description: The support URL you provided. example: https://www.sendcloud.com/contact/ format: uri return_policy_url: type: string description: The return policy URL you provided. example: https://www.sendcloud.com/privacy-policy/ format: uri brand: $ref: '#/components/schemas/brand' enable_refunds: type: boolean description: The choice for enabling refunds. refund_options: type: array uniqueItems: true minItems: 1 description: The selected refund options. items: type: object properties: code: type: string minLength: 1 enum: - money - credit - exchange description: >- | Code | label | |----------|-------------------------------------------------------------------| | money | Let your customers request their money back | | credit | Let your customers choose to receive a gift card or discount code | | exchange | Let your customer exchange their order with other items | example: money label: type: string minLength: 1 example: Money back require_message: type: boolean default: false required: - code - label - require_message return_fee: type: string minLength: 1 description: The set value for the return fee, in float format. example: '0.00' return_fee_currency: type: string minLength: 1 example: EUR description: Currency of the return fee in three-letter ISO 4217 format enum: - EUR - USD delivery_options: type: array description: |- 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 items: type: string example: drop_off_point enum: - drop_off_point - in_store - drop_off_labelless - pickup return_address: type: object description: >- Object describing the return address for this portal (country only). required: - country properties: country: type: string minLength: 1 example: NL description: country of the return address in two-letter ISO 3166 format enable_branded_footer: type: boolean default: false description: Defines if the branded footer is enabled. enable_branded_header: type: boolean default: false description: Defines if the branded header is enabled. layout: type: object description: Portal's layout and appearance settings. required: - type properties: type: type: string enum: - standard - background_image helper_text: type: string description: >- Extra information displayed underneath the return portal search bar. example: 'Include # if present in your order number' background_image: description: >- Background image url for portal when layout type is "background_image". type: - 'null' - string format: uri enable_paid_returns: type: boolean default: false description: Defines if the paid returns is enabled. return_locations: type: array uniqueItems: true minItems: 0 description: A list of return addresses marked as store locations. items: type: object properties: id: type: integer example: 21487 description: Identifier of this location country_name: type: string minLength: 1 example: Netherlands description: Full name of the country country_state: type: - string - 'null' description: Name of the state/province company_name: type: string minLength: 1 example: Sendcloud description: Name of the location address_1: type: string minLength: 1 example: Stadhuisplein description: Street address house_number: type: string minLength: 1 example: '10' description: House number address_2: type: string description: Additional address information city: type: string minLength: 1 example: Eindhoven description: Name of the city postal_code: type: string minLength: 1 example: 5611 EM description: Postal code senderaddress_labels: type: array description: List of the sender addresses this return location belongs to items: type: string required: - id - country_name - company_name - address_1 - house_number - address_2 - city - postal_code required: - portal - return_locations ReturnReasons: title: Return Reasons type: object description: | The available return reasons for a returns portal. | Return Reason ID | Description | | ---------------- | -------------------------------------------- | | 1 | Product did not match expectations | | 3 | Other (explain in message) | | 4 | Incorrect product ordered | | 6 | Product did not match description on website | | 7 | Wrong product shipped | | 8 | No reason | | 9 | Rent | | 10 | Does not work | | 11 | Changed my mind | | 12 | Did not meet expectations | | 13 | Excessive amount | | 14 | Better price available | | 15 | Accidental order | | 16 | No longer needed | | 17 | Sample products | | 18 | Looks different than expected | | 19 | Ordered more than one size | | 20 | Arrived too late | | 21 | Poor quality / Faulty | | 22 | Does not fit properly | | 23 | Does not suit me | | 24 | Incorrect product received | | 25 | Parcel damaged on arrival | | 26 | Wrong size ordered | | 27 | Wrong color ordered | | 28 | Does not function as expected | | 29 | Recycle or reuse packaging | | 30 | Size too large | | 31 | Size too small | | 32 | Holiday season return | properties: id: type: integer example: 1 minimum: 1 description: The Sendcloud unique identifier of the return reason enum: - 1 - 3 - 4 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 description: type: string enum: - Recycle or reuse packaging - Other (explain in message) - Incorrect product ordered - Product did not match description on website - Wrong product shipped - No reason - Rent - Does not work - Changed my mind - Did not meet expectations - Excessive amount - Better price available - Accidental order - No longer needed - Sample products - Looks different than expected - Ordered more than one size - Arrived too late - Poor quality / Faulty - Does not fit properly - Does not suit me - Incorrect product received - Parcel damaged on arrival - Wrong size ordered - Does not function as expected description: The return reason description example: Changed my mind brand: description: A user's configured brand within Sendcloud type: object title: Brand Object properties: id: type: integer minimum: 1 example: 1 description: The unique identifier of the brand readOnly: true name: type: string minLength: 1 description: The brand name example: Sendcloud B.V color: type: string minLength: 7 description: Hex code of the primary brand color example: '#112857' maxLength: 7 pattern: ^#[a-fA-F0-9]{6} secondary_color: type: string minLength: 7 description: Hex code of the secondary brand color example: '#112855' maxLength: 7 pattern: ^#[a-fA-F0-9]{6} website: type: string minLength: 1 format: uri example: https://www.sendcloud.com description: The website of the specific brand, usually used for display purposes screen_logo: type: object description: The brand's logo used for display purposes minProperties: 0 maxProperties: 1 properties: url: type: string format: uri example: https://media.sendcloud.sc/brands/1/Sendcloud.png overlay_logo: type: object enum: - {} description: >- Deprecated. Returns an empty object to not break backward compatibility deprecated: true print_logo: type: object description: The brand's logo used for printing purposes (e.g. labels) minProperties: 0 maxProperties: 1 properties: url: type: string format: uri example: https://media.sendcloud.sc/brands/1/Sendcloud.png overlay_thumb: type: object enum: - {} nullable: true description: >- Deprecated. Returns an empty object to not break backward compatibility deprecated: true screen_thumb: type: string nullable: true format: uri example: >- https://media.sendcloud.sc/brands/1/a05d525e580da030907607d901e10288_thumbnail.png description: Thumbnail of the screen logo print_thumb: type: string nullable: true example: >- https://media.sendcloud.sc/brands/1/a05d525e580da030907607d901e10288_thumbnail.png format: uri description: Thumbnail of the print logo notify_reply_to_email: type: string nullable: true format: email example: info@sendcloud.com description: >- Email address used for `reply to` actions for tracking email notifications domain: type: string minLength: 1 description: >- A user-defined domain for use with the tracking page and the return portal features. example: sendcloud-shop notify_bcc_email: type: string nullable: true example: info@sendcloud.com format: email description: >- [BCC email](https://en.wikipedia.org/wiki/Blind_carbon_copy) address used for `reply to` actions for tracking email notifications hide_powered_by: type: boolean description: >- Indicates if the "powered by Sendcloud" message should be displayed on features which display the user's brand, such as the tracking page default: false google_analytics_id: type: string example: G-1234567890 pattern: ^G-\d{10}$ description: A user-defined string representing the Google Analytics ID maxLength: 15 features: type: object description: List of features activated for the brand properties: tracking_page: type: boolean description: True if the tracking page is published, false otherwise tracking_email: type: boolean description: >- True if the Tracking email feature is active and the brand has at least one email template active, false otherwise tracking_sms: type: boolean description: >- True if Tracking SMS feature is active and the brand has at least one SMS template active, false otherwise tracking_whatsapp: type: boolean description: >- True if Tracking WhatsApp feature is active and the brand has at least one WhatsApp template active, false otherwise returns_portal: type: boolean description: True if the returns portal is active, false otherwise customization_settings: type: object nullable: true description: Header and footer customization settings for the brand properties: header: type: object nullable: true description: >- Indicates information to be shown in the header of the tracking pages and return portal properties: faq_url: type: string example: https://support.sendcloud.com/hc/en-us format: uri description: Link to the shop's FAQ contact_url: type: string example: https://sendcloud.com/contact format: uri description: Link to the shop's contact page shop_url: type: string example: https://sendcloud.com/storefront format: uri description: Link to the webshop font_color: type: string example: '#212121' description: Font colour to be used for displaying header information homepage_url: type: string example: https://sendcloud.com format: uri description: Link to the shop's homepage background_color: type: string example: '#ffffff' description: >- Background colour to be used for displaying header information footer: type: object description: >- Indicates information to be shown in the footer of the tracking page and return portal properties: city: type: string example: Eindhoven street: type: string example: Stadhuisplein country: type: string example: Netherlands font_color: type: string example: '#212121' postal_code: type: string example: 5611EM phone_number: type: string example: '+310612345678' social_media: type: object description: >- Social media handle of the shop. The absolute URLs are not sent. properties: twitter: type: string example: sendcloud description: The Twitter handle of the webshop facebook: type: string example: SendCloudNL description: The Facebook handle of the webshop linkedin: type: string example: sendcloud description: The LinkedIn handle of the webshop instagram: type: string example: sendcloud description: The Instagram handle of the webshop pinterest: type: string example: sendcloud description: The Pinterest handle of the webshop support_email: type: string example: contact@sendcloud.com format: email description: An email address for the shop's customer support background_color: type: string example: '#ffffff' description: >- Background colour to be used for displaying footer information whatsapp_business: type: string description: The WhatsApp contact number of the business/brand. example: '+310612345678' required: - id - name - domain - features responses: '404': description: Not Found content: application/json: schema: type: object properties: error: type: object properties: code: type: integer example: 404 request: type: string example: api/v2/brand/brand_domain/return-portal message: type: string example: No ReturnsPortal matches the given query ````