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>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "return",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "return_number": "<string>",
  "status": "authorized",
  "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,
  "source": "csr",
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
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