Skip to main content
GET
/
returns
List RMAs (return merchandise authorizations)
curl --request GET \
  --url https://api.arcuserp.com/v1/returns \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "has_more": true
}

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.

Query Parameters

​
status
enum<string>
Available options:
authorized,
expected,
received,
inspecting,
restocked,
written_off,
closed,
sent_to_vendor,
cancelled
​
account_id
string<uuid>
​
original_order_id
string<uuid>
​
search
string
​
expand[]
enum<string>[]
Available options:
items,
refunds,
original_order,
gl_entries,
return_label,
vendor_return

Response

Paginated list of RMAs

​
object
enum<string>
Available options:
list
​
data
object[]
​
has_more
boolean