Process Return

curl --request POST \
  --url https://api.loopreturns.com/api/v1/warehouse/return/{id}/process \
  --header 'X-Authorization: <api-key>'

import requests

url = "https://api.loopreturns.com/api/v1/warehouse/return/{id}/process"

headers = {"X-Authorization": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'X-Authorization': '<api-key>'}};

fetch('https://api.loopreturns.com/api/v1/warehouse/return/{id}/process', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.loopreturns.com/api/v1/warehouse/return/{id}/process",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.loopreturns.com/api/v1/warehouse/return/{id}/process"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.loopreturns.com/api/v1/warehouse/return/{id}/process")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

true

{
  "errors": "Unauthorized."
}

Return Actions

Process Return

Process a return in Loop based on the return ID. Processing a return will archive it in Loop and fulfill any remaining outcomes, such as placing exchange orders or creating gift cards.

⚡ Processing Note

This endpoint queues the return for processing. The actual processing occurs in the background. HTTP 200 with body true is an acknowledgement that Loop queued the work. It is not proof that processing completed.

Confirming the outcome

After Loop returns true, confirm the terminal result with webhooks:

Success: return.closed on the Return topic.
Background failure: return.processing.failed on the Return Processing topic.

The failure webhook message can be generic or null. Do not treat it as a stable error code.

This failure webhook does not cover synchronous refusals. If Loop refuses the request, the HTTP 200 response includes an errors body instead of true. Loop does not send return.processing.failed for that case.

Note on instant refunds

If the return has an open Reshop instant-refund credit, processing is intentionally skipped: a successful (true) response is returned without dispatching any processing jobs.

Optionally, you may include a JSON payload in the request body. If you choose to do so, Loop will add these values to any new orders in the commerce provider (e.g. Shopify) that result from processing the return. For example, if the return includes an exchange when the return is processed, Loop will create that exchange order and these values will be added to the order as “Additional Details.” Loop will also add a note to the return timeline with the values in the request body.

🚧 Process Error Codes

Returns must be in a processable state to successfully process. If your return is not in a processable state, your response will include an errors object with a corresponding message and error code.

If you would like to configure your flagged returns to process, please reach out to support@loopreturns.com.

{
  "errors": {
    "message": "Return is open and therefore cannot be processed.",
    "code": "UNPROCESSABLE_FLAGGED_RETURN"
  }
}

Required API key scope

Returns

POST

warehouse

return

{id}

process

Process Return

curl --request POST \
  --url https://api.loopreturns.com/api/v1/warehouse/return/{id}/process \
  --header 'X-Authorization: <api-key>'

import requests

url = "https://api.loopreturns.com/api/v1/warehouse/return/{id}/process"

headers = {"X-Authorization": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'X-Authorization': '<api-key>'}};

fetch('https://api.loopreturns.com/api/v1/warehouse/return/{id}/process', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.loopreturns.com/api/v1/warehouse/return/{id}/process",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.loopreturns.com/api/v1/warehouse/return/{id}/process"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.loopreturns.com/api/v1/warehouse/return/{id}/process")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

true

{
  "errors": "Unauthorized."
}

Authorizations

X-Authorization

string

header

required

Path Parameters

integer

required

The unique identifier associated with the return.

Response

Success - HTTP 200 with true means Loop queued processing (acknowledgement, not completion). HTTP 200 with an errors body means Loop refused the request before queueing.

The value returned when the return action succeeds.

Example:

true

Using the API

APIs

Process Return

Confirming the outcome

Required API key scope

Authorizations

Path Parameters

Response