> ## 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.

# Change an order's ship-to address

> Changes an order's shipping address after labels have already been purchased by voiding every active label, updating the address, recalculating tax for the new destination, and optionally repurchasing new labels and billing or refunding the rate difference. Requires both `orders:write` and `fulfillment:write` scopes, confirming the label void explicitly and, unless repurchase is deferred, confirming the repurchase as well; if any label cannot be voided, no changes are made and the response lists which labels did and did not void.



## OpenAPI

````yaml /openapi.yaml post /orders/{id}/change-ship-to
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_<code>_<random>` (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.

    **Changelog.** Entries are dated and name every published contract whose
    MEANING moved, not

    only the ones whose field names changed. The narrative version of the same
    entries, written

    for integrators, is published at https://arcuserp.mintlify.app/changelog.


    **2026-09-22 (planned 2026-09-21), REORDER-BUYER-TRUTH: demand changed what
    it MEANS on three

    published contracts, with no field renamed.** An integrator that pins field
    names sees no

    breakage and different numbers, which is why this entry exists.

      - **Demand now counts build consumption.** `demand_avg_per_day` on the public product, kit
        and inventory-balance objects, and `daily_demand` / `demand_basis` / `net_suggested_qty`
        on `GET /v1/purchasing/reorder-report`, are composed from fulfilled sales lines PLUS
        posted `build_consume` inventory draws: each physical decrement of a product counts
        exactly once. The previous rule adopted an internal-consumption basis only when the sales
        blend was exactly zero, so a product both sold AND consumed into work orders planned as
        if the build draws did not exist. Products drawn into work orders move; on one
        production-shaped dataset five did, the largest from 0.05/day to 14.95/day.
      - **`demand_basis` now carries four values, not two:** `sales`, `sales_and_builds`,
        `builds` and `consumption`. A consumer with a two-branch reader (anything that is not
        `consumption` is `sales`) silently hides the two new ones.
      - **`current_demand_units` on `GET /v1/inventory/balances/:id` moved, by a second rule.**
        It counts committed-but-unshipped CUSTOMER demand, and it now counts a kit component's
        own line rather than its parent kit line, and excludes non-sales documents. On one
        production dataset 269 of 1,043 balance rows changed, 227 of them downward; the largest
        single move was 1,941 to 25, on a product whose open PURCHASE order line had been
        reported as customer demand. Re-baseline anything that alerts or reorders off this field.
      - `run_rate_30/90/180/365` and `blended_daily` on the same balance object move for the
        first reason above.
      - **Added, not changed:** `GET /v1/purchasing/reorder-report` accepts `demand_window` and
        returns the unit, cover-through and reorder-point-provenance fields documented on that
        operation; `order_multiple` is accepted and returned on the product-vendor doors.
      - **Volume note.** The `inventory.low_stock`, `inventory.out_of_stock` and
        `inventory.back_in_stock` webhook events are population-gated on
        `on_hand <= reorder_point`, and reorder points move with the demand above, so
        subscribers should expect a one-time step change in event volume around the release.
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:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: UUID of the order to change ship-to for.
    post:
      tags:
        - Orders
      summary: Change an order's ship-to address
      description: >-
        Changes an order's shipping address after labels have already been
        purchased by voiding every active label, updating the address,
        recalculating tax for the new destination, and optionally repurchasing
        new labels and billing or refunding the rate difference. Requires both
        `orders:write` and `fulfillment:write` scopes, confirming the label void
        explicitly and, unless repurchase is deferred, confirming the repurchase
        as well; if any label cannot be voided, no changes are made and the
        response lists which labels did and did not void.
      operationId: changeOrderShipTo
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                new_address_id:
                  type: string
                  format: uuid
                  description: >-
                    Existing account_addresses.id (mutually exclusive with
                    new_address_payload).
                new_address_payload:
                  type: object
                  description: >-
                    Raw address payload; creates a new account_addresses row via
                    the canonical addAddress helper.
                  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
                    label:
                      type: string
                      nullable: true
                    is_commercial:
                      type: boolean
                      default: false
                also_change_billing:
                  type: boolean
                  default: false
                  description: Also copy the new address into billing_address_id.
                confirm_void_labels:
                  type: boolean
                  description: >-
                    REQUIRED. Two-key safety gate; must be true to authorize
                    label void.
                confirm_repurchase_labels:
                  type: boolean
                  description: REQUIRED unless repurchase_strategy=defer.
                repurchase_strategy:
                  type: string
                  enum:
                    - auto_cheapest
                    - manual
                    - defer
                  default: auto_cheapest
                  description: >-
                    auto_cheapest = auto-buy cheapest new label per package;
                    manual = return rates and let operator choose; defer = leave
                    packages unlabeled for the warehouse.
                payment_method_id:
                  type: string
                  format: uuid
                  nullable: true
                  description: Optional Stripe payment_method to bill the rate delta.
                user_id:
                  type: string
                  format: uuid
                  nullable: true
                  description: Audit attribution; defaults to API key owner if omitted.
                reason:
                  type: string
                  nullable: true
                  description: Operator note for the audit log.
              required:
                - confirm_void_labels
              example:
                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.
      responses:
        '200':
          description: >-
            Ship-to changed successfully (may include partial purchase_failures
            with HTTP 200 when at least one new label posted).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      order_id:
                        type: string
                        format: uuid
                      order_number:
                        type: string
                      old_shipping_address_id:
                        type: string
                        format: uuid
                        nullable: true
                      new_shipping_address_id:
                        type: string
                        format: uuid
                      new_shipping_address:
                        type: object
                      voided_labels:
                        type: array
                        items:
                          type: object
                      new_labels:
                        type: array
                        items:
                          type: object
                      rate_deltas:
                        type: array
                        items:
                          type: object
                      charge_results:
                        type: array
                        items:
                          type: object
                      purchase_failures:
                        type: array
                        items:
                          type: object
                      repurchase_strategy:
                        type: string
        '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:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: |
        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.
      schema:
        type: string
        maxLength: 255
  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_<code>_<random>
        Test keys use ark_test_ent_<code>_<random>. Both are issued per entity
        via Settings > Developers > API Keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.