How to set up the returns portal
The returns portal is a self-service page on your storefront where customers look up their order and request a return themselves. You publish it by pasting a portal token generated in OrderKrab into your store - a theme app block on Shopify, a block or a shortcode on WooCommerce. No code either way.
- 1
Before you start: the returns portal comes with every plan, LABELS included. Your store has to be connected to OrderKrab and you need at least one shipping carrier connected. On Shopify your theme has to support app blocks - any Online Store 2.0 theme does; on WooCommerce you need the OrderKrab plugin on 1.4.0 or newer.
- 2
In the sidebar, click Returns. Until the first request arrives, its Requests tab shows a setup guide, Set up your returns portal, that lists your stores for adding the portal. Set up return carriers and return rules first, as below.
- 3
Open the Return carriers tab. Click each country you accept returns from on the map, pick a Return carrier and Return method, then Save. A country without a return carrier can't get a return label at all - see how to set up return shipping for each country.
- 4
Open the Settings tab. In the Return rules card, set the Return window - how many days after the order was placed a customer may still start a return (default 14). It saves as soon as you click outside the field.
- 5
Switch on Accept damaged items after the window if a customer should still be able to return an order past the window, as long as every item they send back is marked Damaged or defective.
- 6
Under When a customer sends a request, choose Review it first - the request waits for you on the Requests tab - or Approve automatically: the return label is created and emailed to the customer the moment they submit, EU-withdrawal style. Each change saves right away, with a Returns settings have been saved. confirmation.
- 7
In the Portal on your stores card - or under Add the portal to your store in the setup guide - click Add return portal on your store's row. In the window that opens, click Copy token: a token for that store is created and copied to your clipboard, and it also shows in the field below the button. The window then lists the steps for your platform, the same as below.
Select your store platform
- 8
Switch to your Shopify admin and go to Online Store → Pages → Add page. Name it something customers will recognise, like Returns, and save it.
- 9
Go to Online Store → Themes → Customize, then use the template dropdown at the top of the editor to open the page you just created.
- 10
Click Add section (or Add block inside an existing section) → Apps → Return portal.
- 11
Under Connection, paste your token into Portal token. Leave Return portal URL as https://returns.orderkrab.com unless OrderKrab has given you a different address. The setup placeholder in the preview is replaced by the live portal.
- 12
Under Display, set the Max width (default 1200 px), the Iframe height (default 900 px - pick a height tall enough that the portal doesn't scroll inside itself) and the Default language: Match storefront language follows each customer's locale, or pick one of the 10 fixed languages. Under Colors, match the portal to your brand - leave any color empty to keep the portal's own default.
- 13
Click Save, then add the page to your storefront menu in Content → Menus. Test it on your live storefront with a real fulfilled order number and that customer's email - you should reach Select items to return, and the request then appears on the Requests tab of the Returns page in OrderKrab. On the Settings tab, your store now shows Live.
- 8
Switch to your WordPress admin and go to OrderKrab → Returns. Paste your token into Portal token. Leave Return portal URL as https://returns.orderkrab.com - it is read-only by default, the same protection the API base URL has.
- 9
Still on that tab, set the Max width (default 1200 px), the Iframe height (default 900 px - pick a height tall enough that the portal doesn't scroll inside itself) and the Default language: Match site language follows the visitor's locale and is WPML/Polylang-aware, or pick one of the 10 fixed languages.
- 10
Under Return Portal Colors, match the portal to your brand - leave any color empty to keep the portal's own default. Click Save changes.
- 11
Create the page customers will use: Pages → Add New, name it something recognisable like Returns, and add the OrderKrab Return Portal block. On the classic editor or a page builder, paste the shortcode [orderkrab_return_portal] instead - both render the same portal from the settings you just saved.
- 12
Publish the page, then add it to your storefront menu under Appearance → Menus or the site editor's navigation block. Test it on your live storefront with a real fulfilled order number and that customer's email - you should reach Select items to return, and the request then appears on the Requests tab of the Returns page in OrderKrab. On the Settings tab, your store now shows Live.
Good to know
- When the return label is created, OrderKrab creates a Return on the Shopify order with the label attached as a reverse delivery, and Shopify emails the customer the label and tracking. The request's Customer email then reads Label sent to the customer.
- That Shopify email needs the returns permission on the OrderKrab app. Stores connected before that permission existed keep fulfilling normally but cannot push returns back to Shopify - the dashboard then shows A connected store is missing Shopify permissions. Open Settings → Apps and sales channels → OrderKrab in your Shopify admin, accept the updated permissions, and the warning clears after the next nightly check.
- A dashed Set the Return portal URL and Portal token placeholder means one of the two Connection settings is still empty - and on Shopify that placeholder is public, so finish the setup before you link the page from your menu.
- The returns portal - the Returns page with its Requests, Return carriers and Settings tabs - comes with every plan, LABELS included.
- The portal only works when it is opened from your storefront - the app block, block or shortcode is what passes the token into the iframe. Opening returns.orderkrab.com directly shows "This return portal isn't authorized".
- A customer can start a return when the order is fulfilled and falls within the return window, for items that accept returns and haven't been returned already - products can be excluded individually. With Accept damaged items after the window on, an older order can still be returned if every item is marked Damaged or defective.
- Each click on Copy token creates a new token, and the ones you pasted earlier keep working - you don't have to update a store that already shows Live.
- The token never expires. If your clipboard didn't take it, select it in the field below Copy token instead.
- Approve automatically still needs a return carrier for the buyer's country. Without one the request is created but the label is not: it stays Pending and its window says No return carrier for (country), so set up return carriers for the countries you sell to before switching it on.
- Refunds are never issued automatically. Approve automatically covers the return label and the email, nothing more.