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

Update an Order

Developing
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
PATCH
/api/v1/orders/{reference}
Update an order by its reference number.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
reference
string 
required
Reference number of order.
Example:
200000001
Body Params application/json
order
object 
required
Details about the order
entry_date
string <date>
optional
Date when the order was entered
extref
string 
optional
Order number
input_output
string 
optional
Indicates if the order is an input or output
file_no
string 
optional
Delivery number
order_no
string 
optional
Order number
sender_code
string 
optional
Code of the sender
sender_name
string 
optional
Name of the sender
consignee_code
string 
optional
Code of the consignee
consignee_name
string 
optional
Name of the consignee
order_address
string 
optional
Address where the order is to be delivered
city
string 
optional
City of the delivery address
district
string 
optional
District of the delivery address
warehouse_code
string 
optional
Code of the warehouse
notes
string 
optional
No comment
interface_code
string 
optional
Interface code associated with the order
from_location_code
string 
optional
Output location code
to_location_code
string 
optional
Input location code
status
string 
optional
Status of the order
arrival_date
string <date>
optional
Expected date of arrival
process_type
string 
optional
Process type of the order
orderlines_attributes
array [object {15}] 
optional
Lines of products included in the order
Example
{
  "order": {
    "order_no": "123"
  }
}

Request 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 PATCH 'https://demo.modaltrans.com/api/v1/orders/200000001' \
--header 'Content-Type: application/json' \
--data-raw '{
  "order": {
    "order_no": "123"
  }
}'

Responses

🟢200Success
application/json
Body
array of:
reference
string 
required
Reference number of the order
entry_date
string <date>
required
Date when the order was entered
extref
string 
required
Order no
input_output
string 
required
Indicates if the order is an input or output transaction
order_no
string 
required
Order number associated with the transaction
file_no
string 
required
Order no
from_location_code
string 
required
Output location code
to_location_code
string 
required
Input location code
arrival_date
string <date>
required
Expected date of arrival
sender_code
string 
required
Code of the sender
sender_name
string 
required
Name of the sender
consignee_code
string 
required
Code of the consignee
consignee_name
string 
required
Name of the consignee
order_address
string 
required
Address where the order is to be delivered
district
string 
required
District of the delivery address
city
string 
required
City of the delivery address
postcode
string 
required
Postal code of the delivery address
state
string 
required
State of the delivery address
country_id
string 
required
Country ID of the delivery address
warehouseCode
string 
required
Code of the warehouse
interface_code
string 
required
Interface code associated with the order
orderLines
array [object {15}] 
required
Lines of products included in the order
line_no
integer 
required
Line number of the product
serial_no
string 
required
Serial number of the product
weight
number 
required
Weight of the product
volume
number 
required
Volume of the product
price
number 
required
Price of the product
price_curr
string 
required
Currency of the price
delivery_date
string <date>
required
Expected delivery date of the product
asset_no
string 
required
Asset number of the product
subinventory_code
string 
required
Code of the subinventory
origin_country_id
string 
required
Country ID of the origin of the product
remote_id
string 
required
Voyage number
productName
string 
required
Name of the product
barCode
string 
required
Barcode of the product
packCount
number 
required
Number of packs
packType
string 
required
Type of packing
Example
{
    "reference": "200000001",
    "entry_date": "2020-10-13",
    "extref": "20200000001",
    "input_output": "input",
    "order_no": "123",
    "file_no": "09afdb44-e4c1-4109-a944-ce22dd0b508b",
    "from_location_code": "",
    "to_location_code": "",
    "arrival_date": "",
    "sender_code": "",
    "sender_name": "",
    "consignee_code": "",
    "consignee_name": "",
    "order_address": "",
    "district": "",
    "city": "",
    "postcode": "",
    "state": "",
    "country_id": "",
    "warehouseCode": "",
    "interface_code": null,
    "orderLines": [
        {
            "line_no": "",
            "serial_no": "",
            "weight": "0.0",
            "volume": "0.0",
            "price": "0.0",
            "price_curr": "",
            "delivery_date": "",
            "asset_no": "",
            "subinventory_code": "",
            "origin_country_id": "",
            "remote_id": "",
            "productName": "PIL",
            "barCode": "PIL",
            "packCount": "200.0",
            "packType": ""
        }
    ]
}
🟠400Bad Request
🟠422Unprocessable Content
🟠403Forbidden
🟠404Record Not Found
Modified at 2024-08-29 12:21:00
Previous
Create an Order
Next
Retrieve a Product
Built with