Skip to main content
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."
}
'
{
  "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>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
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