> ## Documentation Index > Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt > Use this file to discover all available pages before exploring further. # Get the shipping-rule schema > Describe the shipping-rule format — every condition (`when`) and effect (`then`), with its type, allowed options and meaning — plus the maximum number of rules. Useful for building an editor or for an AI agent authoring rules. Available to every account. When per-user permissions are enabled, the token's owner needs the `fulfillmentSettings.read` permission (the same as the Operations Admin pages); otherwise `403`. ## OpenAPI ````yaml /api-reference/build.yaml get /shipping-rules/schema openapi: 3.0.0 info: title: Luminous API version: 1.0.0 description: API documentation for Luminous servers: - url: https://{companyName}.api.joinluminous.com/external/api/v1 variables: companyName: default: companyName description: Your company-specific subdomain security: [] tags: - name: Products description: Get and manage products - name: Pricing description: Manage price schedules, levels, and customizations - name: BOMs description: Manage Bills of Materials (BOMs) - name: Labels description: Label rendering via Labelary ZPL service - name: Companies description: Manage business accounts and their associated data - name: Contacts description: Manage contact information for individuals - name: Suppliers description: Manage suppliers (factories) — vendors used on purchase orders - name: Supplier SKUs description: Manage per-supplier SKU and unit-cost overrides for products - name: Locations description: Manage warehouses and locations - name: Inventory description: Get and adjust product stock levels - name: Lots description: Create, update, and delete product lots (batches) - name: Transfer Orders description: Manage transfer orders - name: Fulfillment Orders description: Manage fulfillment orders and picklists - name: Freight description: >- Freightview LTL freight — quotes, booking and documents for fulfillment orders - name: Fulfillment Priority Lists description: Configure fulfillment routing priority lists - name: Purchase Orders description: Get and modify purchase orders - name: Supplier Portal description: >- Read a supplier's response to a purchase order and control the one-click portal link - name: Receiving Reports description: Manage receiving reports - name: Payment Obligations description: Manage payment obligations for purchase orders - name: Sales Orders description: Manage sales orders and sales order shipments - name: Purgatory description: >- Inspect and resolve non-posted sales orders in the purgatory staging workflow - name: PickFlow Warehouse description: >- Warehouse-floor lookups for PickFlow — barcode resolution, bin and product stock, bin search, and receivables - name: PickFlow Shipping description: >- Provider-agnostic shipping rates, services, packages, and label purchase for PickFlow - name: Cycle Counts description: >- Create, drive, and post PickFlow cycle counts — batches, per-warehouse sessions, and CSV import/export - name: Print Stations description: List paired print stations and enqueue print jobs to them - name: Invoices description: Get and manage invoices - name: Work Orders description: >- Manage work orders — production lifecycle, steps, materials, links, shipments, and comments - name: Production Batches description: Group and manage work orders as production batches - name: Bills description: >- Accounts payable bill management, payments, attachments, allocations, and variance - name: Prepayments description: Manage vendor prepayments and applications - name: Vendor Credits description: Manage vendor credits and applications - name: Vendor Returns description: Manage vendor returns and credit generation - name: Customer Returns description: Manage customer returns (sales returns), receiving, and restock behavior - name: Stock Snapshot description: Point-in-time stock snapshots with export support - name: Consumption description: Consumption reports and exports - name: Inventory Aging description: Cost-layer-based inventory aging reports - name: Bills Reports description: Accounts payable bills aging reports - name: Forecast description: Materialized forecast data - name: Reports description: Close the books, inventory discrepancy, transaction COGS, and EDI reports - name: Tags description: Add/remove tags across various resources - name: Custom Fields description: Get and set custom fields across various resources - name: Currency description: Currency configuration, exchange rates, and conversion - name: Drive description: > Browse, upload, tag and manage files in your Luminous Drive. An API token sees the shared drive only, never My Files or restricted folders and files. Every write and download made through the API is recorded in the file's activity log (`GET /file-cabinet/files/{id}/activity`) with `actor_kind: api_token`. - name: Integration Mappings description: Manage integration mappings for external systems - name: Integration Field Mappings description: Manage field-level mappings between Luminous and external systems - name: Automations description: Create, test, and inspect automation rules and their runs paths: /shipping-rules/schema: get: tags: - Shipping Rules summary: Get the shipping-rule schema description: > Describe the shipping-rule format — every condition (`when`) and effect (`then`), with its type, allowed options and meaning — plus the maximum number of rules. Useful for building an editor or for an AI agent authoring rules. Available to every account. When per-user permissions are enabled, the token's owner needs the `fulfillmentSettings.read` permission (the same as the Operations Admin pages); otherwise `403`. operationId: getShippingRulesSchema responses: '200': description: The rule format. content: application/json: schema: type: object properties: data: type: object properties: description: type: string description: How the ordered list is applied. maxRules: type: integer example: 100 rule: type: object description: > Field descriptors keyed by field name: `name`, and the `when` / `then` maps. Each descriptor has `type` (e.g. `string[]`, `boolean|null`, `integer|null`), `description`, and where applicable `options` (allowed values) or `required`. additionalProperties: true example: data: description: >- An ordered list of shipping rules. Every rule whose conditions all hold applies, top to bottom … maxRules: 100 rule: name: type: string required: true description: Unique, shown in label refusals and rate badges. when: packingClasses: type: string[] options: - ambient - perishable_dry_ice - flour - fragile - bulk - liquid description: >- Any line on the order has one of these packing classes. then: shipDays: type: string[] options: - Mon - Tue - Wed - Thu - Fri - Sat - Sun description: >- Labels may only be bought on these days (tenant operating timezone). '401': description: Authentication credentials were missing or invalid content: application/json: schema: type: object properties: error: type: string example: Unauthorized message: type: string example: Authentication credentials are missing or invalid status_code: type: integer example: 401 '403': description: >- The token's owner lacks the `fulfillmentSettings.read` permission (enforced when per-user permissions are enabled). content: application/json: schema: type: object properties: message: type: string example: User does not have the right permissions. security: - BearerAuth: [] components: securitySchemes: BearerAuth: type: http scheme: bearer description: >- Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.