Update voyage and tracking details

Production

https://api.polestar-production.com

PUT

/purpletrac/v1/transaction/{id}/voyage_update

Update the voyage and tracking configuration of an existing transaction, for example to correct the departure or destination port, add interim ports, change the client reference or extend the tracking expiry.

If the transaction has no voyage recorded against it yet, one is created from the fields supplied in the request.

Vessels which are tracked from a Bill of Lading cannot be updated with this method.

Refer to Updating Voyage Details to see how this endpoint is used in the vessel tracking workflow.

Request

Authorization

API Key

Add parameter in query

api_key

Example:

api_key: ********************

Path Params

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The voyage was updated. Fields omitted from the request are left as they were.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

Extend tracking onlyFull voyage update

curl --location --request PUT 'https://api.polestar-production.com/purpletrac/v1/transaction//voyage_update?username=undefined&api_key=%3Capi-key%3E' \
--header 'Content-Type: application/json' \
--data '{
    "tracking_expiry": "2026-09-08T00:00:00Z"
}'

Response Example

200 - Default

{
    "added_via": "MANUAL",
    "ais_gap_status": "N",
    "ais_received": null,
    "ais_reporting": true,
    "auto_deregister": false,
    "auto_deregistered": false,
    "auto_register": true,
    "blv": null,
    "carbon_rating_screen": false,
    "client_reference": "my custom reference",
    "closed_date": null,
    "container_screen_id": null,
    "creation_date": "2026-06-09T13:45:31.126526",
    "dbi_status": null,
    "deregistration_reason": null,
    "has_gaps": null,
    "id": 985724,
    "inmarsatc_expected": null,
    "inmarsatc_interval": 2,
    "inmarsatc_received": null,
    "inmarsatc_reporting": false,
    "only_tracking_by_ais": true,
    "overall_severity": "CRITICAL",
    "pandi_club_screen": false,
    "positional_discrepancy_status": null,
    "registered_date": "2026-06-10T06:06:36.215804",
    "registered_name": "8121977",
    "report_generation_complete": true,
    "resource_uri": "/api/v1/transaction/985724",
    "screened_date": "2026-06-09T13:45:32.506610",
    "screening_status": "CRITICAL",
    "ship": "/api/v1/shipdetails/202198",
    "status": "A",
    "sts_overall_severity": null,
    "tracking_date": "2026-06-10T06:39:56.525488",
    "tracking_expiry": "2026-09-08T00:00:00",
    "transceiver_domain": "",
    "transceiver_domain_id": "",
    "user": "/api/v1/user/7718",
    "voyage": "/api/v1/voyage/22661"
}

Modified at 2026-09-18 08:35:54

List the additional entities on a transaction

Get vessel positional data