Change a return's location
curl --request POST \
--url https://api.arcuserp.com/v1/returns/{id}/return-location \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "<string>"
}
'import requests
url = "https://api.arcuserp.com/v1/returns/{id}/return-location"
payload = {
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "<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({location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', reason: '<string>'})
};
fetch('https://api.arcuserp.com/v1/returns/{id}/return-location', 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}/return-location",
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([
'location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'reason' => '<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}/return-location"
payload := strings.NewReader("{\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reason\": \"<string>\"\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}/return-location")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/returns/{id}/return-location")
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 \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"return_location_change": {
"changed": true,
"return_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"return_location_source": "<string>",
"before": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>",
"source": "<string>"
},
"after": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>",
"source": "<string>"
}
},
"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",
"return_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"return_location_source": "order",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_rma_number": "<string>",
"inspection_required": true,
"restocking_fee": 123,
"restocking_bound": {
"code": "restocking_fee_above_entity_max",
"entity_fee_min": 123,
"entity_fee_max": 123,
"outcome": "clamped",
"from": 123,
"to": 123,
"source": "stamp",
"words": "<string>"
},
"refund_amount": 123,
"return_to_vendor": true,
"refund_hold": true,
"refund_hold_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"refund_hold_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"refund_hold_at": "2023-11-07T05:31:56Z",
"is_pre_settlement": true,
"estimated_refund_amount": 123,
"estimated_refund_tax": 123,
"money_suppression": {
"basis": "decision",
"whole_no_money": true,
"unreadable": true,
"waived_goods": 123,
"waived_tax": 123,
"legacy_swap": {}
},
"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",
"return_label_refund_status": "pending",
"return_label_void_requested_at": "2023-11-07T05:31:56Z",
"return_label_voided_at": "2023-11-07T05:31:56Z",
"return_label_refunded_at": "2023-11-07T05:31:56Z",
"return_label_refund_detail": "<string>",
"return_label_freight_je_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"return_label_freight_owed_at": "2023-11-07T05:31:56Z",
"return_label_freight_error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"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",
"message": "<string>",
"permission_key": "<string>",
"role": "<string>"
}{
"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",
"door": "<string>",
"return_receipt_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"meta": {}
}{
"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",
"door": "<string>",
"return_receipt_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"meta": {}
}Returns
Change a return's location
Sets the warehouse the return’s goods come back to (the return’s location; a receipt books its units into the Holding location whatever it names). Never a Holding or write-off location. Free while nothing is received; once goods are received, only with a reason. A return imported from another system keeps the location of its order. Sending the location the return already has changes nothing (return_location_change.changed: false). The change is written on the return’s activity with the location before and after, under the key’s creator. Requires the returns:write scope and, for the key’s creator, the returns.edit permission.
POST
/
returns
/
{id}
/
return-location
Change a return's location
curl --request POST \
--url https://api.arcuserp.com/v1/returns/{id}/return-location \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "<string>"
}
'import requests
url = "https://api.arcuserp.com/v1/returns/{id}/return-location"
payload = {
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "<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({location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', reason: '<string>'})
};
fetch('https://api.arcuserp.com/v1/returns/{id}/return-location', 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}/return-location",
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([
'location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'reason' => '<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}/return-location"
payload := strings.NewReader("{\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reason\": \"<string>\"\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}/return-location")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/returns/{id}/return-location")
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 \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"return_location_change": {
"changed": true,
"return_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"return_location_source": "<string>",
"before": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>",
"source": "<string>"
},
"after": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"name": "<string>",
"source": "<string>"
}
},
"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",
"return_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"return_location_source": "order",
"vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_rma_number": "<string>",
"inspection_required": true,
"restocking_fee": 123,
"restocking_bound": {
"code": "restocking_fee_above_entity_max",
"entity_fee_min": 123,
"entity_fee_max": 123,
"outcome": "clamped",
"from": 123,
"to": 123,
"source": "stamp",
"words": "<string>"
},
"refund_amount": 123,
"return_to_vendor": true,
"refund_hold": true,
"refund_hold_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"refund_hold_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"refund_hold_at": "2023-11-07T05:31:56Z",
"is_pre_settlement": true,
"estimated_refund_amount": 123,
"estimated_refund_tax": 123,
"money_suppression": {
"basis": "decision",
"whole_no_money": true,
"unreadable": true,
"waived_goods": 123,
"waived_tax": 123,
"legacy_swap": {}
},
"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",
"return_label_refund_status": "pending",
"return_label_void_requested_at": "2023-11-07T05:31:56Z",
"return_label_voided_at": "2023-11-07T05:31:56Z",
"return_label_refunded_at": "2023-11-07T05:31:56Z",
"return_label_refund_detail": "<string>",
"return_label_freight_je_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"return_label_freight_owed_at": "2023-11-07T05:31:56Z",
"return_label_freight_error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"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",
"message": "<string>",
"permission_key": "<string>",
"role": "<string>"
}{
"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",
"door": "<string>",
"return_receipt_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"meta": {}
}{
"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",
"door": "<string>",
"return_receipt_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"meta": {}
}Authorizations
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
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. A second request with the same
key sent while the first is still running waits for it and returns its
answer; if the first is still running after 20 seconds the second
answers 409 idempotency_key_in_use (retryable, nothing done). An
answer carrying retryable: true is not cached. Reusing a key with a
different request body answers 409 idempotency_key_collision (nothing
done; send the new request with a fresh key). The replay, the wait and
these two 409 codes come from the idempotency layer, so they apply to
the operations that run it, each of which can answer the two codes
whether or not its own 409 response lists them. The handlers of these
operations take the header but do not run the layer, so on them the key
neither replays nor answers either code: createPaymentPlan,
chargePaymentPlanInstallment, setProductLocations, updateOrder,
emailOrder, updateOrderItem, confirmPickup, markOrderNoShow,
applyExistingPaymentToInvoices, updatePackage, movePackageItem,
changePackageBox, changePackageCarrier, voidPackageLabel,
printPackageLabel, emailPackage, setProNumberV1, setPackageProNumber,
sendPurchaseOrderToVendorV1, notifyRevisionPurchaseOrderV1,
addMaintenanceLog, generateBOLV1,
createReportJobV1 and customerAcknowledgeRevision; recordVendorPrepaymentV1
and recordCustomerDepositV1 hand the key to their own write instead.
Maximum string length:
255Path Parameters
Body
application/json
A warehouse of this entity. Missing or not a valid id is refused 422 missing_field; not this entity's 422 location_not_found; a Holding or write-off location 422 return_location_not_a_warehouse.
Why the location changes, in 10 characters or more; required once goods are received on the return (else 422 reason_required).
Minimum string length:
10Response
Set (or already so). The return as GET /returns/{id} answers it, with the change as return_location_change.
RMA (return merchandise authorization). Phase A -- refund_amount is readOnly via PATCH; written only by POST /v1/returns/{id}/refund.
Show child attributes
Show child attributes
Was this page helpful?