ReturnGO Get Return Label

Retrieves the return shipping label(s) and details for an existing RMA

This action looks up an existing RMA in ReturnGO and returns its return shipping label(s) along with the full RMA details. For example, you can use it to resend a label to a customer whose return is already in progress.

This action does not create or change any RMA. To create a new return, use ReturnGO Create RMA By Policy.

  • If the RMA doesn't exist, the action still finishes normally. RMA Found? is set to False and the flow continues.
  • If the RMA exists but no label has been generated yet, RMA Found? is True and Label Found? is False.
  • An RMA can have more than one shipment, and each shipment can have its own label. Label URL holds the first label. Label URLs holds all of them.

Inputs

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

InputTypeDescription
API SecretStringAuthentication key (sent as the x-api-key header).
Shop NameStringThis refers to the x-shop-name header in the API. The shop to operate on, e.g. example.myshopify.com.

To find your shop URL, click on the "copy" icon next to your store name at the top of the ReturnGO dashboard.
RMA IDStringThe ID of the RMA to get the label for.
Safe ModeOptional BooleanIf set to True, errors (auth failures, rate limits, server errors, timeouts) are returned in the Error output and the flow keeps running. If False, an error stops the flow. Defaults to False.

An RMA that doesn't exist is not treated as an error, whatever this is set to.

Outputs

OutputTypeDescription
Success?BooleanTrue if the API call was successful (including when the RMA doesn't exist); False if the call failed.
RMA Found?BooleanTrue if an RMA matching the RMA ID exists in ReturnGO; False if it doesn't.
Label Found?BooleanTrue if a return label already exists for this RMA.
Label URLStringThe URL of the first return label found, if any.
Label URLsListAll return label URLs found across the RMA's shipments.
RMA DataObjectObject containing the full RMA details. Populated whenever RMA Found? is True.
RMA StatusStringThe current status of the RMA (e.g. Pending, Approved, Done, Rejected). Populated whenever RMA Found? is True, even if no label was found. Null if the RMA doesn't exist.
ErrorStringThe error message when the call fails and Safe Mode is enabled. Null on a successful call.

This action uses the following ReturnGO endpoint:

  • GET /rma/{rmaId}

https://static.returngo.ai/api-doc/returngo-api-swagger.html


Did this page help you?