> ## 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. # List freight orders (orders shipping via LTL/freight) > Returns orders where `delivery_option = 'freight'` OR `ships_freight = true`, with a flattened summary of the currently-accepted freight quote (carrier, service, amount, currency, transit days, accepted_at) joined via a LATERAL subquery. Cursor pagination is stable on `(created_at DESC, id DESC)` and the opaque cursor is a base64-encoded `{ created_at, id }`. Filters are AND-combined. Layer 1 entity isolation is enforced server-side from the API key; never trust a body-supplied `entity_id`. Requires the `orders:read` scope. ## OpenAPI ````yaml /openapi.yaml get /freight_orders 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__` (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: get: tags: - Freight summary: List freight orders (orders shipping via LTL/freight) description: > Returns orders where `delivery_option = 'freight'` OR `ships_freight = true`, with a flattened summary of the currently-accepted freight quote (carrier, service, amount, currency, transit days, accepted_at) joined via a LATERAL subquery. Cursor pagination is stable on `(created_at DESC, id DESC)` and the opaque cursor is a base64-encoded `{ created_at, id }`. Filters are AND-combined. Layer 1 entity isolation is enforced server-side from the API key; never trust a body-supplied `entity_id`. Requires the `orders:read` scope. operationId: listFreightOrdersV1 parameters: - name: status in: query required: false schema: type: string description: >- Filter by `orders.status` (draft / confirmed / fulfilled / invoiced / cancelled / archived). - name: location_id in: query required: false schema: type: string format: uuid description: Filter by `orders.location_id` (Layer 4). - name: from_date in: query required: false schema: type: string format: date description: Inclusive lower bound on `created_at`. - name: to_date in: query required: false schema: type: string format: date description: Exclusive upper bound (`created_at < to_date + 1 day`). - name: freight_class in: query required: false schema: type: string description: Filter by resolved NMFC freight class (50, 55, 60, ..., 500). - name: carrier_name in: query required: false schema: type: string description: >- Substring match (case-insensitive) on the accepted quote's carrier_name. - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 200 default: 50 - name: cursor in: query required: false schema: type: string description: Opaque cursor from previous page (`next_cursor`). responses: '200': description: Freight order list envelope content: application/json: schema: type: object properties: object: type: string example: list data: type: array items: $ref: '#/components/schemas/FreightOrder' has_more: type: boolean next_cursor: type: string nullable: true url: type: string example: /v1/freight_orders '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' security: - ApiKeyAuth: - orders:read components: schemas: FreightOrder: type: object description: > A read-only view over the `orders` table filtered to freight shipments (`delivery_option = 'freight'` OR `ships_freight = true`). Freight orders are NOT a separate table; this view exposes the canonical Order row plus a flattened summary of the currently-accepted freight quote (when one exists). Use POST /freight_orders/{id}/override_mode to flip an order between parcel and freight modes. Scope: orders:read / orders:write. properties: id: type: string format: uuid readOnly: true entity_id: type: string format: uuid readOnly: true document_type: type: string example: sales_order status: type: string example: confirmed delivery_option: type: string nullable: true example: freight ships_freight: type: boolean freight_class_effective: type: string nullable: true description: Resolved NMFC freight class (50 .. 500). freight_reason: type: string nullable: true description: Why this order is freight (auto-classified or operator override). location_id: type: string format: uuid nullable: true account_id: type: string format: uuid nullable: true ship_to_name: type: string nullable: true ship_to_address1: type: string nullable: true ship_to_city: type: string nullable: true ship_to_state: type: string nullable: true ship_to_zip: type: string nullable: true freight_quote_id: type: string format: uuid nullable: true readOnly: true description: Id of the currently-accepted freight quote, if any. freight_carrier_name: type: string nullable: true readOnly: true freight_carrier_service: type: string nullable: true readOnly: true freight_quote_amount: type: number format: float nullable: true readOnly: true freight_quote_currency: type: string nullable: true readOnly: true freight_transit_days: type: integer nullable: true readOnly: true freight_quote_accepted_at: type: string format: date-time nullable: true readOnly: 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__ Test keys use ark_test_ent__. Both are issued per entity via Settings > Developers > API Keys. ````