> ## 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 a freight package (pallet, crate, custom)

> Inserts a `fulfillment.packages` row tagged with freight-specific fields
(NMFC class, NMFC code, pallet count, declared value, accessorials,
dimensions). The order must already be flagged as freight
(`assertOrderIsFreight` gate, returns 400 `order_not_freight`
otherwise). The canonical handler emits an `order.package_added` realtime
broadcast plus a `freight.package_added` activity log entry. Idempotent on
`Idempotency-Key`. Requires the `orders:write` scope.
Note: is_hazmat and hazmat_details removed 2026-05-22 (HAZMAT-SCRUB).




## OpenAPI

````yaml /openapi.yaml post /freight_orders/{id}/packages
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}/packages:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    post:
      tags:
        - Freight
      summary: Create a freight package (pallet, crate, custom)
      description: >
        Inserts a `fulfillment.packages` row tagged with freight-specific fields

        (NMFC class, NMFC code, pallet count, declared value, accessorials,

        dimensions). The order must already be flagged as freight

        (`assertOrderIsFreight` gate, returns 400 `order_not_freight`

        otherwise). The canonical handler emits an `order.package_added`
        realtime

        broadcast plus a `freight.package_added` activity log entry. Idempotent
        on

        `Idempotency-Key`. Requires the `orders:write` scope.

        Note: is_hazmat and hazmat_details removed 2026-05-22 (HAZMAT-SCRUB).
      operationId: createFreightPackageV1
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                package_type:
                  type: string
                  enum:
                    - pallet
                    - crate
                    - custom
                  default: pallet
                freight_class:
                  type: string
                  description: >-
                    NMFC freight class (50, 55, 60, 65, 70, 77.5, 85, 92.5, 100,
                    110, 125, 150, 175, 200, 250, 300, 400, 500).
                  example: '100'
                nmfc_code:
                  type: string
                  nullable: true
                declared_value:
                  type: number
                  format: float
                  minimum: 0
                pallet_count:
                  type: integer
                  minimum: 1
                  example: 2
                total_weight_lbs:
                  type: number
                  format: float
                  minimum: 0
                  example: 1200
                dimensions_json:
                  type: object
                  description: >-
                    Free-form pallet dimensions object (e.g. { length: 48,
                    width: 40, height: 60 } in inches).
                accessorials:
                  type: array
                  items:
                    type: string
                  description: >-
                    Accessorial codes (LIFTGATE_DEL, INSIDE_DEL, RESIDENTIAL,
                    NOTIFY, etc.).
                carrier:
                  type: string
                  nullable: true
                service:
                  type: string
                  nullable: true
                items:
                  type: array
                  description: >-
                    Optional package_items rows to insert atomically with the
                    package.
                  items:
                    type: object
                    properties:
                      order_item_id:
                        type: string
                        format: uuid
                      quantity:
                        type: number
                        format: float
                        minimum: 0
              example:
                package_type: pallet
                freight_class: '100'
                pallet_count: 2
                total_weight_lbs: 1200
                declared_value: 5400
                accessorials:
                  - LIFTGATE_DEL
      responses:
        '201':
          description: Freight package created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      order_id:
                        type: string
                        format: uuid
                      package_type:
                        type: string
                      freight_class:
                        type: string
                        nullable: true
                      pallet_count:
                        type: integer
                        nullable: true
                      total_weight_lbs:
                        type: number
                        format: float
                        nullable: true
        '400':
          description: >-
            order_not_freight, failed_to_create_freight_package, 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:
    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.

````