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:

1. Asserts orders.override_post_label_edit (server-side; equivalent to the public-API destructive scope combination below).
2. 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).
3. 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).
4. Atomically updates orders.shipping_address_id (and optionally billing_address_id if also_change_billing=true).
5. Calls recalculateTaxForOrder against the new destination (AvaTax re-finalization).
6. 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).
7. For every new label, calls the canonical createShippingDeltaCharge helper to bill/refund the customer for the rate delta vs original (idempotent on label_id).
8. 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

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."
}
'

200

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

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

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

200

application/json

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

data · object

Show child attributes