Magento 2

By connecting a Magento 2 web store to Returnless, you can easily set up a return form for your Magento 2 web store. Returns that are created can then be easily, automatically processed. The connection also makes it possible to process coupons and credits.

The Magento 2 integration has these features:

Feature Available
Search order
Create coupon
Create refund
Create gift card
Create return
Return importer

Installation

The connection is set up via the Magento REST API. There is no need to install a Magento extension.

Adding an integration

To create a new integration between Returnless and Magento 2, follow these steps:

  1. Login to your return panel
  2. Navigate to the Settings > Integrations page where you will find the E-commerce platform section.
  3. To add a new integration, select the Add new integration button.
  4. Select the Magento 2 integration. A modal will open with further instructions to finish the installation.

In case you're testing on a staging environment which is protected with a firewall, please whitelist our IP address.

Activating the integration

To activate the integration, you will need to enable the integration in a return form. Follow these steps:

  1. Login to your Return panel
  2. Navigate to Settings > Return forms and open the applicable return form.
  3. Go to the Integrations tab and select the Magento 2 which you've added in the previous step.

Settings

  • Login to your return panel
  • Navigate to the Settings > Integrations page where you will find the E-commerce platform section.
  • Click the Settings button at the appropiate Magento 2 integration. Here you will find the settings for the integration.

Search order settings

Setting Description
Label input field By default the search order field in the return form will be labeled "Order number". In case you want to change the label, type an alternative label here.
Order prefix If you use any custom prefixes in your order number, you can enter the prefix to higher the chance that the order can be found. Example: if you enter prefix ORD    , both searching for 123 or ORD123 will give the correct result.
Order input field placeholder A placeholder for the search order field to help your customers. For example ORD000123    .
Validation method We will use this parameter to validate if the order is really placed by this consmer.
Bundled Products Define whether you will show or hide child products, whether you can allow a bundle to be returned partially or only in full.

Create coupon settings

Important: Please verify if your consumer queue is running properly in Magento, to make sure that coupon usage is calculated correctly. More information.

Coupons are very useful in case you want to offer your customers an easy way to receive a refund and order a new product on your web store. Because you do not need to do a money refund, coupons are often seen as a perfect way to maximize your revenue while providing a smooth customer experience.

Setting Description
Coupon can be used for shipping amount When enabled, the coupon amount can also be used to pay for any shipping costs which might occur when placing the new order.
Stop further rules processing in Magento This option in Magento offers the possibility to prevent any other coupon codes or promotion rules with a lower priority to be used for the same order.
Coupon name Magento offers the possibility to set a name for a coupon. By adding a coupon name it might be easier to recognize coupons created through Returnless.
Description Magento offers the possibility to set a description for a coupon. By adding a coupon description it might be easier to recognize coupons created through Returnless.
Coupon expiration Select a period in which the coupon has to be used by the consumer before it expires. Please note that there may be legal regulations that specify a minimum period.

Create Credit invoice settings

The create credit invoice action is not supported for sales orders with more than 1 invoice. If the order does contain more than 1 invoice, manually handle the credit invoice action in Magento.


Offline payment methods of the following type cannot be refunded due to limitations on Magento 2:

- Zero Subtotal Checkout

- Check / Money order

- Bank transfer payment

- Cash on Delivery Payment

- Purchase order

Credit memo's are a powerful way to refund an order. It will enable you to instantly refund an order, update stock levels and keep your bookkeeping up to date.

Setting Description
Send Magento email to customer When enabled, Magento will send an email to your customer with the created credit memo details.
Default include shipping amount When creating a credit memo, Magento offers the possibility to refund shipping costs for the order. Using this setting you can decide if this option should be enabled or disabled by default.
Online Refund Allow orders paid by credit card through a payment gateway, such as PayPal or Braintree to be refunded online via the payment processor.

Basic Authorization

In case your Magento 2 web store is still under development, or you want to connect Returnless to a staging environment protected with Basic Authorization, you can enter the login details to authorize access.

Custom attributes

Customize any optional custom attributes which you might have.

Setting Description
Brand attribute Enter the product attribute code for the attribute which is used to set the brand of a product.
Barcode attribute code Enter the product attribute code for the attribute which is used to set the barcode of a product.
Length attribute code Enter the product attribute code for the attribute which is used to set the length of a product. The value should be in centimetres and not include an addition such as 'cm'. Furthermore, if using decimals, a comma is not supported. Accepted examples: 1234    , 1234.5    . Not supported examples (1234,5    , 1.234,5    , 1,234.5    ).
Width attribute code Enter the product attribute code for the attribute which is used to set the width of a product. The value should be in centimetres and not include an addition such as 'cm'. Accepted examples: 1500    , 1500.5    .
Height attribute code Enter the product attribute code for the attribute which is used to set the height of a product. The value should be in centimetres and not include an addition such as 'cm'. Accepted examples: 1500    , 1500.5    .
Image Choose which image to show on your return form, options are: base image, small image, thumbnail, swatch image
Unit weight in Magento 2 The unit in which the weight is set in Magento 2. In Returnless, the weight is stored in grams. If you choose kilograms here, the value will be multiplied by 1000 before it is stored in Returnless.

Advanced settings

Setting Description
Base URL to Magento 2 admin We suggest to enter your Magento 2 admin URL, we will use this to generate a link to the sales order in your Magento 2 admin from the return detail page. Example: https://www.mystore.com/admin_19r893j9    
Replace Magento 2 base URL with CDN URL for images Enable this toggle in case you're using a CDN to host your Magento 2 product images.
CDN base URL for media Enter the CDN URL where your product images are hosted. Example: https://cdn.mystore.com/    

Learn more about using a CDN

Default situation

base_url     + "media/catalog/product"     + image_url    

Example:

  • Image URL: /1/9/product_a.jpg    
  • Base URL: https://www.mystore.com    
  • Final image URL: https://www.mystore.com/media/catalog/product/1/9/product_a.jpg    

CDN example 1 (relative URL)

cdn_url     + "media/catalog/product"     + image_url    

Example:

  • Image URL: "file": "/1/9/product_a.jpg"    
  • CDN URL: "https://cdn.mystore.com"    
  • Final image URL: https://cdn.mystore.com/media/catalog/product/1/9/product_a.jpg    

CDN example 2 (absolute URL using empty CDN URL)

cdn_url     + image_url    

Example:

  • Image URL: https://cdn.mystore.com/media/catalog/product/1/9/product_a.jpg    
  • CDN URL: None
  • Final image URL: https://cdn.mystore.com/media/catalog/product/1/9/product_a.jpg    
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us