Skip to main content

List all shipments

GET 
/company/delivery/

Retrieves a paginated list of all company shipments with multiple filtering options.

Objective​

Allow companies to query and filter their complete shipping history for analysis, reporting, and operational management.

Use Cases​

  • View the company's complete shipping history
  • Filter shipments by dates (creation, auction, start, end, ETL, ETD) for periodic reports
  • Search for specific shipments by code, custom reference, or cargo type
  • Exclude canceled or claimed shipments from default lists
  • Analyze active vs. historical shipments

Filtering Logic​

flowchart TD
  A[Receive Request] --> B{Has minDate?}
  B -->|Yes| C[Filter date_start OR etl_date >= minDate]
  B -->|No| D{Has maxDate?}
  D -->|Yes| E[Filter date_end OR etd_date <= maxDate]
  C --> F{Has Status Filter?}
  E --> F
  F -->|Yes| G[Apply exact status match]
  F -->|No| H{Exclude Canceled?}
  H -->|show_canceled=false| I[Remove status=canceled]
  H -->|show_canceled=true| J{Exclude Claimed?}
  J -->|show_claimed=false| K[Remove status=claimed]
  J -->|show_claimed=true| L[Apply filters]
  I --> L
  K --> L
  G --> L
  L --> M[Return Paginated Results]

Request​

Responses​

Paginated shipment list successfully