Update a Shipment

Developing

Testing Env

https://demo.modaltrans.com

PATCH

/api/v1/shipments/{id}

Update a Shipment.

If you want to update booking part of shipment you should use Booking path with booking parameters.

supplier_name, agent_name and vessel_name must match a record exactly, as GET /api/v1/companies and the vessel catalogue hold it. A name that matches nothing, or a vessel name that matches more than one vessel, is rejected with 422.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/json

Example

{
    "position": {
        "extref": "test12"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://demo.modaltrans.com/api/v1/shipments/2130791' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "position": {
        "extref": "test12"
    }
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

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

🟠403Forbidden

🟠404Record Not Found

🟠422

Modified at 2026-09-24 12:44:07

Create a Shipment

Retrieve an Order