Skip to main content
POST
/
returns
/
{id}
/
disposition
Disposition items (restock / writeoff / sent_to_vendor)
curl --request POST \
  --url https://api.arcuserp.com/v1/returns/{id}/disposition \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "return_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 2,
      "final_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "force_restock": true,
      "force_restock_reason": "<string>",
      "leaves": [
        {
          "leaf_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "leaf_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "final_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "notes": "<string>"
        }
      ]
    }
  ]
}
'
import requests

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

payload = { "items": [
        {
            "return_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity": 2,
            "final_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "force_restock": True,
            "force_restock_reason": "<string>",
            "leaves": [
                {
                    "leaf_order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "leaf_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "final_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "notes": "<string>"
                }
            ]
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {
        return_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        quantity: 2,
        final_location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        force_restock: true,
        force_restock_reason: '<string>',
        leaves: [
          {
            leaf_order_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
            leaf_product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
            final_location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
            notes: '<string>'
          }
        ]
      }
    ]
  })
};

fetch('https://api.arcuserp.com/v1/returns/{id}/disposition', 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}/disposition",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
                'return_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'quantity' => 2,
                'final_location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'force_restock' => true,
                'force_restock_reason' => '<string>',
                'leaves' => [
                                [
                                                                'leaf_order_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                                                'leaf_product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                                                'final_location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                                                'notes' => '<string>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"return_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 2,\n      \"final_location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"force_restock\": true,\n      \"force_restock_reason\": \"<string>\",\n      \"leaves\": [\n        {\n          \"leaf_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n          \"leaf_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n          \"final_location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n          \"notes\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/returns/{id}/disposition")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"return_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 2,\n      \"final_location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"force_restock\": true,\n      \"force_restock_reason\": \"<string>\",\n      \"leaves\": [\n        {\n          \"leaf_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n          \"leaf_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n          \"final_location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n          \"notes\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"return_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 2,\n      \"final_location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"force_restock\": true,\n      \"force_restock_reason\": \"<string>\",\n      \"leaves\": [\n        {\n          \"leaf_order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n          \"leaf_product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n          \"final_location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n          \"notes\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "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"
}
{
  "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.

Headers

​
Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
items
object[]
required

Response

Items dispositioned