> ## 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. # List sales order shipments > Get a paginated list of sales order shipments across all sales orders. Use it to fetch recent shipments in a few paged calls instead of calling `GET /sales-orders/{salesOrderId}/shipments` once per order. Results are ordered by `ship_date` descending, then by `id` descending. **Default window:** if you don't send a `ship_date` filter, only shipments with a ship date in the **last 48 hours** (UTC) are returned. To read further back, pass an explicit `ship_date` filter (e.g. `ship_date[gte]=2026-01-01 00:00:00`). For detailed information about the filtering system and available operators, refer to the [Filter System Documentation](/filters). ## Available Filters ### DateTime Filters - `ship_date`: Date the shipment shipped (UTC). Overrides the 48-hour default window - `created_at`: When the shipment was created - `updated_at`: When the shipment was last updated - `delivered_at`: Carrier delivery timestamp (see `delivered_at` on the shipment). A shipment with no label-tracking record does not match a positive `delivered_at` filter ### Integer Filters - `id`: Shipment ID - `sales_order_id`: Parent sales order ID - `channel_id`: Sales channel of the parent sales order (supports `eq`, `ne`, `in`, `nin`, etc.) ### String Filters - `tracking_number`: Carrier tracking number ## Examples ``` # Shipments from the last 48 hours (default window) GET /sales-order-shipments # Shipments on or after a date for one channel ?ship_date[gte]=2026-10-01 00:00:00&channel_id[eq]=12 # Look up a shipment by tracking number ?tracking_number[eq]=1Z999AA10123456784 ``` ## OpenAPI ````yaml /api-reference/build.yaml get /sales-order-shipments 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: /sales-order-shipments: get: tags: - Sales Orders summary: List sales order shipments description: > Get a paginated list of sales order shipments across all sales orders. Use it to fetch recent shipments in a few paged calls instead of calling `GET /sales-orders/{salesOrderId}/shipments` once per order. Results are ordered by `ship_date` descending, then by `id` descending. **Default window:** if you don't send a `ship_date` filter, only shipments with a ship date in the **last 48 hours** (UTC) are returned. To read further back, pass an explicit `ship_date` filter (e.g. `ship_date[gte]=2026-01-01 00:00:00`). For detailed information about the filtering system and available operators, refer to the [Filter System Documentation](/filters). ## Available Filters ### DateTime Filters - `ship_date`: Date the shipment shipped (UTC). Overrides the 48-hour default window - `created_at`: When the shipment was created - `updated_at`: When the shipment was last updated - `delivered_at`: Carrier delivery timestamp (see `delivered_at` on the shipment). A shipment with no label-tracking record does not match a positive `delivered_at` filter ### Integer Filters - `id`: Shipment ID - `sales_order_id`: Parent sales order ID - `channel_id`: Sales channel of the parent sales order (supports `eq`, `ne`, `in`, `nin`, etc.) ### String Filters - `tracking_number`: Carrier tracking number ## Examples ``` # Shipments from the last 48 hours (default window) GET /sales-order-shipments # Shipments on or after a date for one channel ?ship_date[gte]=2026-10-01 00:00:00&channel_id[eq]=12 # Look up a shipment by tracking number ?tracking_number[eq]=1Z999AA10123456784 ``` operationId: getAllSalesOrderShipments parameters: - in: query name: page schema: type: integer default: 1 description: Page number for pagination - in: query name: per_page schema: type: integer default: 10 maximum: 100 description: Number of items per page (max 100) responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: integer description: Unique identifier for the shipment sales_order_id: type: integer description: ID of the associated sales order shipped_by_user: description: >- Luminous user who marked the parent sales order shipped, or `null` when not set. Who picked and packed is not stored on the shipment; see `picked_by_user` / `packed_by_user` on picklists. type: object nullable: true properties: id: type: integer name: type: string nullable: true ship_date: type: string format: date description: Date when the shipment was or will be sent tracking_number: type: string description: Tracking number for the shipment tracking_url: type: string nullable: true description: > Tracking URL for the shipment. This is the stored URL, or a carrier URL built from the tracking number when carrier tracking links are enabled for the tenant. delivery_status: type: string nullable: true enum: - pre_transit - in_transit - out_for_delivery - delivered - exception - null description: > Carrier delivery status from the Luminous label-tracking record that shares this shipment's tracking number (and fulfillment order, when the shipment is bound to one). `available_for_pickup` is reported as `out_for_delivery`; `failure`, `return_to_sender`, `error`, and `cancelled` are reported as `exception`. `null` when Luminous has no label-tracking record for the shipment (for example a tracking number imported from ShipStation) or the carrier status is unknown. delivered_at: type: string format: date-time nullable: true description: > Delivery timestamp from the same label-tracking record as `delivery_status`. `null` when there is no tracking record or the shipment has not been delivered. bol_number: type: string description: Bill of Lading Number for logistics tracking example: BOL-123456789 pro_number: type: string description: >- Progressive Rotating Order Number (common in LTL shipping) example: PRO-987654321 partner_reference_number: type: string description: >- General reference number from/for the shipping partner example: PARTNER-REF-001 is_return: type: boolean description: Whether this is a return shipment carrier_code: type: string description: Code identifying the carrier (e.g., ups, fedex) scac: type: string nullable: true description: >- Standard Carrier Alpha Code (SCAC) for the shipment's carrier; included on outbound EDI 856/810 documents service_code: type: string description: Code identifying the shipping service package_code: type: string description: Code identifying the package type shipment_cost: type: number format: float description: Cost of shipping insurance_cost: type: number format: float description: Cost of insurance warehouse_group_id: type: integer nullable: true description: >- ID of the warehouse group associated with this shipment (from the linked fulfillment order) status: type: integer description: Status of the shipment ship_to: type: object properties: name: type: string description: Recipient name company: type: string description: Company name street1: type: string description: Primary street address street2: type: string description: Secondary street address street3: type: string description: Additional street address city: type: string description: City state: type: string description: State/province postalCode: type: string description: Postal/ZIP code country: type: string description: Country phone: type: string description: Contact phone number residential: type: boolean description: Whether this is a residential address weight: type: object required: - value - units properties: value: type: number format: float description: Weight value units: type: string enum: - ounces - pounds - grams - kilograms description: Unit of weight measurement dimensions: type: object required: - units - length - width - height properties: units: type: string enum: - inches - centimeters description: Unit of dimensional measurement length: type: number format: float description: Length of the package width: type: number format: float description: Width of the package height: type: number format: float description: Height of the package items: type: array items: type: object properties: id: type: integer description: Unique identifier for the shipment item shipment_id: type: integer description: ID of the parent shipment product_id: type: integer description: ID of the product being shipped sales_order_item_id: type: integer description: >- Luminous sales order line-item ID (the internal item primary key) for the line being shipped. This is the value to pass back as `order_item_id` when creating a shipment for this order. For kit/bundle component lines that share a single upstream channel line, each component is still returned with its own distinct `sales_order_item_id`. quantity: type: number description: >- Quantity being shipped, expressed in the same unit of measure the associated sales order line was ordered in (the selling UoM, e.g. cartons) rather than internal base units. When the originating order line cannot be resolved, the stored quantity is returned as-is. weight: type: object required: - value - units properties: value: type: number format: float description: Weight value units: type: string enum: - ounces - pounds - grams - kilograms description: Unit of weight measurement unit_price: type: number format: float description: Price per unit lot_id: type: integer nullable: true description: >- ID of the lot this shipment item was deducted from (CS-10083). `null` when the line has no lot. Populated from the `lot_id` submitted on shipment create; Luminous no longer re-infers a lot by FEFO/FIFO once a lot is named. lot_number: type: string nullable: true description: >- Lot number stamped on the item, falling back to the referenced lot's number when only `lot_id` was submitted. `null` when the line has no lot. expiry_date: type: string format: date nullable: true description: >- Expiry date of the lot (`YYYY-MM-DD`), falling back to the referenced lot. `null` when the line has no lot. created_at: type: string format: date-time description: Timestamp when the item was created updated_at: type: string format: date-time description: Timestamp when the item was last updated description: Items included in this shipment created_at: type: string format: date-time description: Timestamp when the shipment was created updated_at: type: string format: date-time description: Timestamp when the shipment was last updated meta: type: object properties: current_page: type: integer description: The current page number example: 1 from: type: integer description: The starting index of the paginated results example: 1 last_page: type: integer description: The last page number example: 5 per_page: type: integer description: Number of items per page example: 10 to: type: integer description: The ending index of the paginated results example: 10 total: type: integer description: Total number of items across all pages example: 50 '401': description: Unauthorized content: application/json: schema: type: object properties: message: type: string 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.