Enable tracking for a screened Bill of Lading

Production

https://api.polestar-production.com

PUT

/purpletrac/v1/blv/{id}/track

Enables tracking for a screened Bill of Lading. This will continuously rescreen a bill of lading every 24 hours.

Refer to Bill of Lading Verification to see how to use this endpoint in a bill of lading tracking workflow.

Request

Authorization

API Key

Add parameter in query

api_key

Example:

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

Path Params

Query Params

Responses

🟢200OK

application/json

Tracking started. The bill of lading is rescreened every 24 hours until it is declined or completes.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.polestar-production.com/purpletrac/v1/blv//track?username=undefined&api_key=%3Capi-key%3E'

Response Example

200 - Default

{
    "archived": false,
    "blv_no": "ISB1235295",
    "blv_phase_status": "TRACK",
    "blv_type": "string",
    "client_reference": "",
    "creation_date": "2023-12-11 14:40:27.171665+00:00",
    "id": 35260,
    "is_trackable": true,
    "last_screening_result": {
        "carrier_severity": "OK",
        "details": {
            "cargo": {
                "containers_no": [
                    "CMAU8752246"
                ]
            },
            "container_numbers": [
                "CMAU8752246"
            ],
            "ordered_port_unlocodes": [
                "TRMER",
                "EGALY"
            ],
            "voyages": [
                {
                    "arrival_port": {
                        "city": "Alexandria, Egypt",
                        "country": "Egypt",
                        "estimated_time": "11.03.2023 15:00",
                        "unlocode": "EGALY"
                    },
                    "departure_port": {
                        "city": "Mersin, Turkey",
                        "country": "Turkey",
                        "estimated_time": "05.03.2023 04:24",
                        "unlocode": "TRMER"
                    },
                    "imo_number": 9311842,
                    "is_custom": false,
                    "mode": "Unknown",
                    "seq": 1,
                    "transport_name": "SC MONTANA"
                }
            ]
        },
        "id": 38353,
        "overall_severity": "WARNING",
        "port_of_destination": {
            "code": "EGALY",
            "name": "Alexandria, Egypt"
        },
        "port_of_origin": {
            "code": "TRMER",
            "name": "Mersin, Turkey"
        },
        "screened_ports": [
            {
                "code": "TRMER",
                "country": {
                    "code": "TUR",
                    "iso_3166_1_alpha_2": "TR",
                    "name": "Turkey"
                },
                "name": "Mersin",
                "overall_severity": "OK",
                "seq": 0
            },
            {
                "code": "EGALY",
                "country": {
                    "code": "EGY",
                    "iso_3166_1_alpha_2": "EG",
                    "name": "Egypt"
                },
                "name": "Alexandria",
                "overall_severity": "OK",
                "seq": 1
            }
        ],
        "screened_ships": [
            {
                "document_id": 4932934,
                "flag": {
                    "code": "LBR",
                    "iso_3166_1_alpha_2": "LR",
                    "name": "Liberia"
                },
                "imo_number": "9311842",
                "overall_severity": "WARNING",
                "seq": 0,
                "ship_name": "SC MONTANA",
                "transaction_id": 2863260
            }
        ],
        "screening_date": "2023-12-11T14:40:27.178234",
        "screening_status": "SCREENING_COMPLETED"
    },
    "notifications": [
        {
            "acknowledged": false,
            "blv": "/api/v1/blv/35260",
            "cleared": false,
            "comment": "",
            "creation_date": "2023-12-11T15:36:00.116953+00:00",
            "document_id": null,
            "event": "BL_SELECTED_FOR_TRACKING",
            "event_date": "2023-12-11T15:36:00.111687+00:00",
            "id": 52699269,
            "last_updated_date": "2023-12-11T15:36:00.116977+00:00",
            "parent_notification_id": null,
            "related_obj_id": null,
            "related_text": "",
            "resource_uri": "/api/v1/notification/52699269",
            "severity": "OK",
            "transaction": null,
            "updated_since_creation": false,
            "user": "/api/v1/user/6913"
        },
        {
            "acknowledged": false,
            "blv": "/api/v1/blv/35260",
            "cleared": false,
            "comment": "",
            "creation_date": "2023-12-11T14:40:54.096909+00:00",
            "document_id": null,
            "event": "BLV_SCREENING_COMPLETE",
            "event_date": "2023-12-11T14:40:54.094287+00:00",
            "id": 52697508,
            "last_updated_date": "2023-12-11T14:40:54.096934+00:00",
            "parent_notification_id": null,
            "related_obj_id": null,
            "related_text": "",
            "resource_uri": "/api/v1/notification/52697508",
            "severity": "OK",
            "transaction": null,
            "updated_since_creation": false,
            "user": "/api/v1/user/6913"
        }
    ],
    "num_notifications": 2,
    "overall_severity": "WARNING",
    "resource_uri": "/api/v1/blv/35260",
    "scac": "CMDU",
    "scac_name": "CMA CGM",
    "screening_status": "SCREENING_COMPLETED",
    "ship_transactions": [
        "/api/v1/transaction/2863260"
    ]
}

Modified at 2026-09-30 13:56:35

Get the PurpleTRAC Bill of Lading Screening Report PDF

Get the PurpleTRAC Bill of Lading Tracking Report PDF