Swap Get Returns by RMA

This action is used to retrieve a list of returns in Swap, using a given RMA.

See also the documentation from Swap where detailed request and response examples can be found.


Inputs

In order to use the action in your flow you need to provide it with the following inputs:

InputTypeDescription
API KeyCredentialsSwap API Key
StoreCredentialsSwap Store Code
RMAStringRMA of order to retrieve returns
Base URLStringBase URL for the returns portal to query, depending on your store setup.

There are four possible options for the baseUrl parameter, each corresponding to a different deployment of the Swap returns platform:

  • returnsportal.co - this is the "default" domain, used for most stores still running on the legacy version of the platform.
  • returnsportal.shop - used for stores that have already migrated to the new version of the returns platform.
  • returnportal.co and returns-portal.com - these are custom domains set up for specific stores as needed.

Choose the domain that matches the configuration of your store. Please note that the RMA search endpoint may not be available for stores already migrated to the new platform (returnsportal.shop) yet.

In case of doubt, confirm with the client what the correct base URL is.


Outputs

OutputTypeDescription
SuccessBooleanWhether order was successfully cancelled
ResponseObjectReturns data from Swap