• Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Contact Support
    • Modaltrans API
      • Get Auth Token
        • Get Bearer Token
      • Accounting
        • Invoices
          • Retrieve an Invoice
          • List all Invoices
      • Customs
        • NCTS Declarations
          • List all NCTS Declarations
          • Retrieve an NCTS Declaration
          • Create an NCTS Declaration with XML Data
          • Create an Ens Declaration from JSON
          • 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
      • 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
        • Tracking
          • Available Shipping Lines
          • Retrieve a Tracking Data
          • Subscribe to Tracking
        • Shipments
          • Retrieve a Shipment
          • List All Shipments
          • Retrieve Financials of Shipment
          • List Contacts of the Shipment
          • Create a Shipment
          • Update a Shipment
      • 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
      • 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

    Introduction

    Modaltrans API Overview#

    The Modaltrans API provides a complete set of products, tools, and resources designed to simplify the management of various business modules. Whether you're managing logistics, customs, invoicing, or customer relationships, our API offers the functionality to integrate and automate these processes effortlessly.

    Accounting
    Invoices
    Handle your financial operations by managing sales and purchase invoices through our API.
    Customs
    Logistics
    Depot
    Fleet Management
    CRM
    Timelines
    S3Files
    Notifications
    Users

    Explore our API documentation to discover even more capabilities designed to enhance your business operations.

    API Base URL and RESTful Conventions#

    All API requests should be directed to the following base URL:
    https://app.modaltrans.com
    For testing purposes, use the following test URL:
    https://demo.modaltrans.com
    The Modaltrans API follows RESTful conventions when possible, with most operations performed via GET, POST, PATCH, and DELETE requests on page and database resources:
    GET: Retrieve data from the server, whether it's a list of records or a specific resource.
    POST: Create new resources or submit data to the server.
    PATCH: Update existing resources with new data, allowing partial modifications.
    DELETE: Remove resources from the server.
    These methods correspond to actions on both page and database resources, ensuring that your API interactions are predictable and follow best practices. All requests and responses are formatted in JSON, making it easy to parse and utilize the data in your applications.
    INFO
    You need a Bearer Token to interact with the Modaltrans API. If this is your first look at the Modaltrans API, we recommend beginning with the Getting Started to learn how to create a Bearer Token.

    Code Samples#

    Each endpoint in the Modaltrans API is accompanied by sample requests and responses. These examples are designed to be practical, allowing you to quickly understand how to interact with the API. The code samples are ready to copy, paste, and modify.
    Whether you're retrieving data, creating new resources, or updating existing ones, these examples offer a clear and straightforward foundation. You can easily adjust them to fit your specific requirements, streamlining your development process.

    UpdateReqExample1.png

    Request Samples#

    There are also example requests provided in multiple programming languages, making it easy to get started. You can simply copy and paste the sample code for languages like Python, Ruby, JavaScript, and more, and then modify it to suit your specific needs. These examples cover common use cases, including handling authentication, sending data, and receiving responses, ensuring that you can quickly adapt them into your application with minimal effort.

    UpdateReqExample2.png

    Modified at 2025-04-25 11:37:46
    Next
    Getting Started
    Built with