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

# Override the carrier and service for this package

> Changes the carrier and service level for a package. If a label has already been purchased,
the existing label is voided before the carrier is updated. A new label must be purchased
after changing the carrier.
Requires `fulfillment:write` scope.




## OpenAPI

````yaml /openapi.yaml post /packages/{id}/change-carrier
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.
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:
  /packages/{id}/change-carrier:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    post:
      tags:
        - Fulfillment
      summary: Override the carrier and service for this package
      description: >
        Changes the carrier and service level for a package. If a label has
        already been purchased,

        the existing label is voided before the carrier is updated. A new label
        must be purchased

        after changing the carrier.

        Requires `fulfillment:write` scope.
      operationId: changePackageCarrier
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                carrier:
                  type: string
                service_token:
                  type: string
                service_name:
                  type: string
                rate_object_id:
                  type: string
      responses:
        '200':
          description: Package with updated carrier and service
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $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
  schemas:
    Package:
      type: object
      description: |
        A shipment / box created during fulfillment. One package contains many
        package items (line item splits) and at most one shipment label.
      properties:
        id:
          type: string
          format: uuid
        object:
          type: string
          enum:
            - package
        entity_id:
          type: string
          format: uuid
          readOnly: true
        order_id:
          type: string
          format: uuid
        package_number:
          type: string
          readOnly: true
          description: Sequential per entity.
        status:
          type: string
          enum:
            - packing
            - packed
            - labeled
            - shipped
            - delivered
            - returned
            - void
          readOnly: true
        weight_lb:
          type: number
          nullable: true
        length_in:
          type: number
          nullable: true
        width_in:
          type: number
          nullable: true
        height_in:
          type: number
          nullable: true
        carrier:
          type: string
          nullable: true
          description: e.g. ups, usps, fedex, dhl.
        service_level:
          type: string
          nullable: true
          description: e.g. ground, priority, 2day.
        tracking_number:
          type: string
          nullable: true
        tracking_url:
          type: string
          nullable: true
        ship_cost:
          type: number
          nullable: true
        billed_ship_cost:
          type: number
          nullable: true
          description: Cost billed to customer (vs purchased cost).
        location_id:
          type: string
          format: uuid
          nullable: true
        insurance_amount_override:
          type: number
          nullable: true
          description: >
            Manual override of the auto-computed Shippo-insurance declared
            value. When set, overrides the value derived from products flagged
            apply_freight_insurance.
        insurance:
          type: object
          nullable: true
          readOnly: true
          description: >
            Auto-insurance summary. `null` when no package item opts in and
            there is no override / entity threshold. `bought: true` after a
            label has been purchased (amount = the value actually insured at
            Shippo); `bought: false` projects what the next label purchase will
            insure.
          properties:
            active:
              type: boolean
            bought:
              type: boolean
            amount:
              type: number
              description: Insured declared value (USD).
            currency:
              type: string
            fee_estimate:
              type: number
              description: ~1.5% of declared value; the exact fee is in the rate.
            provider:
              type: string
              nullable: true
              description: UPS | USPS | FEDEX | DHL once the carrier is chosen.
            covered_items:
              type: array
              items:
                type: string
            covered_item_count:
              type: integer
            source:
              type: string
              enum:
                - product_toggle
                - entity_threshold
                - manual_override
        shipped_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        delivered_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        metadata:
          type: object
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    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
  responses:
    Error:
      description: Error response (400/401/403/404/409/422/429/500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  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.

````