> ## 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. # Pull live LTL rates from Shippo > Calls the Shippo Freight Rates API for this order using the entity's configured Shippo connector credentials, and persists each returned rate as a pending `freight_quotes` row. The order must already be flagged as freight (returns 400 `order_not_freight`), have a valid shipping address (returns 400 `Shipping address required`), and carry at least one freight package (returns 400 `freight_packages_required`). If the entity's Shippo account does not have the freight add-on, the endpoint returns 200 with `data.source = 'unsupported'` and a `reason` plus `shippo_status` describing the upstream Shippo error (graceful degradation: the operator can still enter quotes manually). Network failures against Shippo also return 200 with `data.source = 'unsupported'`. Successful rate-shopping returns `data.source = 'shippo'` and a `quotes` array. Requires the `orders:write` scope. ## OpenAPI ````yaml /openapi.yaml post /freight_orders/{id}/quotes/shippo 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}/quotes/shippo: parameters: - name: id in: path required: true schema: type: string format: uuid post: tags: - Freight summary: Pull live LTL rates from Shippo description: > Calls the Shippo Freight Rates API for this order using the entity's configured Shippo connector credentials, and persists each returned rate as a pending `freight_quotes` row. The order must already be flagged as freight (returns 400 `order_not_freight`), have a valid shipping address (returns 400 `Shipping address required`), and carry at least one freight package (returns 400 `freight_packages_required`). If the entity's Shippo account does not have the freight add-on, the endpoint returns 200 with `data.source = 'unsupported'` and a `reason` plus `shippo_status` describing the upstream Shippo error (graceful degradation: the operator can still enter quotes manually). Network failures against Shippo also return 200 with `data.source = 'unsupported'`. Successful rate-shopping returns `data.source = 'shippo'` and a `quotes` array. Requires the `orders:write` scope. operationId: getShippoFreightQuotesV1 requestBody: required: false content: application/json: schema: type: object description: >- Empty body accepted; rate parameters are derived from the order + its packages. responses: '200': description: Shippo rate response (success or graceful unsupported) content: application/json: schema: type: object properties: data: type: object properties: quotes: type: array items: $ref: '#/components/schemas/FreightQuote' source: type: string enum: - shippo - unsupported message: type: string nullable: true reason: type: string nullable: true description: >- Present when source = 'unsupported'; the upstream Shippo failure message. shippo_status: type: integer nullable: true description: >- Present when source = 'unsupported'; the upstream Shippo HTTP status. error: type: string nullable: true description: >- Present only on network-level failure (e.g. 'network_error'). examples: success: summary: Shippo returned 6 LTL rates value: data: source: shippo quotes: - id: 11111111-1111-1111-1111-111111111111 carrier_name: ODFL carrier_service: LTL amount: 612.4 currency: USD transit_days: 3 shippoUnsupported: summary: Entity lacks Shippo freight add-on value: data: quotes: [] source: unsupported message: >- Shippo freight rate-shopping is not available for this account. Enter freight quotes manually. reason: Freight rating is disabled on this Shippo plan. shippo_status: 402 networkFailure: summary: Network call to Shippo failed value: data: quotes: [] source: unsupported message: >- Shippo freight rate request failed. Enter freight quotes manually. error: network_error '400': description: >- shippo_not_configured, freight_packages_required, ship_from_required, missing shipping address, or order_not_freight 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: 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__ Test keys use ark_test_ent__. Both are issued per entity via Settings > Developers > API Keys. ````