List vendor returns

curl --request GET \
  --url https://api.arcuserp.com/v1/vendor-returns \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/vendor-returns', 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/vendor-returns",
  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/vendor-returns"

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

}

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/vendor-returns")

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

{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "vendor_return",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_return_number": "<string>",
      "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"
    }
  ],
  "has_more": true
}

{
  "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"
}

GET

vendor-returns

List vendor returns

curl --request GET \
  --url https://api.arcuserp.com/v1/vendor-returns \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/vendor-returns', 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/vendor-returns",
  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/vendor-returns"

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

}

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/vendor-returns")

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

{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "vendor_return",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_return_number": "<string>",
      "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"
    }
  ],
  "has_more": true
}

{
  "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.

Query Parameters

status

string

vendor_id

string<uuid>

rma_id

string<uuid>

location_id

string<uuid>

Filter to a single warehouse location (Layer 4 isolation). Resolved from the X-Location-Id request header first, then this query param. Vendor returns inherit location from the originating customer RMA's source order (vendor_returns.rma_id -> returns.original_order_id -> orders.location_id). Vendor returns whose chain resolves to NULL remain visible at every location (NULL-universal).

limit

integer

default:25

Maximum number of records to return per page. Default 25, max 500. Use together with starting_after for cursor pagination. For larger bulk extraction workflows prefer the migration endpoints.

Required range: 1 <= x <= 500

starting_after

string

Cursor for pagination. Pass the id of the last record from the previous page to fetch the next page. Mutually exclusive with ending_before.

Maximum string length: 200

expand[]

enum<string>[]

Available options:

data.vendor,

data.rma,

data.line_items,

data.vendor_credits

Response

Paginated list of vendor returns

object

enum<string>

Available options:

list

data

object[]

Show child attributes

has_more

boolean

Overview

All Endpoints

List vendor returns

Authorizations

Query Parameters

Response