Preview a post-label-purchase ship-to address change

curl --request POST \
  --url https://api.arcuserp.com/v1/orders/{id}/change-ship-to/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_address_id": "aa11bb22-cc33-dd44-ee55-ff6677889900"
}
'

import requests

url = "https://api.arcuserp.com/v1/orders/{id}/change-ship-to/preview"

payload = { "new_address_id": "aa11bb22-cc33-dd44-ee55-ff6677889900" }
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({new_address_id: 'aa11bb22-cc33-dd44-ee55-ff6677889900'})
};

fetch('https://api.arcuserp.com/v1/orders/{id}/change-ship-to/preview', 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/orders/{id}/change-ship-to/preview",
  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([
    'new_address_id' => 'aa11bb22-cc33-dd44-ee55-ff6677889900'
  ]),
  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/orders/{id}/change-ship-to/preview"

	payload := strings.NewReader("{\n  \"new_address_id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\"\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/orders/{id}/change-ship-to/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"new_address_id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/orders/{id}/change-ship-to/preview")

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  \"new_address_id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "order": {},
    "current_address": {},
    "new_address": {},
    "new_address_payload_validation": {},
    "active_labels": [
      {}
    ],
    "void_refund_eligibility": [
      {}
    ],
    "in_transit_labels": [
      {}
    ],
    "total_estimated_refund": 123,
    "repurchase_required": true,
    "intercept_required": 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"
}

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

Orders

Preview a post-label-purchase ship-to address change

Read-only preview of the post-label Change-Ship-To wizard. Returns the current shipping address, the new address candidate (or the Triple-lock validator verdict for a raw payload), the list of active Shippo labels that would be voided, per-label refund eligibility hints, the carrier-specific in-transit gating flag, and the total estimated refund. No DB writes; no Shippo or Stripe calls.

Use this to render the wizard’s cost-impact confirmation step before the operator submits the destructive execute. Carrier-specific void deadlines (USPS 28 days pre-scan; UPS 90 days pre-pickup; FedEx same-day) are reflected in the refundability_hint field per label.

Sister to POST /v1/orders/{id}/change-ship-to. Requires orders:read scope.

Filed by NEW-GAP-CS-ADDRESS-CHANGE-POST-LABEL-PURCHASE + NEW-GAP- CHANGE-SHIP-TO-WIZARD-VOID-AND-REPURCHASE (2026-05-16).

Industry parallel: Shopify Edit Order ship-to preview (admin only); NetSuite Reverse Fulfillment confirmation step.

POST

orders

{id}

change-ship-to

preview

Preview a post-label-purchase ship-to address change

curl --request POST \
  --url https://api.arcuserp.com/v1/orders/{id}/change-ship-to/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_address_id": "aa11bb22-cc33-dd44-ee55-ff6677889900"
}
'

import requests

url = "https://api.arcuserp.com/v1/orders/{id}/change-ship-to/preview"

payload = { "new_address_id": "aa11bb22-cc33-dd44-ee55-ff6677889900" }
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({new_address_id: 'aa11bb22-cc33-dd44-ee55-ff6677889900'})
};

fetch('https://api.arcuserp.com/v1/orders/{id}/change-ship-to/preview', 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/orders/{id}/change-ship-to/preview",
  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([
    'new_address_id' => 'aa11bb22-cc33-dd44-ee55-ff6677889900'
  ]),
  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/orders/{id}/change-ship-to/preview"

	payload := strings.NewReader("{\n  \"new_address_id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\"\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/orders/{id}/change-ship-to/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"new_address_id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/orders/{id}/change-ship-to/preview")

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  \"new_address_id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "order": {},
    "current_address": {},
    "new_address": {},
    "new_address_payload_validation": {},
    "active_labels": [
      {}
    ],
    "void_refund_eligibility": [
      {}
    ],
    "in_transit_labels": [
      {}
    ],
    "total_estimated_refund": 123,
    "repurchase_required": true,
    "intercept_required": 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"
}

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

Path Parameters

string<uuid>

required

UUID of the order to preview a ship-to change for.

Body

application/json

new_address_id

string<uuid>

Existing account_addresses.id to switch to (must belong to the order's account).

new_address_payload

object

Raw address payload to validate (preview-only; not persisted here). Provide either this OR new_address_id.

Show child attributes

Response

Preview returned successfully.

data

object

Show child attributes

Overview

All Endpoints

Preview a post-label-purchase ship-to address change

Authorizations

Path Parameters

Body

Response