Change the ship-to address on an order after labels are purchased

curl --request POST \
  --url https://api.arcuserp.com/v1/orders/{id}/change-ship-to \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_address_id": "aa11bb22-cc33-dd44-ee55-ff6677889900",
  "also_change_billing": false,
  "confirm_void_labels": true,
  "confirm_repurchase_labels": true,
  "repurchase_strategy": "auto_cheapest",
  "reason": "Customer corrected ZIP; was 90210, should be 92010."
}
'

import requests

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

payload = {
    "new_address_id": "aa11bb22-cc33-dd44-ee55-ff6677889900",
    "also_change_billing": False,
    "confirm_void_labels": True,
    "confirm_repurchase_labels": True,
    "repurchase_strategy": "auto_cheapest",
    "reason": "Customer corrected ZIP; was 90210, should be 92010."
}
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',
    also_change_billing: false,
    confirm_void_labels: true,
    confirm_repurchase_labels: true,
    repurchase_strategy: 'auto_cheapest',
    reason: 'Customer corrected ZIP; was 90210, should be 92010.'
  })
};

fetch('https://api.arcuserp.com/v1/orders/{id}/change-ship-to', 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",
  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',
    'also_change_billing' => false,
    'confirm_void_labels' => true,
    'confirm_repurchase_labels' => true,
    'repurchase_strategy' => 'auto_cheapest',
    'reason' => 'Customer corrected ZIP; was 90210, should be 92010.'
  ]),
  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"

	payload := strings.NewReader("{\n  \"new_address_id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n  \"also_change_billing\": false,\n  \"confirm_void_labels\": true,\n  \"confirm_repurchase_labels\": true,\n  \"repurchase_strategy\": \"auto_cheapest\",\n  \"reason\": \"Customer corrected ZIP; was 90210, should be 92010.\"\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"new_address_id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n  \"also_change_billing\": false,\n  \"confirm_void_labels\": true,\n  \"confirm_repurchase_labels\": true,\n  \"repurchase_strategy\": \"auto_cheapest\",\n  \"reason\": \"Customer corrected ZIP; was 90210, should be 92010.\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"also_change_billing\": false,\n  \"confirm_void_labels\": true,\n  \"confirm_repurchase_labels\": true,\n  \"repurchase_strategy\": \"auto_cheapest\",\n  \"reason\": \"Customer corrected ZIP; was 90210, should be 92010.\"\n}"

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

{
  "data": {
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_number": "<string>",
    "old_shipping_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "new_shipping_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "new_shipping_address": {},
    "voided_labels": [
      {}
    ],
    "new_labels": [
      {}
    ],
    "rate_deltas": [
      {}
    ],
    "charge_results": [
      {}
    ],
    "purchase_failures": [
      {}
    ],
    "repurchase_strategy": "<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"
}

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

Change the ship-to address on an order after labels are purchased

Destructive Change-Ship-To wizard execute. The everyday PATCH path (PATCH /v1/orders/{id}) refuses to mutate shipping_address_id while active Shippo labels exist (the post-label silent-misship hard block). This endpoint is the CS Lead override that orchestrates the full void-then-repurchase flow in one transactional sweep:

Asserts orders.override_post_label_edit (server-side; equivalent to the public-API destructive scope combination below).
Resolves the new address: either existing new_address_id OR creates a new account_addresses row from new_address_payload via the canonical addAddress() helper (Triple-lock validation Shippo USPS CASS + AvaTax fires inline).
For every active label on the order, voids via the canonical voidLabel handler (Shippo refund API + GL reversal of the freight JE keyed label:<id> + residential-surcharge reversal if last active label + activity log).
Atomically updates orders.shipping_address_id (and optionally billing_address_id if also_change_billing=true).
Calls recalculateTaxForOrder against the new destination (AvaTax re-finalization).
Per repurchase_strategy: auto-buys the cheapest new label per package (auto_cheapest), returns the rate set for the operator to choose (manual), or skips repurchase entirely (defer).
For every new label, calls the canonical createShippingDeltaCharge helper to bill/refund the customer for the rate delta vs original (idempotent on label_id).
Logs ONE structured ORDER_SHIP_TO_CHANGED_VIA_WIZARD activity row with full metadata, and broadcasts order.ship_to_changed.

Both confirm_void_labels=true AND confirm_repurchase_labels=true are required (unless repurchase_strategy=defer, which only needs confirm_void_labels=true). This is the two-key safety gate equivalent of the wizard’s review-confirm step in the UI.

Partial failure semantics: if any label refuses to void (e.g. carrier-scanned, in-transit), the orders row is NOT updated. Response returns 422 partial_void_failure with the list of labels that did void + the offender so the operator can route to carrier Package Intercept.

Scopes: orders:write AND fulfillment:write both required. Idempotency: Idempotency-Key header is supported; repeat submissions return the original response without re-charging.

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 (void + reissue); NetSuite Reverse Fulfillment + Re-fulfill; Acumatica Cancel Shipment

Reissue.

POST

orders

{id}

change-ship-to

Change the ship-to address on an order after labels are purchased

curl --request POST \
  --url https://api.arcuserp.com/v1/orders/{id}/change-ship-to \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_address_id": "aa11bb22-cc33-dd44-ee55-ff6677889900",
  "also_change_billing": false,
  "confirm_void_labels": true,
  "confirm_repurchase_labels": true,
  "repurchase_strategy": "auto_cheapest",
  "reason": "Customer corrected ZIP; was 90210, should be 92010."
}
'

import requests

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

payload = {
    "new_address_id": "aa11bb22-cc33-dd44-ee55-ff6677889900",
    "also_change_billing": False,
    "confirm_void_labels": True,
    "confirm_repurchase_labels": True,
    "repurchase_strategy": "auto_cheapest",
    "reason": "Customer corrected ZIP; was 90210, should be 92010."
}
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',
    also_change_billing: false,
    confirm_void_labels: true,
    confirm_repurchase_labels: true,
    repurchase_strategy: 'auto_cheapest',
    reason: 'Customer corrected ZIP; was 90210, should be 92010.'
  })
};

