1. Shipments
  • Introduction
  • Getting Started
  • Authentication
  • Error Handling
  • Contact Support
  • Modaltrans API
    • Get Auth Token
      • Get Bearer Token
    • Accounting
      • Invoices
        • Retrieve an Invoice
        • List all Invoices
      • Invoice Items
        • List all Invoice Items
        • Deleted Invoice Items
      • Financials
        • Retrieve Financial Information
    • Customs
      • NCTS Declarations
        • List all NCTS Declarations
        • Retrieve an NCTS Declaration
        • Create an NCTS Declaration with XML Data
        • Update an NCTS Declaration
        • Download an NCTS Declaration
        • List Timelines of NCTS Declaration
        • List Messages of NCTS Decalaration
      • Customs Declarations
        • List all Customs Declarations
        • Retrieve a Custom Declaration
        • Create a Customs Declaration
        • Update a Custom Declaration
        • Delete a Custom Declaration
        • Retrieve a Declaration History
        • Retrieve an MRN Status of Declaration
      • Declaration Requests
        • List all Declaration Orders
        • Retrieve a Declaration Request
        • Create a Declaration Request
        • Update a Declaration Request
        • Delete a Declaration Request
      • Ens Declarations
        • Create an Ens Declaration
        • Download an Ens Declaration
    • Logistics
      • Bookings
        • Retrieve a Booking
        • List all Bookings
        • Create a Booking
        • Update a Booking
      • Locations
        • List all Locations
        • Retrieve a Location
      • Positions
        • Update a Transport
        • Get All Positions
      • Tracking
        • Available Shipping Lines
        • Retrieve a Tracking Data
        • Subscribe to Tracking
      • Shipments
        • Retrieve a Shipment
          GET
        • List All Shipments
          GET
        • Retrieve Financials of Shipment
          GET
        • List Contacts of the Shipment
          GET
        • Create a Shipment
          POST
        • Update a Shipment
          PATCH
    • Depot
      • Orders
        • Retrieve an Order
        • List all Orders
        • Create an Order
        • Update an Order
      • Products
        • Retrieve a Product
        • List all Products
        • Create a Product
        • Update a Product
        • List Product Stocks
      • Inventories
        • List all Inventories
    • Fleet Management
      • Drivers
        • Retrieve a Driver
        • Retrieve a Driver's Vehicle
        • List Driver Positions
        • Update a Driver
      • Vehicles
        • Retrieve a Vehicle
        • Update a Vehicle
      • Gps Service Controller
        • Create Gps Responses
      • Service Logs
        • List all Service Logs
        • Retrieve a Service Log
        • Create a Service Log
        • Delete a Service Log
        • Update a Service Log
      • Periodic Documents
        • Retrieve a Periodic Document
        • Update a Periodic Document
        • Create a Periodic Document
    • CRM
      • Companies
        • List all Companies
        • Retrieve a Company
        • Create a Company
        • Update a Company
        • Delete a Company
        • List Company Credit Limits
    • Timelines
      • Retrieve a Timeline
      • List Timelines
      • Create a Timeline
    • S3 Files
      • List all S3Files
      • Create an S3File
      • Delete an S3File
    • Notifications
      • List all Notifications
      • Update a Notification Status
    • User Details
      • List User Details
      • Update User Details
  1. Shipments

List All Shipments

Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
GET
/api/v1/shipments
List all the Shipments

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.modaltrans.com/api/v1/shipments?page=1&updated_at=&per_page=50' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK
application/json
Body

Example
[
    {
        "transaction_id": 0,
        "uuid": "string",
        "reference": "string",
        "trans_mode": "string",
        "branch_id": 0,
        "company_uuid": "string",
        "company_name": "string",
        "customer_ref": "string",
        "agent_ref": "string",
        "consignee_name": "string",
        "consignee_email": "string",
        "sender_name": "string",
        "sender_email": "string",
        "load_place_id": 0,
        "load_city": "string",
        "load_zipcode": "string",
        "load_coun": "string",
        "load_place": "string",
        "load_date": "2019-08-24T14:15:22.123Z",
        "unload_place_id": 0,
        "unload_city": "string",
        "unload_zipcode": "string",
        "unload_coun": "string",
        "unload_place": "string",
        "unload_date": "string",
        "brut_wg": 0,
        "volume": 0,
        "ladameter": 0,
        "status": "string",
        "commodity": "string",
        "category": "string",
        "group_id": 0,
        "price_wg": 0,
        "teu": 0,
        "saler_name": "string",
        "saler_email": "string",
        "saler_office_tel": "string",
        "total_pack": 0,
        "carrier_name": "string",
        "waybill_no": "string",
        "truck_code": "string",
        "vessel_code": "string",
        "truck_type": "string",
        "export_import": "string",
        "free_time": "string",
        "notes": "string",
        "container_nos": [
            {
                "size": "string",
                "container_no": "string"
            }
        ],
        "timelines": [
            {
                "id": 0,
                "parent_type": "string",
                "parent_id": 0,
                "status_date": "2019-08-24T14:15:22.123Z",
                "status_code": "string",
                "place_id": 0,
                "city_id": 0,
                "country_id": "string",
                "notes": "string",
                "source": "string",
                "group_id": 0,
                "user_id": 0,
                "patron_id": 0,
                "customer_inform_type": true,
                "customer_inform_status": "string",
                "created_at": "2019-08-24T14:15:22.123Z",
                "updated_at": "2019-08-24T14:15:22.123Z",
                "lng": 0,
                "lat": 0,
                "place_name": "string",
                "notify_senders": true,
                "notify_consignees": true,
                "notify_companies": true,
                "tenant_id": 0,
                "icon_code": "string",
                "system_location": "string"
            }
        ]
    }
]
Modified at 2026-01-09 13:56:48
Previous
Retrieve a Shipment
Next
Retrieve Financials of Shipment
Built with