> ## 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. # Preview a post-label-purchase ship-to address change > Read-only preview of the post-label Change-Ship-To wizard. Returns the current shipping address, the new address candidate (or the Triple-lock validator verdict for a raw payload), the list of active Shippo labels that would be voided, per-label refund eligibility hints, the carrier-specific in-transit gating flag, and the total estimated refund. No DB writes; no Shippo or Stripe calls. Use this to render the wizard's cost-impact confirmation step before the operator submits the destructive execute. Carrier-specific void deadlines (USPS 28 days pre-scan; UPS 90 days pre-pickup; FedEx same-day) are reflected in the `refundability_hint` field per label. Sister to `POST /v1/orders/{id}/change-ship-to`. Requires `orders:read` scope. 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 ship-to preview (admin only); NetSuite Reverse Fulfillment confirmation step. ## OpenAPI ````yaml /openapi.yaml post /orders/{id}/change-ship-to/preview openapi: 3.1.0 info: title: Arcus ERP Public API version: 1.0.0 description: > Arcus ERP public REST API. Designed for external integrations and data migration. **Authentication.** Bearer token (API key) via the `Authorization` header. Format: `Authorization: Bearer ark_live_ent__` (or `ark_test_*` for sandbox). API keys are issued per-entity in **Settings > Developers > API Keys**. **Entity scoping.** The entity is encoded in the API key prefix; routes are flat (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform endpoints (migration, reconciliation, events, webhook endpoints, API keys) use the `/v1/entities/{entity_id}/...` form -- those are noted in their tags. **Key capabilities.** - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource). - Cursor-based pagination (`starting_after` / `ending_before` / `limit`). - Idempotency via the `Idempotency-Key` header. - Webhook events for asynchronous notification. - Conditional requests / ETag for cache validation. servers: - url: https://api.arcuserp.com/v1 description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys) - url: https://dev-api.arcuserp.com/v1 description: >- Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev RDS) security: [] paths: /orders/{id}/change-ship-to/preview: parameters: - name: id in: path required: true schema: type: string format: uuid description: UUID of the order to preview a ship-to change for. post: tags: - Orders summary: Preview a post-label-purchase ship-to address change description: | Read-only preview of the post-label Change-Ship-To wizard. Returns the current shipping address, the new address candidate (or the Triple-lock validator verdict for a raw payload), the list of active Shippo labels that would be voided, per-label refund eligibility hints, the carrier-specific in-transit gating flag, and the total estimated refund. No DB writes; no Shippo or Stripe calls. Use this to render the wizard's cost-impact confirmation step before the operator submits the destructive execute. Carrier-specific void deadlines (USPS 28 days pre-scan; UPS 90 days pre-pickup; FedEx same-day) are reflected in the `refundability_hint` field per label. Sister to `POST /v1/orders/{id}/change-ship-to`. Requires `orders:read` scope. 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 ship-to preview (admin only); NetSuite Reverse Fulfillment confirmation step. operationId: previewChangeShipTo requestBody: required: true content: application/json: schema: type: object properties: new_address_id: type: string format: uuid description: >- Existing `account_addresses.id` to switch to (must belong to the order's account). new_address_payload: type: object description: >- Raw address payload to validate (preview-only; not persisted here). Provide either this OR new_address_id. properties: line1: type: string line2: type: string nullable: true city: type: string state: type: string zip: type: string country: type: string default: US name: type: string nullable: true is_commercial: type: boolean default: false example: new_address_id: aa11bb22-cc33-dd44-ee55-ff6677889900 responses: '200': description: Preview returned successfully. content: application/json: schema: type: object properties: data: type: object properties: order: type: object current_address: type: object nullable: true new_address: type: object nullable: true new_address_payload_validation: type: object nullable: true active_labels: type: array items: type: object void_refund_eligibility: type: array items: type: object in_transit_labels: type: array items: type: object total_estimated_refund: type: number repurchase_required: type: boolean intercept_required: type: boolean '400': $ref: '#/components/responses/Error' '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' '404': $ref: '#/components/responses/Error' '422': $ref: '#/components/responses/Error' security: - ApiKeyAuth: [] components: responses: Error: description: Error response (400/401/403/404/409/422/429/500) content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' schemas: ErrorEnvelope: type: object description: | Canonical error response envelope. All API errors use this shape. required: - error - code properties: error: type: string description: Machine-readable error key example: not_found code: type: string description: Machine-readable error code (often same as error) example: not_found type: type: string enum: - validation_error - permission_error - not_found - conflict - rate_limit - internal - expand_error - not_implemented example: not_found hint: type: string description: Human-readable one-sentence explanation (English) example: >- The requested order does not exist or does not belong to this entity. param: type: string description: The parameter that caused the error, if applicable example: expand[0] required: type: string description: The scope required (only on insufficient_scope errors) example: accounts:read request_id: type: string description: >- Unique request ID for support tracing (maps to CloudWatch log stream) example: req_abc123 securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | 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. ````