Docs
Sign in

Embed the returns portal as iframe

Updated May 31, 20262 min read
Required roles:
AdminAccount ManagerManager

Use this page to embed the Returns Portal into your website as an iframe.

You configure the embedding settings in the Carriyo Dashboard before adding the iframe to your site. The URL also supports additional parameters, all of which are explained below.

Setting up

1. Navigate to CX Apps > Returns Portal on the Carriyo Dashboard. Under custom domain section, activate the Enable iframe embedding toggle.

Separate the domains under Allowed iframe Domains with spaces. The image above shows an example. After you enter them, the field looks like this: "Https://example.com Https://*.example.com". If there is more than one subdomain under example.com, use Https://*.example.com. This matches any of the subdomains.

A Returns Portal configured without iframe embedding looks like this.

2. Parameters allowed in the URL are:

  • iframe - Passing this parameter removes the header, footer, logo, and language selector.

Example: Https://subdomain.example.com/return?iframe#step1 or Https://subdomain.example.com/return?iframe

  • order_ref (plaintext) and email_or_phone (base64). These parameters skip the first page. order_ref must be in plaintext and email_or_phone must be encoded in base64 format. When both parameters are provided with valid values, the first step is skipped.

Example: Https://example.com/return?iframe&order_ref=26532&email_or_phone=dGVzdC51c2VyQGV4YW1wbGUuY29tCg== or Https://example.com/return?iframe&order_ref=26532&email_or_phone=NjczODI3MzkxNgo=

Carriyo auto-detects the language from the shipment or order details, unless you override it with the language parameter below.

  • language - Optional. Pass this parameter to force a specific language, since the language selector is removed in iframe mode. Possible values include it, de, ar, en, nl, fr, and others. Languages and translations must be configured in the Returns Portal settings in Carriyo.

Note: The shipment or order language overrides the default language in most cases.

example: Https://example.com/return?iframe&order_ref=26532&email_or_phonedGVzdC51c2VyQGV4YW1wbGUuY29tCg==&language=it

When iframe embedding is enabled for one or more domains, you can use <iframe src="https://*.example.com/return?iframe"></iframe> and so on to embed the Returns Portal as an iframe.

Concepts behind this