> ## 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. # Retrieve a freight order with its quotes > Returns one freight order by id (entity-scoped from the API key) plus its complete `freight_quotes` collection (all rows, accepted-first then newest- first). Returns 404 if the order does not belong to the API key's entity OR the id is not a recognized order id. Requires the `orders:read` scope. ## OpenAPI ````yaml /openapi.yaml get /freight_orders/{id} 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/{id}: parameters: - name: id in: path required: true schema: type: string format: uuid get: tags: - Freight summary: Retrieve a freight order with its quotes description: > Returns one freight order by id (entity-scoped from the API key) plus its complete `freight_quotes` collection (all rows, accepted-first then newest- first). Returns 404 if the order does not belong to the API key's entity OR the id is not a recognized order id. Requires the `orders:read` scope. operationId: getFreightOrderV1 responses: '200': description: Freight order with quotes content: application/json: schema: type: object properties: data: allOf: - $ref: '#/components/schemas/Order' - type: object properties: freight_quotes: type: array items: $ref: '#/components/schemas/FreightQuote' '400': description: invalid_id_format (id is not a UUID) content: application/json: schema: $ref: '#/components/schemas/Error' '404': $ref: '#/components/responses/Error' security: - ApiKeyAuth: - orders:read components: schemas: Order: type: object description: > An Arcus ERP order document. One table holds quotes, sales_orders, invoices, returns, and purchase_orders -- always filter by document_type. entity_id is always from the API key (Layer 1 isolation). properties: id: type: string format: uuid object: type: string enum: - order entity_id: type: string format: uuid readOnly: true order_number: type: string readOnly: true document_type: type: string enum: - quote - sales_order - invoice - return - purchase_order order_status: type: string enum: - draft - confirmed - partially_fulfilled - fulfilled - cancelled - voided - awaiting_ach_clearance - on_hold payment_status: type: string enum: - unpaid - partially_paid - paid - overpaid - refunded - partially_refunded - voided fulfillment_status: type: string enum: - unfulfilled - partially_fulfilled - fulfilled account_id: type: string format: uuid nullable: true location_id: type: string format: uuid nullable: true po_number: type: string nullable: true order_date: type: string format: date-time nullable: true due_date: type: string format: date-time nullable: true subtotal: type: number discount_total: type: number shipping_total: type: number tax_total: type: number fee_total: type: number order_total: type: number list_price_total: type: number readOnly: true description: >- Derived (display-only): SUM(list_price * qty) over non-kit lines. The gross baseline of the gross-to-net bridge (List price minus pricing_savings equals subtotal). Never part of order_total. pricing_savings: type: number readOnly: true description: >- Derived (display-only): SUM(pricing_rule_adjustment * qty) over non-kit lines (positive magnitude). Per-unit pricing-rule savings already baked into subtotal via sell_rate (ASC 606 transaction price); shown as an informational List-to-Subtotal bridge, never subtracted from order_total. amount_paid: type: number readOnly: true description: 'SSOT: utils/ar-helpers.mjs::updateARBalance. Do not write directly.' balance_due: type: number readOnly: true tax_exempt: type: boolean delivery_option: type: string enum: - ship - pick_up - local_delivery notes: type: string nullable: true internal_notes: type: string nullable: true invoice_number: type: string nullable: true readOnly: true invoice_type: type: string enum: - order - manual - proforma - correction nullable: true is_on_hold: type: boolean readOnly: true hold_type: type: string nullable: true readOnly: true ship_complete: type: boolean source_platform: type: string nullable: true external_order_id: type: string nullable: true external_order_number: type: string nullable: true metadata: type: object nullable: true created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true 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__ Test keys use ark_test_ent__. Both are issued per entity via Settings > Developers > API Keys. ````