Skip to main content
GET
/
returns
/
{id}
Retrieve a single RMA
curl --request GET \
  --url https://api.arcuserp.com/v1/returns/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.arcuserp.com/v1/returns/{id}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/returns/{id}', 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.arcuserp.com/v1/returns/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.arcuserp.com/v1/returns/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/returns/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/returns/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "return",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "return_number": "<string>",
  "original_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_rma_number": "<string>",
  "inspection_required": true,
  "restocking_fee": 123,
  "refund_amount": 123,
  "return_to_vendor": true,
  "notes": "<string>",
  "metadata": {},
  "received_at": "2023-11-07T05:31:56Z",
  "closed_at": "2023-11-07T05:31:56Z",
  "cancelled_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}
{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}
{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_ Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Path Parameters

id
string<uuid>
required

Query Parameters

expand[]
enum<string>[]
Available options:
items,
items.product,
refunds,
original_order,
gl_entries,
return_label,
vendor_return

Response

RMA object

RMA (return merchandise authorization). Phase A -- refund_amount is readOnly via PATCH; written only by POST /v1/returns/{id}/refund.

id
string<uuid>
object
enum<string>
Available options:
return
entity_id
string<uuid>
read-only
return_number
string
read-only
status
enum<string>
read-only

Use action endpoints to transition status; PATCH cannot write status.

Available options:
authorized,
expected,
received,
inspecting,
restocked,
written_off,
closed,
sent_to_vendor,
cancelled
original_order_id
string<uuid>
account_id
string<uuid>
vendor_id
string<uuid> | null
vendor_rma_number
string | null
inspection_required
boolean
restocking_fee
number | null
refund_amount
number | null
read-only

SSOT: written only by POST /v1/returns/{id}/refund (refundReturn canonical). PATCH cannot write this field.

return_to_vendor
boolean
source
enum<string> | null
Available options:
csr,
customer_portal,
marketplace
notes
string | null
metadata
object | null
received_at
string<date-time> | null
read-only
closed_at
string<date-time> | null
read-only
cancelled_at
string<date-time> | null
read-only
created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only