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

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.

Path Parameters

​
id
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.

Response

Preview returned successfully.

​
data
object