Update a Shipment

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

id

integer

required

ID of the Shipment.

Example:

2130791

Body Params application/json

Shipment Part

status

enum<string>

optional

Status of the shipment

Allowed values:

planningactivearrived

trans_method

enum<string>

optional

Trans Method

Allowed values:

roadseaairrail

waybill_no

string

optional

Waybill No or BOL/CMR No or Awb no

waybill_date

string <date>

optional

Waybill Date or BOL/CMR Date or Awb Date

truck_type

string

optional

Type of truck

Examples:

trailertruckvan

estimated_dep_date

string <date-time>

optional

ETD

estimated_arv_date

string <date-time>

optional

ETA

arv_country_id

string

optional

Arrival Country ID

Examples:

GBUSTR

dep_country_id

string

optional

Departure Country ID

voyage

string

optional

Voyage No

supplier_name

string

optional

Supplier Company

truck_code

string

optional

Truck No

vessel_code

string

optional

Vessel Code or Trailer No

driver_name

string

optional

Name of the driver

driver_tel

string

optional

Tel number of the driver

driver_email

string <email>

optional

Email of the driver

deadline_date

string <date-time>

optional

Deadline Date

target_volume

number

optional

Target Volume

target_weight

number

optional

Targer Weight

hub_motion_exit_date

string <date-time>

optional

Trasnfer Hub Exit Date

contract_type

enum<string>

optional

Owned or Rented

Allowed values:

ownedrented

empty_truck

boolean

optional

Trailer Empty or not

freight_price

number

optional

Freight Price

freight_curr

string

optional

Freight Curr

Examples:

USDGBP

dep_odemeter

integer

optional

Deoarture KM

arv_odemeter

integer

optional

Arrival KM

total_fuel

number

optional

Total Fuel

driver_payment

number

optional

Driver Payment

waybill_type

string

optional

Waybill Type

commission

number

optional

Allowance

vagon

string

optional

Wagon

vehicle_movement_type

string

optional

Trailer Movement Type

intermodal

boolean

optional

Intermodal

coagent_hbl_no

string

optional

Co-Agent House No

border_date

string <date>

optional

Border Date / Cut-Off

assigned_date

string <date-time>

optional

Truck Assign Date

free_time

integer

optional

Free Time

container_no

string

optional

Container No

container_type

string

optional

Container Type

cmr_no

string

optional

CMR No

cargo_manifest_no

string

optional

Cargo Manifest No

cargo_manifest_date

string <date>

optional

Cargo Manifest Date

transit_code1

string

optional

1.

Voyage No

transit_code2

string

optional

2.

Voyage No

transit_code3

string

optional

3.

Voyage No

departure_date

string <date-time>

optional

Departure Date

arrival_date

string <date-time>

optional

Arrival Date

trans_type

string

optional

Operation Type

active_date

string <date-time>

optional

OP: Active Date

freight_price_rate

number

optional

Tariff Rate

ppcc

enum<string>

optional

Payment Term

Allowed values:

ppcc

agent_name

string

optional

Agent Name

route_notes

string

optional

Route Notes

transit_date1

string <date>

optional

1.

Transfer Date

transit_date2

string <date>

optional

2.

Transfer Date

transit_date3

string <date>

optional

3.

Transfer Date

report_date

string <date>

optional

Report Date

Example

{
    "position": {

        "extref": "test12"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'https://demo.modaltrans.com/api/v1/shipments/2130791' \
--header 'Content-Type: application/json' \
--data-raw '{
    "position": {

        "extref": "test12"
    }
}'

Responses

🟢200Success

application/json

Body

alert

string

required

Example

{
    "alert": "Transport has been updated succesfully"
}

🟠403Forbidden

🟠404Record Not Found

🟠400Bad Request