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

# Adjust a package's shipping cost

> Settles the shipping cost difference after a package's label is re-rated to a different service level: `recharge` charges the customer's saved card and posts a revenue journal entry, `absorb` logs the cost with no accounting change, and `manual` flags it for offline handling. Idempotent per label: a repeat call returns the existing result, and a declined card still leaves the recorded delta in place with `charge_status: declined` in the response.



## OpenAPI

````yaml /openapi.yaml post /packages/{id}/recharge-label
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:
  /packages/{id}/recharge-label:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    post:
      tags:
        - Fulfillment
      summary: Adjust a package's shipping cost
      description: >-
        Settles the shipping cost difference after a package's label is re-rated
        to a different service level: `recharge` charges the customer's saved
        card and posts a revenue journal entry, `absorb` logs the cost with no
        accounting change, and `manual` flags it for offline handling.
        Idempotent per label: a repeat call returns the existing result, and a
        declined card still leaves the recorded delta in place with
        `charge_status: declined` in the response.
      operationId: rechargePackageLabel
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - action
              properties:
                action:
                  type: string
                  enum:
                    - recharge
                    - absorb
                    - manual
                  description: |
                    What to do with the cost delta. `recharge` bills the
                    customer (requires `payment_method_id` for in-API Stripe
                    charge). `absorb` logs but does not move money. `manual`
                    flags for offline handling.
                label_id:
                  type: string
                  format: uuid
                  description: |
                    Optional explicit label id. When omitted, the active
                    (non-voided) label on the package is used.
                payment_method_id:
                  type: string
                  description: |
                    Saved Stripe payment method to charge for the delta. Only
                    honored when `action='recharge'` and the carrier cost
                    exceeds what the customer was charged. Soft-fails on
                    decline.
                update_order_total:
                  type: boolean
                  default: true
                  description: |
                    When true (default) and `action='recharge'`, updates
                    `orders.shipping_total` to match the new carrier cost
                    and re-flows totals via `recalculateOrderTotals`.
                notes:
                  type: string
                  description: |
                    Optional human note recorded on the activity log entry
                    and (for the recharge branch) on the Stripe charge
                    description.
            example:
              action: recharge
              payment_method_id: pm_1AbcD2eF3G4HiJkL5mNoPqR6
              notes: Customer requested overnight upgrade for birthday delivery
      responses:
        '200':
          description: Delta processed
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      delta:
                        type: number
                        description: >-
                          Carrier cost minus customer-charged (positive =
                          upgrade, negative = overpay)
                      action:
                        type: string
                        enum:
                          - recharge
                          - absorb
                          - manual
                      shipping_total_updated:
                        type: boolean
                      gl_je_id:
                        type: string
                        format: uuid
                        nullable: true
                        description: id of the shipping_delta journal entry, when posted
                      charge_status:
                        type: string
                        enum:
                          - charged
                          - declined
                          - skipped
                          - no_payment_method
                      charge_payment_id:
                        type: string
                        format: uuid
                        nullable: true
                      order_id:
                        type: string
                        format: uuid
                      label_id:
                        type: string
                        format: uuid
                      idempotent:
                        type: boolean
                        description: true when a previous call already processed this label
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          description: No active label found on this package (purchase one first)
        '422':
          description: Cannot recharge against a voided label
      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.