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.
Available Filters
DateTime Filters
created_at: When the inbound shipment was createdupdated_at: When the inbound shipment was last updatedreconciled_at: When the shipment was reconciledarrival_date: Expected or actual arrival dateexternal_expected_arrival_date: Arrival date from the external systemexternal_date_created: Creation date from the external systemexternal_date_updated: Update date from the external system
Integer Filters
id: Inbound shipment IDlocation_id: Destination warehouse/location IDfrom_warehouse_id: Origin warehouse IDpurchase_order_id: Linked purchase order IDpurchase_order_shipment_id: Linked PO shipment IDtransfer_order_id: Linked transfer order IDapp_integration_account_id: Integration account ID
String Filters
source: Integration source (e.g. “flexe”, “extensiv”)external_shipment_id: Shipment ID in the external systemexternal_po_number: PO number from the external systemexternal_po_number_canonical: Canonical PO number from the external systemexternal_warehouse_id: Warehouse ID in the external systemexternal_warehouse_customer_id: Customer ID in the external warehouse systemexternal_supplier_name: Supplier name from the external systemexternal_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 quantitytotal_received_quantity: Total received item quantitytotal_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
Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Query Parameters
Page number for pagination
Number of items per page (max 100)
x <= 100Filter by last update date (YYYY-MM-DD HH:mm:ss)
Filter by creation date (YYYY-MM-DD HH:mm:ss)
Filter by arrival date
Filter by normalized external status
Filter by external shipment ID
Filter by linked purchase order ID
Filter by integration source
Filter by destination location ID
Filter by when the shipment was reconciled (YYYY-MM-DD HH:mm:ss)
Filter by arrival date from the external system (YYYY-MM-DD HH:mm:ss)
Filter by creation date from the external system (YYYY-MM-DD HH:mm:ss)
Filter by update date from the external system (YYYY-MM-DD HH:mm:ss)
Filter by inbound shipment ID
Filter by origin warehouse ID
Filter by linked PO shipment ID
Filter by linked transfer order ID
Filter by integration account ID
Filter by PO number from the external system
Filter by canonical PO number from the external system
Filter by warehouse ID in the external system
Filter by customer ID in the external warehouse system
Filter by supplier name from the external system
Filter by raw status string from the external system
Filter by total expected item quantity
Filter by total received item quantity
Filter by total unit cost