Skip to content

Magento

Available features

Functionality Magento 2 Magento Adobe Commerce
Get orders
Refunds
Exchanges
Store credit
Return rates

REST API integration details

This integration is available via Magento REST API. To connect your Magento store to our returns management platform, you will need to provide the following information:

  • Shop URL | Magento Base Path
  • Image Host and Path

OAuth credentials:

  • Consumer Key
  • Consumer Secret Key
  • Access Token Secret Key
  • Access Token

Whitelist our IP addresses to test on test/staging environments protected by a firewall.

Settings

Return policy

Return states

Allows you to decide which order states should be eligible for returns. By default our platform will use Complete.

Exclude product categories

You can use this option to prevent specific product categories from being eligible for returns. This makes sure certain products are not shown on the return process.

Exchanges settings

SETTING MANDATORY DESCRIPTION
Size attributes Mandatory Allows you to choose all attributes that could be offered as exchange options. Please note we only support exchange options for the "size" attribute. RMP will prioritise them according to the order selected.
Stock Optional Choose if our platform should check stock availability for each product before showing the exchange option to customers. If disabled, the Returns Portal will always offer exchange options for configurable products, even when not available in inventory.
Multi source inventory (MSI) Optional Allows you to choose MSI codes our platform should use to check if stock is available.
Shipping details Optional By default we will use the consumer's shipping details from the original order. For example, if a consumer has received their purchase on a service point delivery, our platform will ship the exchange order to that same service point. You are also able to choose one unique method to be used for all orders.
Free shipping Optional Required if Magento store doesn’t offer free shipping. When enabled exchange orders discount will be applied to the shipping amount.
Auto invoice Optional Automatically creates an invoice for exchange orders.

Magento resource permissions

Navigate to System > Integration to select Returnista's app. Go to API to edit Resource Access.

The sales, customers and products resources are required to allow our system to fetch the order information for the return flow. This allows us to authenticate consumers, and to access the products in their orders. Marketing resources are required in order to create and apply discounts for exchange and store credit requests.

FOLDER RESOURCE PERMISSION RESOLUTIONS
Sales Orders - Refund, Exchanges, Store credit
Customers All - Refund, Exchanges, Store credit
Catalog Inventory Products Refund, Exchanges
Catalog Inventory Categories Exchanges
Stores Attributes Product Refund, Exchanges, Store credit
Marketing Promotions Catalog price rule Exchanges, Store credit
Marketing Promotions Cart price rule Exchanges, Store credit
Stores Inventory - Exchanges
Stores Settings All stores Refund, Exchanges, Store credit
Stores Settings Configuration> Inventory section Exchanges