fetch('https://api.arcuserp.com/v1/orders/{id}/change-ship-to', 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",
  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',
    'also_change_billing' => false,
    'confirm_void_labels' => true,
    'confirm_repurchase_labels' => true,
    'repurchase_strategy' => 'auto_cheapest',
    'reason' => 'Customer corrected ZIP; was 90210, should be 92010.'
  ]),
  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"

	payload := strings.NewReader("{\n  \"new_address_id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n  \"also_change_billing\": false,\n  \"confirm_void_labels\": true,\n  \"confirm_repurchase_labels\": true,\n  \"repurchase_strategy\": \"auto_cheapest\",\n  \"reason\": \"Customer corrected ZIP; was 90210, should be 92010.\"\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"new_address_id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n  \"also_change_billing\": false,\n  \"confirm_void_labels\": true,\n  \"confirm_repurchase_labels\": true,\n  \"repurchase_strategy\": \"auto_cheapest\",\n  \"reason\": \"Customer corrected ZIP; was 90210, should be 92010.\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"also_change_billing\": false,\n  \"confirm_void_labels\": true,\n  \"confirm_repurchase_labels\": true,\n  \"repurchase_strategy\": \"auto_cheapest\",\n  \"reason\": \"Customer corrected ZIP; was 90210, should be 92010.\"\n}"

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

{
  "data": {
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_number": "<string>",
    "old_shipping_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "new_shipping_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "new_shipping_address": {},
    "voided_labels": [
      {}
    ],
    "new_labels": [
      {}
    ],
    "rate_deltas": [
      {}
    ],
    "charge_results": [
      {}
    ],
    "purchase_failures": [
      {}
    ],
    "repurchase_strategy": "<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"
}

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

string<uuid>

required

UUID of the order to change ship-to for.

Body

application/json

confirm_void_labels

boolean

required

REQUIRED. Two-key safety gate; must be true to authorize label void.

new_address_id

string<uuid>

Existing account_addresses.id (mutually exclusive with new_address_payload).

new_address_payload

object

Raw address payload; creates a new account_addresses row via the canonical addAddress helper.

Show child attributes

also_change_billing

boolean

default:false

Also copy the new address into billing_address_id.

confirm_repurchase_labels

boolean

REQUIRED unless repurchase_strategy=defer.

repurchase_strategy

enum<string>

default:auto_cheapest

auto_cheapest = auto-buy cheapest new label per package; manual = return rates and let operator choose; defer = leave packages unlabeled for the warehouse.

Available options:

auto_cheapest,

manual,

defer

payment_method_id

string<uuid> | null

Optional Stripe payment_method to bill the rate delta.

user_id

string<uuid> | null

Audit attribution; defaults to API key owner if omitted.

reason

string | null

Operator note for the audit log.

Response

Ship-to changed successfully (may include partial purchase_failures with HTTP 200 when at least one new label posted).

data

object

Show child attributes

Preview a post-label-purchase ship-to address change Apply an order-level adjustment (discount, fee, or coupon)