1. NCTS Declarations
  • 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
          GET
        • Retrieve an NCTS Declaration
          GET
        • Create an NCTS Declaration with XML Data
          POST
        • Create an Ens Declaration from JSON
          POST
        • Update an NCTS Declaration
          PATCH
        • Download an NCTS Declaration
          GET
        • List Timelines of NCTS Declaration
          GET
        • List Messages of NCTS Decalaration
          GET
      • 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
  1. NCTS Declarations

Update an NCTS Declaration

Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
PATCH
/api/v1/ncts_declarations/{reference}{id}{mrn}{lrn}
Updates an NCTS Declaration using the parameters specified below.

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 the declaration.
Example:
SF240003SUPREME
id
integer 
required
ID of the declaration.
mrn
string 
required
MRN number of the declaration.
lrn
string 
required
LRN number of the declaration.
Body Params application/json
manifesto
object 
required
NCTS Declaration
doc_type
string 
optional
Type of the document
rejim
string 
optional
Regime of the NCTS Declaration
doc_date
string <date>
optional
Date of the document
container
string 
optional
Container identifier or number
vehicle_code
string 
optional
Code/Plate Number of the vehicle used for transportation
vehicle_coun
string 
optional
Country code of the vehicle's registration
trailer_code
string 
optional
Code/Plate Number of the trailer used with the vehicle
trailer_coun
string 
optional
Country code of the trailer's registration
border_cross_vehicle
string 
optional
Code/Plate Number of the vehicle crossing the border
departure_custom_code
string 
optional
Customs code at the point of departure
dispatch_country_id
string 
optional
ID of the dispatch country
load_place
string 
optional
Place where the goods are loaded
goods_location
string 
optional
Location of the goods
arrival_custom_code
string 
optional
Customs code at the point of arrival
destination_country_id
string 
optional
ID of the destination country
unload_place
string 
optional
Place where the goods are unloaded
is_aeo
boolean 
optional
Indicates whether the shipment is part of the AEO program
aeo_location
string 
optional
Location related to the AEO program
transit_date
string <date>
optional
Date of transit
trans_method
string 
optional
Method of transportation
roro_operator_code
string 
optional
Ro-Ro operator code
route_code
string 
optional
Code of the route taken
border_custom_code
string 
optional
Customs code at the border
position_no
string 
optional
Position number of NCTS Declaration
remote_ref
string 
optional
Reference for Agent
seal_info
string 
optional
Seal No
security
boolean 
optional
Indicates wheter declaration is secure
tanker
boolean 
optional
Indicates wheter there is a tanker
transit_customs_codes
string 
optional
List of customs codes for transit
transit_countries_codes
string 
optional
List of country codes for countries on route
lrn
string 
optional
LRN number of the NCTS declaration
mrn
string 
optional
MRN nuber of the NCTS declaration
carrier_name
string 
optional
Name of the carrier
carrier_address
string 
optional
Address of the carrier
carrier_city
string 
optional
City where the carrier is located
carrier_country_id
string 
optional
Country ID of the carrier
carrier_postcode
string 
optional
Postcode of the carrier
carrier_taxno
string 
optional
Tax number of the carrier
carrier_eori_code
string 
optional
EORI code of the carrier
carrier_no
string 
optional
Carrier number
ncts_data
string 
optional
Data related to the NCTS Declaration
notes
string 
optional
Additional notes or comments
status
string 
optional
Status of the NCTS Declaration
reject_notes
string 
optional
Cansel/Reject Reason
parent_manifesto_id
integer 
optional
ID of the parent NCTS Declaration, if any
dummy
boolean 
optional
Flag indicating whether this is a dummy manifesto
goods_attributes
array [object {29}] 
optional
Attributes related to the goods in the shipment
Example
{
    "manifesto": {
        "notes": "Example"
    }
}

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/ncts_declarations/SF240003SUPREME' \
--header 'Content-Type: application/json' \
--data-raw '{
    "manifesto": {
        "notes": "Example"
    }
}'

Responses

