This article explains the steps required to embed the Returns Portal page as an iframe.

The Returns Portal under CX Apps can be embedded into websites in the form of an iframe. The settings must first be configured in the Carriyo Dashboard. The URL also supports additional parameters, all of which are explained below.

Permissions: Only users with Account Manager, Admin & Manager access roles can manage Returns Portal settings.

Setting up

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

The domains under Al​lowed if​rame Do​mains must be separated by spaces. An example is provided in the image above. Once entered, it will look like this: "https://example.com https://*.example.com". If there are more than one subdomains under example.com, use https://*.example.com - this will match any of the subdomains.

A normally configured Returns Portal will look like this.

2. Parameters allowed in the URL are:

• iframe - If this parameter is passed, then header, footer, logo and language selector will be removed.

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 can be specified to skip the first page. Here, order_ref must be in plaintext and email_or_phone must be encoded in base64 format. If these parameters with valid values are passed in the URL, the first step will be 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=

Here, the language is auto-detected from the shipment details.

• language - Optional. This parameter can be passed to force a specific language (since language selector is removed). Possible values include it/de/ar/en/nl/fr etc. The languages & translations must be configured in the Returns Portal settings in Carriyo.

Note: The shipment/order language will override the default language in most cases.

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