• 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
          • 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
          • 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

    Error Handling

    Modaltrans uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

    Codes in the 2xx range indicate success.
    4xx errors indicate client-side issues where the request made by the client is incorrect or cannot be fulfilled by the server. These errors suggest that the problem lies with the client’s request, such as incorrect syntax, invalid authentication, or lack of necessary permissions.
    Codes in the 5xx range indicate an error with Modaltrans’ servers.

    Error Responses
    In the event of an error during any process, the system will provide an error response in JSON format. This response includes a JSON object that outlines the errors encountered. Below is an example of the structure of such an error response:


    Error codes#

    This section provides an overview of common error codes you might encounter when using the API. For each error code listed, you'll find its probable cause and suggested solutions.

    400 - Bad Request
    403 - Forbidden
    404-Record Not Found
    422-Unprocessable Entity
    500 - Internal Server Error
    503-Service Unavailable
    Cause : The reason for a 400 response is typically due to malformed request syntax, invalid request message framing, or deceptive request routing.
    Solution :
    Ensure that the request syntax is correct according to the API specifications.
    Ensure that all fields in the request are of the correct data types as specified in the API documentation.

    If you need help or have any questions, please Contact our support team.

    Modified at 2024-09-09 13:27:45
    Previous
    Authentication
    Next
    Contact Support
    Built with