> ## 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 shipping rule > Creates a new shipping rule for the entity. Supports migration provenance: when `external_source` is supplied, the calling api-key id is auto-stamped as `imported_via_api_key_id` and a partial UNIQUE index enforces idempotent re-runs (re-POST returns 409). Requires the `settings:write` scope. Idempotent via Idempotency-Key. ## OpenAPI ````yaml /openapi.yaml post /shipping-rules 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: /shipping-rules: post: tags: - Masters summary: Create a shipping rule description: | Creates a new shipping rule for the entity. Supports migration provenance: when `external_source` is supplied, the calling api-key id is auto-stamped as `imported_via_api_key_id` and a partial UNIQUE index enforces idempotent re-runs (re-POST returns 409). Requires the `settings:write` scope. Idempotent via Idempotency-Key. operationId: createShippingRuleV1 parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object required: - name properties: name: type: string priority: type: integer default: 10 description: Lower runs first. is_active: type: boolean default: true location_id: type: string format: uuid nullable: true description: Layer 4 per-location scope. NULL = entity-wide. sales_channel_id: type: string format: uuid nullable: true description: Source-channel condition. NULL = applies to all channels. product_category_id: type: string format: uuid nullable: true description: >- Category condition. When set, the rule wins over a non-category rule even at higher priority (TUF-TITE pattern). min_weight: type: number default: 0 description: Inclusive weight band lower bound (lb). max_weight: type: number default: 999999 description: Inclusive weight band upper bound (lb). item_count_min: type: integer nullable: true description: Inclusive item-count band lower bound. NULL = no filter. item_count_max: type: integer nullable: true description: Inclusive item-count band upper bound. NULL = no filter. shipping_tokens: type: array items: type: string description: >- Allowed Shippo carrier service tokens. First = primary suggestion when preferred_service_token is unset. preferred_service_token: type: string nullable: true description: >- Primary suggested Shippo service token (e.g. usps_ground_advantage). preferred_carrier: type: string nullable: true description: Primary suggested carrier (USPS/UPS/FedEx/DHL Express). free_shipping_threshold: type: number nullable: true flat_rate: type: number nullable: true auto_buy: type: boolean default: false description: >- When true and the rule resolves to one unambiguous service, Pack-with-Arcus auto-purchases the label. absorb_cost: type: boolean nullable: true description: >- Per-rule cost-absorption override. NULL = use entity default; true = absorb (Freight Out GL); false = charge customer. outcome: type: string nullable: true description: >- Freight-rule outcome (force_freight/force_parcel/etc). Presence marks a freight rule rather than a carrier-routing rule. condition: type: object nullable: true description: Freight-rule condition JSONB (validated). actions: type: object description: Freight-rule actions (block_message / accessorials). external_source: type: string nullable: true description: Migration provenance tag. external_id: type: string nullable: true responses: '201': description: Shipping rule created content: application/json: schema: type: object '400': $ref: '#/components/responses/Error' '409': $ref: '#/components/responses/Error' security: - ApiKeyAuth: - settings: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 responses: Error: description: Error response (400/401/403/404/409/422/429/500) content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' schemas: 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 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. ````