Skip to main content
POST
Preview a post-label-purchase ship-to address change

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