Skip to main content
GET
/
vendor-returns
/
{id}
Retrieve a single vendor return
curl --request GET \
  --url https://api.arcuserp.com/v1/vendor-returns/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "vendor_return",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_return_number": "<string>",
  "status": "pending",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rma_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_rma_number": "<string>",
  "tracking_number": "<string>",
  "shipped_at": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "metadata": {},
  "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:
vendor,
rma,
line_items,
vendor_credits

Response

Vendor return object

Vendor-side RMA (goods sent back to supplier).

​
id
string<uuid>
​
object
enum<string>
Available options:
vendor_return
​
entity_id
string<uuid>
read-only
​
vendor_return_number
string
read-only
​
status
enum<string>
read-only
Available options:
pending,
shipped_to_vendor,
credit_received,
replacement_received,
closed,
cancelled
​
vendor_id
string<uuid>
​
rma_id
string<uuid> | null
​
vendor_rma_number
string | null
​
tracking_number
string | null
​
shipped_at
string<date-time> | null
read-only
​
notes
string | null
​
metadata
object
​
created_at
string<date-time>
read-only
​
updated_at
string<date-time>
read-only