> ## 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. # Inbound shipments > Get a paginated list of inbound shipments with optional filtering. Results are ordered by `updated_at` descending — use `updated_at[gt]` for incremental polling. For detailed information about the filtering system and available operators, refer to the [Filter System Documentation](/filters). ## Available Filters ### DateTime Filters - `created_at`: When the inbound shipment was created - `updated_at`: When the inbound shipment was last updated - `reconciled_at`: When the shipment was reconciled - `arrival_date`: Expected or actual arrival date - `external_expected_arrival_date`: Arrival date from the external system - `external_date_created`: Creation date from the external system - `external_date_updated`: Update date from the external system ### Integer Filters - `id`: Inbound shipment ID - `location_id`: Destination warehouse/location ID - `from_warehouse_id`: Origin warehouse ID - `purchase_order_id`: Linked purchase order ID - `purchase_order_shipment_id`: Linked PO shipment ID - `transfer_order_id`: Linked transfer order ID - `app_integration_account_id`: Integration account ID ### String Filters - `source`: Integration source (e.g. "flexe", "extensiv") - `external_shipment_id`: Shipment ID in the external system - `external_po_number`: PO number from the external system - `external_po_number_canonical`: Canonical PO number from the external system - `external_warehouse_id`: Warehouse ID in the external system - `external_warehouse_customer_id`: Customer ID in the external warehouse system - `external_supplier_name`: Supplier name from the external system - `external_status`: Normalized status (e.g. "open", "in-transit", "received") - `external_raw_status`: Raw status string from the external system ### Float Filters - `total_expected_quantity`: Total expected item quantity - `total_received_quantity`: Total received item quantity - `total_unit_cost`: Total unit cost ## Examples ``` # Poll for recently updated shipments ?updated_at[gt]=2025-01-01 00:00:00 # Filter by external status ?external_status[eq]=received # Filter by linked purchase order ?purchase_order_id[eq]=456 # Filter by source integration ?source[eq]=extensiv ``` ## OpenAPI ````yaml /api-reference/build.yaml get /inbound-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: Purchase Orders description: Get and modify purchase orders - 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 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: Integration Mappings description: Manage integration mappings for external systems - name: Integration Field Mappings description: Manage field-level mappings between Luminous and external systems paths: /inbound-shipments: get: tags: - Inbound Shipments summary: Inbound shipments description: > Get a paginated list of inbound shipments with optional filtering. Results are ordered by `updated_at` descending — use `updated_at[gt]` for incremental polling. For detailed information about the filtering system and available operators, refer to the [Filter System Documentation](/filters). ## Available Filters ### DateTime Filters - `created_at`: When the inbound shipment was created - `updated_at`: When the inbound shipment was last updated - `reconciled_at`: When the shipment was reconciled - `arrival_date`: Expected or actual arrival date - `external_expected_arrival_date`: Arrival date from the external system - `external_date_created`: Creation date from the external system - `external_date_updated`: Update date from the external system ### Integer Filters - `id`: Inbound shipment ID - `location_id`: Destination warehouse/location ID - `from_warehouse_id`: Origin warehouse ID - `purchase_order_id`: Linked purchase order ID - `purchase_order_shipment_id`: Linked PO shipment ID - `transfer_order_id`: Linked transfer order ID - `app_integration_account_id`: Integration account ID ### String Filters - `source`: Integration source (e.g. "flexe", "extensiv") - `external_shipment_id`: Shipment ID in the external system - `external_po_number`: PO number from the external system - `external_po_number_canonical`: Canonical PO number from the external system - `external_warehouse_id`: Warehouse ID in the external system - `external_warehouse_customer_id`: Customer ID in the external warehouse system - `external_supplier_name`: Supplier name from the external system - `external_status`: Normalized status (e.g. "open", "in-transit", "received") - `external_raw_status`: Raw status string from the external system ### Float Filters - `total_expected_quantity`: Total expected item quantity - `total_received_quantity`: Total received item quantity - `total_unit_cost`: Total unit cost ## Examples ``` # Poll for recently updated shipments ?updated_at[gt]=2025-01-01 00:00:00 # Filter by external status ?external_status[eq]=received # Filter by linked purchase order ?purchase_order_id[eq]=456 # Filter by source integration ?source[eq]=extensiv ``` operationId: getInboundShipments 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) - in: query name: updated_at schema: type: string format: date-time description: Filter by last update date (YYYY-MM-DD HH:mm:ss) - in: query name: created_at schema: type: string format: date-time description: Filter by creation date (YYYY-MM-DD HH:mm:ss) - in: query name: arrival_date schema: type: string format: date-time description: Filter by arrival date - in: query name: external_status schema: type: string description: Filter by normalized external status - in: query name: external_shipment_id schema: type: string description: Filter by external shipment ID - in: query name: purchase_order_id schema: type: integer description: Filter by linked purchase order ID - in: query name: source schema: type: string description: Filter by integration source - in: query name: location_id schema: type: integer description: Filter by destination location ID - in: query name: reconciled_at schema: type: string format: date-time description: Filter by when the shipment was reconciled (YYYY-MM-DD HH:mm:ss) - in: query name: external_expected_arrival_date schema: type: string format: date-time description: >- Filter by arrival date from the external system (YYYY-MM-DD HH:mm:ss) - in: query name: external_date_created schema: type: string format: date-time description: >- Filter by creation date from the external system (YYYY-MM-DD HH:mm:ss) - in: query name: external_date_updated schema: type: string format: date-time description: Filter by update date from the external system (YYYY-MM-DD HH:mm:ss) - in: query name: id schema: type: integer description: Filter by inbound shipment ID - in: query name: from_warehouse_id schema: type: integer description: Filter by origin warehouse ID - in: query name: purchase_order_shipment_id schema: type: integer description: Filter by linked PO shipment ID - in: query name: transfer_order_id schema: type: integer description: Filter by linked transfer order ID - in: query name: app_integration_account_id schema: type: integer description: Filter by integration account ID - in: query name: external_po_number schema: type: string description: Filter by PO number from the external system - in: query name: external_po_number_canonical schema: type: string description: Filter by canonical PO number from the external system - in: query name: external_warehouse_id schema: type: string description: Filter by warehouse ID in the external system - in: query name: external_warehouse_customer_id schema: type: string description: Filter by customer ID in the external warehouse system - in: query name: external_supplier_name schema: type: string description: Filter by supplier name from the external system - in: query name: external_raw_status schema: type: string description: Filter by raw status string from the external system - in: query name: total_expected_quantity schema: type: number description: Filter by total expected item quantity - in: query name: total_received_quantity schema: type: number description: Filter by total received item quantity - in: query name: total_unit_cost schema: type: number description: Filter by total unit cost responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: integer source: type: string nullable: true description: >- Integration source that created the shipment (e.g. "flexe", "extensiv") created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true reconciled_at: type: string format: date-time nullable: true description: >- When the inbound shipment was reconciled against received inventory arrival_date: type: string format: date-time nullable: true description: Expected or actual arrival date location_id: type: integer description: Destination warehouse/location ID from_warehouse_id: type: integer nullable: true description: Origin warehouse ID (for transfers) purchase_order_id: type: integer nullable: true description: Linked purchase order ID purchase_order_shipment_id: type: integer nullable: true description: Linked supplier PO shipment ID transfer_order_id: type: integer nullable: true description: Linked transfer order ID app_integration_account_id: type: integer nullable: true description: Integration account that sourced this shipment external_shipment_id: type: string nullable: true description: Shipment identifier in the external system external_warehouse_customer_id: type: string nullable: true external_po_number: type: string nullable: true external_po_number_canonical: type: string nullable: true external_status: type: string nullable: true description: >- Normalized status from the external system (e.g. "open", "in-transit", "received") external_raw_status: type: string nullable: true description: Raw status string as returned by the external system external_supplier_name: type: string nullable: true external_expected_arrival_date: type: string format: date-time nullable: true external_warehouse_id: type: string nullable: true external_tracking_numbers: type: array nullable: true items: {} external_date_created: type: string format: date-time nullable: true external_date_updated: type: string format: date-time nullable: true external_ship_from_address: type: object nullable: true properties: street1: type: string nullable: true street2: type: string nullable: true street3: type: string nullable: true city: type: string nullable: true state: type: string nullable: true postal_code: type: string nullable: true country: type: string nullable: true total_expected_quantity: type: number format: float total_received_quantity: type: number format: float total_unit_cost: type: number format: float external_notes: type: array nullable: true items: {} external_system_url: type: string nullable: true items: type: array description: Line items (present when the relation is loaded) items: type: object properties: id: type: integer external_item_id: type: string nullable: true external_id: type: string nullable: true external_sku: type: string nullable: true expected_quantity: type: number format: float received_quantity: type: number format: float unit_cost: type: number format: float purchase_order_shipment_item_id: type: integer nullable: true rfq_id: type: integer nullable: true description: Internal product (SKU) ID location: allOf: - type: object properties: id: type: integer status: type: string name: type: string parent_id: type: integer nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time nullable: true description: Destination location from_location: allOf: - type: object properties: id: type: integer status: type: string name: type: string parent_id: type: integer nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time nullable: true description: Origin location (for transfers) purchase_order: type: object nullable: true description: Linked purchase order summary additionalProperties: true properties: id: type: integer order_numbers: type: array items: type: string order_status: type: string nullable: true created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true transfer_order: type: object nullable: true description: Linked transfer order summary additionalProperties: true properties: id: type: integer number: type: string nullable: true status: type: string nullable: true purchase_order_shipment: allOf: - type: object properties: id: type: integer created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true reference_number: type: string description: Supplier reference number for this shipment total_shipping_cost: type: number format: float shipping_date: type: string format: date-time nullable: true warehouse_id: type: integer nullable: true description: Destination warehouse ID shipment_status_id: type: integer nullable: true notes: type: string nullable: true description: Free-text notes on the shipment tracking_number: type: string nullable: true description: Carrier tracking number shipped_by: type: string nullable: true enum: - Freight - Supplier description: Who is responsible for shipping shipment_type: type: string nullable: true enum: - Air - Sea - Road - Rail - Express description: Mode of transport for the shipment estimated_arrival: type: string format: date nullable: true description: Estimated arrival date is_closed: type: boolean description: >- Whether the shipment is marked as closed. This is a manual label only — it has no enforced behavior (closing does not gate edits, pushes, or receiving) and is provided for filtering and reporting. sync_status: type: string nullable: true description: >- Integration sync status (e.g. "synced", "unsynced") last_synced_at: type: string format: date-time nullable: true last_synced_status: description: >- Raw sync status payload from the integration (shape varies) nullable: true shipment_status: type: object nullable: true properties: id: type: integer name: type: string warehouse: allOf: - type: object properties: id: type: integer status: type: string name: type: string parent_id: type: integer nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time nullable: true shipment_items: type: array description: >- Line items (present when the relation is loaded) items: type: object properties: id: type: integer created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true supplier_purchase_order_shipment_id: type: integer supplier_purchase_order_id: type: integer supplier_purchase_order_item_id: type: integer quantity: type: number format: float unit_of_measure_id: type: integer cbm: type: number format: float nullable: true description: Cubic meters (volume) for this line carton_quantity: type: integer nullable: true description: Number of cartons for this line carton_dimensions: type: string nullable: true description: Carton dimensions for this line shipment_extra_costs: type: array description: >- Extra costs applied to the shipment (present when the relation is loaded) items: type: object properties: id: type: integer created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true supplier_purchase_order_shipment_id: type: integer name: type: string quantity: type: number format: float unit_price: type: number format: float line_total: type: number format: float cost_allocation_type: type: string nullable: true custom_fields: type: object nullable: true description: >- Custom field values for this shipment as a label => value map. Present only when the relation is loaded. additionalProperties: true nullable: true description: Linked supplier PO shipment 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. ````