Skip to main content

List all shipments

GET 
/company/delivery/

Retrieves a paginated list of all company shipments. Allows filtering by dates, statuses, and performing searches. Requires JWT authentication.

Use Cases:

  • View the complete shipment history
  • Filter shipments by status or dates for analysis
  • Search for specific shipments by code or reference

Example of a successful response:

{
  docs: [
    {
      service_code: DEL-12345,
      status: completed,
      etl_address: { /* loading address */ },
      etd_address: { /* unloading address */ },
      etl_date: 2025-08-01T08:00:00Z,
      etd_date: 2025-08-02T12:00:00Z,
      date_eta: 2025-08-02T11:30:00Z,
      cargo_type: Electronics,
      cargo_weight: 500,
      pallets_num: 10
    }
  ],
  totalDocs: 100,
  limit: 20,
  page: 1,
  totalPages: 5
}

Request​

Responses​

Shipment list paginated successfully.