🟢200OK
application/json
Body
transaction_id
integer 
required
Transaction ID of the NCTS Declaration
reference
string 
required
Reference number of the NCTS Declaration
doc_type
string 
required
Type of the document
doc_date
string <date>
required
Date of the document
vehicle_code
string 
required
Code/Plate Number of the vehicle
vehicle_coun
string 
required
Country of the vehicle
trailer_code
string 
required
Code/Plate Number of the trailer
trailer_coun
string 
required
Country of the trailer
border_cross_vehicle
string 
required
Vehicle used to cross the border
container
string 
required
Container information
seal_info
string 
required
Seal information
security
boolean 
required
Security status
tanker
boolean 
required
Indicates if the vehicle is a tanker
is_aeo
boolean 
required
Indicates if the vehicle is AEO authorised
aeo_location
string 
required
Location of AEO certification
transit_date
string <date>
required
Date of transit
departure_custom_code
string 
required
Code of the departure customs
dispatch_country_id
string 
required
Country ID of the dispatch location
load_place
string 
required
Place of loading
goods_location
string 
required
Location of the goods
arrival_custom_code
string 
required
Code of the arrival customs
destination_country_id
string 
required
Country ID of the destination
unload_place
string 
required
Place of unloading
border_custom_code
string 
required
Code of the border customs
transit_customs_codes
string 
required
Codes of the transit customs
transit_countries_codes
string 
required
Codes of the transit countries
carrier_name
string 
required
Name of the carrier
carrier_address
string 
required
Address of the carrier
carrier_postcode
string 
required
Postal code of the carrier
carrier_city
string 
required
City of the carrier
carrier_country_id
string 
required
Country ID of the carrier
carrier_taxno
string 
required
Tax number of the carrier
carrier_eori_code
string 
required
EORI code of the carrier
custom_line
string 
required
Customs line
custom_staff_name
string 
required
Name of the customs staff
trans_method
string 
required
Method of transportation
roro_operator_code
string 
required
Code of the RoRo operator
guarantee_price
number 
required
Price of the guarantee
guarantee_curr
string 
required
Currency of the guarantee price
status
string 
required
Status of the of the NCTS Declaration
lrn_no
string 
required
LRN of the NCTS Declaration
lrn
string 
required
LRN of the NCTS Declaration
mrn
string 
required
MRN of the NCTS Declaration
mrn_no
string 
required
MRN of the NCTS Declaration
lrn_url
string 
required
URL for the LRN
manifesto_price
number 
required
Price of the NCTS Declaration
manifesto_curr
string 
required
Currency of the NCTS Declaration price
position_no
string 
required
Position number in the NCTS Declaration
remote_ref
string 
required
Remote reference number
notes
string 
required
Additional notes regarding the transaction
letter_grn
string 
required
Letter of guaranttor
guarantor_name
string 
required
Name of the guarantor
guarantor_city
string 
required
City of the guarantor
guarantor_taxno
string 
required
Tax number of the guarantor
guarantor_address
string 
required
Address of the guarantor
guarantor_postcode
string 
required
Postal code of the guarantor
guarantor_eori_code
string 
required
EORI code of the guarantor
guarantor_country_id
string 
required
Country ID of the guarantor
mrn_date
string <date-time>
required
Date of the MRN
stamp_duty
string 
required
Stamp duty information
ncts5_checker
boolean 
required
NCTS5 checker status
released_at
string <date-time>
required
Release date and time
goods_attributes
array [object {30}] 
optional
Attributes of the goods included in the transaction
line_no
integer 
required
Line number of the goods
gtip_code
string 
required
GTIP code of the goods
commodity
string 
required
Type of commodity
brut_wg
number 
required
Gross weight of the goods
net_wg
number 
required
Net weight of the goods
invoice_amount
number 
required
Amount on the invoice for the goods
invoice_curr
string 
required
Currency of the invoice amount
exp_customs_type
string 
required
Type of export customs
exp_customs_partial
boolean 
required
Indicates whether there is a partial export declaration
exp_customs_no
string 
required
Export declaration number of the goods
manifesto_type
string 
required
Type of the NCTS Declaration
dep_country_id
string 
required
Country ID of the departure location
arv_country_id
string 
required
Country ID of the arrival location
sender_taxno
string 
required
Tax number of the sender
sender_name
string 
required
Name of the sender
sender_address
string 
required
Address of the sender
sender_postcode
string 
required
Postal code of the sender
sender_city
string 
required
City of the sender
sender_country_id
string 
required
Country ID of the sender
sender_eori_code
string 
required
EORI code of the sender
consignee_taxno
string 
required
Tax number of the consignee
consignee_name
string 
required
Name of the consignee
consignee_address
string 
required
Address of the consignee
consignee_postcode
string 
required
Postal code of the consignee
consignee_city
string 
required
City of the consignee
consignee_country_id
string 
required
Country ID of the consignee
consignee_eori_code
string 
required
EORI code of the consignee
packs_attributes
array [object {3}] 
required
Packages
documents_attributes
array [object {3}] 
required
Declaration Documents
produced_documents_attributes
array [object {5}] 
required
Additional Documents/Certificates
Example
{
    "transaction_id": 0,
    "reference": "string",
    "doc_type": "string",
    "doc_date": "2019-08-24",
    "vehicle_code": "string",
    "vehicle_coun": "string",
    "trailer_code": "string",
    "trailer_coun": "string",
    "border_cross_vehicle": "string",
    "container": "string",
    "seal_info": "string",
    "security": true,
    "tanker": true,
    "is_aeo": true,
    "aeo_location": "string",
    "transit_date": "2019-08-24",
    "departure_custom_code": "string",
    "dispatch_country_id": "string",
    "load_place": "string",
    "goods_location": "string",
    "arrival_custom_code": "string",
    "destination_country_id": "string",
    "unload_place": "string",
    "border_custom_code": "string",
    "transit_customs_codes": "string",
    "transit_countries_codes": "string",
    "carrier_name": "string",
    "carrier_address": "string",
    "carrier_postcode": "string",
    "carrier_city": "string",
    "carrier_country_id": "string",
    "carrier_taxno": "string",
    "carrier_eori_code": "string",
    "custom_line": "string",
    "custom_staff_name": "string",
    "trans_method": "string",
    "roro_operator_code": "string",
    "guarantee_price": 0,
    "guarantee_curr": "string",
    "status": "string",
    "lrn_no": "string",
    "lrn": "string",
    "mrn": "string",
    "mrn_no": "string",
    "lrn_url": "string",
    "manifesto_price": 0,
    "manifesto_curr": "string",
    "position_no": "string",
    "remote_ref": "string",
    "notes": "string",
    "letter_grn": "string",
    "guarantor_name": "string",
    "guarantor_city": "string",
    "guarantor_taxno": "string",
    "guarantor_address": "string",
    "guarantor_postcode": "string",
    "guarantor_eori_code": "string",
    "guarantor_country_id": "string",
    "mrn_date": "2019-08-24T14:15:22Z",
    "stamp_duty": "string",
    "ncts5_checker": true,
    "released_at": "2019-08-24T14:15:22Z",
    "goods_attributes": [
        {
            "line_no": 0,
            "gtip_code": "string",
            "commodity": "string",
            "brut_wg": 0,
            "net_wg": 0,
            "invoice_amount": 0,
            "invoice_curr": "string",
            "exp_customs_type": "string",
            "exp_customs_partial": true,
            "exp_customs_no": "string",
            "manifesto_type": "string",
            "dep_country_id": "string",
            "arv_country_id": "string",
            "sender_taxno": "string",
            "sender_name": "string",
            "sender_address": "string",
            "sender_postcode": "string",
            "sender_city": "string",
            "sender_country_id": "string",
            "sender_eori_code": "string",
            "consignee_taxno": "string",
            "consignee_name": "string",
            "consignee_address": "string",
            "consignee_postcode": "string",
            "consignee_city": "string",
            "consignee_country_id": "string",
            "consignee_eori_code": "string",
            "packs_attributes": [
                {
                    "pack_type": "AE",
                    "pack_count": 0,
                    "notes": "string"
                }
            ],
            "documents_attributes": [
                {
                    "doc_type": "T1",
                    "doc_no": "string",
                    "pre_post": "string"
                }
            ],
            "produced_documents_attributes": [
                {
                    "code": "string",
                    "reference": "string",
                    "status": "string",
                    "reason": "string",
                    "quantity": 0
                }
            ]
        }
    ]
}
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
🟠422Unprocessable Entity
Modified at 2025-03-25 10:48:25
Previous
Create an Ens Declaration from JSON
Next
Download an NCTS Declaration
Built with