Shipments
Stop tracking a shipment
Getting Started
In Depth Guides
Useful Info
Shipments
Tracking Requests
Webhooks
Webhook Notifications
Containers
Shipping Lines
Terminals
Shipments
Stop tracking a shipment
We’ll stop tracking the shipment, which means that there will be no more updates. You can still access the shipment’s previously-collected information via the API or dashboard.
You can resume tracking a shipment by calling the resume_tracking endpoint, but keep in mind that some information is only made available by our data sources at specific times, so a stopped and resumed shipment may have some information missing.
PATCH
/
shipments
/
{id}
/
stop_tracking
curl --request PATCH \
--url https://api.terminal49.com/v2/shipments/{id}/stop_tracking \
--header 'Authorization: <api-key>'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationships": {
"destination": {
"data": {
"type": "port",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"port_of_lading": {
"data": {
"type": "port",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"containers": {
"data": [
{
"type": "container",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"port_of_discharge": {
"data": {
"type": "port",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"pod_terminal": {
"data": {
"type": "terminal",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"destination_terminal": {
"data": {
"type": "terminal",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"line_tracking_stopped_by_user": {
"data": {
"type": "user",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
},
"attributes": {
"bill_of_lading_number": "<string>",
"normalized_number": "<string>",
"ref_numbers": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"port_of_lading_locode": "<string>",
"port_of_lading_name": "<string>",
"port_of_discharge_locode": "<string>",
"port_of_discharge_name": "<string>",
"destination_locode": "<string>",
"destination_name": "<string>",
"shipping_line_scac": "<string>",
"shipping_line_name": "<string>",
"shipping_line_short_name": "<string>",
"customer_name": "<string>",
"pod_vessel_name": "<string>",
"pod_vessel_imo": "<string>",
"pod_voyage_number": "<string>",
"pol_etd_at": "2023-11-07T05:31:56Z",
"pol_atd_at": "2023-11-07T05:31:56Z",
"pod_eta_at": "2023-11-07T05:31:56Z",
"pod_original_eta_at": "2023-11-07T05:31:56Z",
"pod_ata_at": "2023-11-07T05:31:56Z",
"destination_eta_at": "2023-11-07T05:31:56Z",
"destination_ata_at": "2023-11-07T05:31:56Z",
"pol_timezone": "<string>",
"pod_timezone": "<string>",
"destination_timezone": "<string>",
"line_tracking_last_attempted_at": "2023-11-07T05:31:56Z",
"line_tracking_last_succeeded_at": "2023-11-07T05:31:56Z",
"line_tracking_stopped_at": "2023-11-07T05:31:56Z",
"line_tracking_stopped_reason": "all_containers_terminated"
},
"type": "shipment",
"links": {
"self": "<string>"
}
}
}Authorizations
Token YOUR_API_TOKEN
The APIs require authentication to be done using header-based API Key and Secret Authentication.
API key and secret are sent va the Authorization request header.
You send your API key and secret in the following way:
Authorization: Token YOUR_API_KEY
Path Parameters
Response
200 - application/json
OK
The normalized version of the shipment number used for querying the carrier
UN/LOCODE
UN/LOCODE
UN/LOCODE
IANA tz
IANA tz
IANA tz
When Terminal49 last tried to update the shipment status from the shipping line
When Terminal49 last successfully updated the shipment status from the shipping line
When Terminal49 stopped checking at the shipping line
The reason Terminal49 stopped checking
Available options:
all_containers_terminated, past_arrival_window, no_updates_at_line, cancelled_by_user, booking_cancelled Available options:
shipment Was this page helpful?
curl --request PATCH \
--url https://api.terminal49.com/v2/shipments/{id}/stop_tracking \
--header 'Authorization: <api-key>'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationships": {
"destination": {
"data": {
"type": "port",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"port_of_lading": {
"data": {
"type": "port",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"containers": {
"data": [
{
"type": "container",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"port_of_discharge": {
"data": {
"type": "port",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"pod_terminal": {
"data": {
"type": "terminal",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"destination_terminal": {
"data": {
"type": "terminal",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"line_tracking_stopped_by_user": {
"data": {
"type": "user",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
},
"attributes": {
"bill_of_lading_number": "<string>",
"normalized_number": "<string>",
"ref_numbers": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"port_of_lading_locode": "<string>",
"port_of_lading_name": "<string>",
"port_of_discharge_locode": "<string>",
"port_of_discharge_name": "<string>",
"destination_locode": "<string>",
"destination_name": "<string>",
"shipping_line_scac": "<string>",
"shipping_line_name": "<string>",
"shipping_line_short_name": "<string>",
"customer_name": "<string>",
"pod_vessel_name": "<string>",
"pod_vessel_imo": "<string>",
"pod_voyage_number": "<string>",
"pol_etd_at": "2023-11-07T05:31:56Z",
"pol_atd_at": "2023-11-07T05:31:56Z",
"pod_eta_at": "2023-11-07T05:31:56Z",
"pod_original_eta_at": "2023-11-07T05:31:56Z",
"pod_ata_at": "2023-11-07T05:31:56Z",
"destination_eta_at": "2023-11-07T05:31:56Z",
"destination_ata_at": "2023-11-07T05:31:56Z",
"pol_timezone": "<string>",
"pod_timezone": "<string>",
"destination_timezone": "<string>",
"line_tracking_last_attempted_at": "2023-11-07T05:31:56Z",
"line_tracking_last_succeeded_at": "2023-11-07T05:31:56Z",
"line_tracking_stopped_at": "2023-11-07T05:31:56Z",
"line_tracking_stopped_reason": "all_containers_terminated"
},
"type": "shipment",
"links": {
"self": "<string>"
}
}
}