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

# Create an inventory transfer

> Creates an inventory transfer in draft status between two locations, automatically classified as internal, intercompany, or, when explicitly set, an FBA-inbound shipment to Amazon. No journal entry posts until the transfer is submitted or shipped, and an intercompany transfer defaults to requiring approval unless `requires_approval` is set to false.



## OpenAPI

````yaml /openapi.yaml post /transfers
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:
  /transfers:
    post:
      tags:
        - Inventory
      summary: Create an inventory transfer
      description: >-
        Creates an inventory transfer in draft status between two locations,
        automatically classified as internal, intercompany, or, when explicitly
        set, an FBA-inbound shipment to Amazon. No journal entry posts until the
        transfer is submitted or shipped, and an intercompany transfer defaults
        to requiring approval unless `requires_approval` is set to false.
      operationId: createTransferV1
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - location_from_id
                - location_to_id
                - items
              properties:
                entity_to_id:
                  type: string
                  format: uuid
                  description: >-
                    Destination entity (defaults to API-key entity for internal
                    transfers; different entity creates an intercompany
                    transfer).
                location_from_id:
                  type: string
                  format: uuid
                  description: Source warehouse.
                location_to_id:
                  type: string
                  format: uuid
                  description: Destination warehouse.
                transfer_type:
                  type: string
                  enum:
                    - internal
                    - intercompany
                    - fba_inbound
                  description: >-
                    Explicit type override. Usually auto-detected from
                    entity_from/entity_to.
                requires_approval:
                  type: boolean
                  description: >-
                    Intercompany only. Defaults to true; set false to
                    auto-approve.
                notes:
                  type: string
                initiated_by:
                  type: string
                  format: uuid
                  description: User UUID who initiated the transfer.
                expected_ship_date:
                  type: string
                  format: date
                  nullable: true
                expected_receive_date:
                  type: string
                  format: date
                  nullable: true
                carrier:
                  type: string
                  nullable: true
                tracking_number:
                  type: string
                  nullable: true
                transfer_notes:
                  type: string
                  nullable: true
                items:
                  type: array
                  minItems: 1
                  items:
                    type: object
                    required:
                      - product_id
                      - quantity
                    properties:
                      product_id:
                        type: string
                        format: uuid
                      quantity:
                        type: number
                        minimum: 0.0001
                      unit_cost:
                        type: number
                        nullable: true
                      notes:
                        type: string
                        nullable: true
                      amazon_fnsku:
                        type: string
                        nullable: true
                        description: FBA inbound only.
                      amazon_msku:
                        type: string
                        nullable: true
                        description: FBA inbound only.
                      prep_instruction:
                        type: string
                        nullable: true
                        description: FBA inbound only.
            examples:
              internal_two_skus:
                summary: Internal warehouse-to-warehouse transfer (2 SKUs)
                value:
                  location_from_id: 91aa7588-4dc7-4edd-b172-7de91f5e1f78
                  location_to_id: 828cabe6-3fa2-4fb7-a2af-2280bbaba335
                  notes: Weekly replenishment to secondary warehouse
                  expected_ship_date: '2026-05-20'
                  items:
                    - product_id: 7f6f3e14-eaad-4c45-b922-209f6dc6d140
                      quantity: 5
                      notes: Circuit Breaker 10A White
                    - product_id: ec9288c3-12b1-474f-bb09-b0b15bb7a8ff
                      quantity: 3
                      notes: Square D Breaker Black
              intercompany_with_approval:
                summary: Intercompany transfer with approval workflow
                value:
                  entity_to_id: 00000000-1111-2222-3333-444444444444
                  location_from_id: 91aa7588-4dc7-4edd-b172-7de91f5e1f78
                  location_to_id: 11111111-2222-3333-4444-555555555555
                  requires_approval: true
                  notes: Q2 stock reallocation to sister entity
                  items:
                    - product_id: 7f6f3e14-eaad-4c45-b922-209f6dc6d140
                      quantity: 50
      responses:
        '201':
          description: Transfer created in draft status with hydrated items array
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      entity_from_id:
                        type: string
                        format: uuid
                      entity_to_id:
                        type: string
                        format: uuid
                      location_from_id:
                        type: string
                        format: uuid
                      location_to_id:
                        type: string
                        format: uuid
                      transfer_number:
                        type: string
                        example: SB-TRF-0000001
                      status:
                        type: string
                        example: draft
                      transfer_type:
                        type: string
                        example: internal
                      requires_approval:
                        type: boolean
                      gl_posted:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                            transfer_id:
                              type: string
                              format: uuid
                            product_id:
                              type: string
                              format: uuid
                            quantity_sent:
                              type: string
                            quantity_received:
                              type: string
                            notes:
                              type: string
                              nullable: true
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $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.