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

# Record a manually-booked freight quote

> Inserts a `freight_quotes` row for the order. This is the manual entry path
for quotes the operator received outside Shippo (phone calls, carrier
portals, brokers). The order must already be flagged as freight; the gate
returns 400 `order_not_freight` otherwise. Carrier and amount are required;
currency defaults to USD; quote_number, transit days, expires_at, and notes
are optional. The new row is created with `accepted_at = null` (operator
explicitly accepts a quote via POST /freight_quotes/{id}/accept). The
canonical helper `createFreightQuote` audits the insert. Idempotent on
`Idempotency-Key`. Requires the `orders:write` scope.




## OpenAPI

````yaml /openapi.yaml post /freight_orders/{id}/quotes
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:
  /freight_orders/{id}/quotes:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    post:
      tags:
        - Freight
      summary: Record a manually-booked freight quote
      description: >
        Inserts a `freight_quotes` row for the order. This is the manual entry
        path

        for quotes the operator received outside Shippo (phone calls, carrier

        portals, brokers). The order must already be flagged as freight; the
        gate

        returns 400 `order_not_freight` otherwise. Carrier and amount are
        required;

        currency defaults to USD; quote_number, transit days, expires_at, and
        notes

        are optional. The new row is created with `accepted_at = null` (operator

        explicitly accepts a quote via POST /freight_quotes/{id}/accept). The

        canonical helper `createFreightQuote` audits the insert. Idempotent on

        `Idempotency-Key`. Requires the `orders:write` scope.
      operationId: createFreightQuoteV1
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - carrier_name
                - amount
              properties:
                carrier_name:
                  type: string
                  maxLength: 100
                  example: Estes Express
                carrier_service:
                  type: string
                  maxLength: 60
                  nullable: true
                  example: Standard LTL
                quote_number:
                  type: string
                  maxLength: 80
                  nullable: true
                  example: EST-2026-77821
                transit_days:
                  type: integer
                  minimum: 0
                  nullable: true
                  example: 4
                amount:
                  type: number
                  format: float
                  minimum: 0
                  example: 642.5
                currency:
                  type: string
                  default: USD
                  example: USD
                expires_at:
                  type: string
                  format: date-time
                  nullable: true
                  example: '2026-05-25T17:00:00Z'
                notes:
                  type: string
                  nullable: true
                raw_response:
                  type: object
                  nullable: true
                  description: Optional raw carrier payload for the audit trail.
              example:
                carrier_name: Estes Express
                carrier_service: Standard LTL
                quote_number: EST-2026-77821
                transit_days: 4
                amount: 642.5
                currency: USD
                expires_at: '2026-05-25T17:00:00Z'
                notes: Phoned in 2026-05-18 by S. Allen.
      responses:
        '201':
          description: Freight quote created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FreightQuote'
        '400':
          description: order_not_freight, failed_to_create_quote, or validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
      security:
        - ApiKeyAuth:
            - orders:write
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:
    FreightQuote:
      type: object
      description: >
        A carrier rate-quote attached to a freight order. Created either
        manually (operator booked a carrier outside Shippo) via POST
        /freight_orders/{id}/quotes, or in bulk by pulling Shippo LTL rates via
        POST /freight_orders/{id}/quotes/shippo. Exactly one quote per order may
        carry a non-null `accepted_at`; accepting a quote rolls its `amount`
        into `orders.shipping_total`. Rule 23 SSOT: `amount` is written only by
        createFreightQuoteHandler and the Shippo rate-import; `accepted_at` is
        written only by acceptFreightQuoteHandler. Scope: orders:read /
        orders:write.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        entity_id:
          type: string
          format: uuid
          readOnly: true
        order_id:
          type: string
          format: uuid
        carrier_name:
          type: string
          description: Carrier label (Estes, ODFL, R+L, SAIA, etc.). 1..100 chars.
        carrier_service:
          type: string
          nullable: true
          description: Service level (Standard LTL, Guaranteed, Volume, etc.).
        quote_number:
          type: string
          nullable: true
          description: Carrier-issued quote/PRO reference, when available.
        transit_days:
          type: integer
          nullable: true
          description: Estimated transit in business days.
        amount:
          type: number
          format: float
          description: Quoted freight cost (USD by default; see currency).
        currency:
          type: string
          default: USD
          example: USD
        quoted_at:
          type: string
          format: date-time
          readOnly: true
        expires_at:
          type: string
          format: date-time
          nullable: true
          description: Carrier quote validity expiry.
        accepted_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
          description: Non-null on the one accepted quote per order.
        accepted_by_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
        notes:
          type: string
          nullable: true
        raw_response:
          type: object
          nullable: true
          description: >-
            Original carrier rate payload (Shippo response object when sourced
            from Shippo).
        created_by_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        metadata:
          type: object
          description: Free-form caller metadata. Default {}.
    Error:
      description: |
        Alias for ErrorEnvelope. Canonical error response shape used by all
        API endpoints. Refer to ErrorEnvelope for the full field definition.
      allOf:
        - $ref: '#/components/schemas/ErrorEnvelope'
    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.

````