1. Orders
  • 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
          GET
        • List all Orders
          GET
        • Create an Order
          POST
        • Update an Order
          PATCH
      • 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. Orders

Create an Order

Developing
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
POST
/api/v1/orders
Creates an order.

Request

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

Example
{
  "order": {
    "input_output": "input",
    "warehouse_code": "TEST1212",
    "notes": "ApiTest",
    "extref": "AT121314",
    "entry_date": "2024-08-22",
    "sender_name": "Demo Uk",
    "consignee_name": "YUMCO COMMERCE DOO",
    "order_address": "123 Baker Street, Suite 456, London, Greater London, NW1 6XE, United Kingdom",
    "district": "Greater London",
    "city": "London",
    "orderlines_attributes": [
      {
        "line_no": "1",
        "serial_no": "TA121314",
        "weight": "200.0",
        "volume": "100.0",
        "productName": "TestApi",
        "barCode": "TestApi",
        "packCount": "10",
        "packType": "Box"
      }
    ]
  }
}

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 POST 'https://demo.modaltrans.com/api/v1/orders' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "order": {
    "input_output": "input",
    "warehouse_code": "TEST1212",
    "notes": "ApiTest",
    "extref": "AT121314",
    "entry_date": "2024-08-22",
    "sender_name": "Demo Uk",
    "consignee_name": "YUMCO COMMERCE DOO",
    "order_address": "123 Baker Street, Suite 456, London, Greater London, NW1 6XE, United Kingdom",
    "district": "Greater London",
    "city": "London",
    "orderlines_attributes": [
      {
        "line_no": "1",
        "serial_no": "TA121314",
        "weight": "200.0",
        "volume": "100.0",
        "productName": "TestApi",
        "barCode": "TestApi",
        "packCount": "10",
        "packType": "Box"
      }
    ]
  }
}'

Responses

🟢201Created
application/json
Body

Example
{
    "order_id": "string",
    "reference": "string",
    "assignee_email": "string",
    "operator_email": "string",
    "position_id": 0,
    "notes": "string",
    "ncts_declarations": [
        {
            "transaction_id": 0,
            "reference": "string",
            "trailer_code": "string",
            "vehicle_code": "string",
            "container": "string",
            "lrn": "string",
            "mrn": "string",
            "status": "string",
            "carrier_name": "string",
            "guarantee_price": 0,
            "guarantee_curr": "string",
            "manifesto_price": 0,
            "currency": "string",
            "holder_name": "string"
        }
    ]
}
🟠403Forbidden
🟠404Record Not Found
🟠400Bad Request
🟠422Unprocessable Entity
Modified at 2024-08-28 09:39:58
Previous
List all Orders
Next
Update an Order
Built with