Tracking Requests
Edit a tracking request
Getting Started
In Depth Guides
Useful Info
Shipments
Tracking Requests
Webhooks
Webhook Notifications
Containers
Shipping Lines
Terminals
Tracking Requests
Edit a tracking request
Update a tracking request
PATCH
/
tracking_requests
/
{id}
curl --request PATCH \
--url https://api.terminal49.com/v2/tracking_requests/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"attributes": {
"ref_number": "REFNUMBER11"
}
}
}'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "tracking_request",
"attributes": {
"request_number": "ONEYSH9AME650500",
"ref_numbers": [
"<string>"
],
"tags": [
"<string>"
],
"status": "pending",
"failed_reason": "booking_cancelled",
"request_type": "bill_of_lading",
"scac": "ONEY",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_retrying": true,
"retry_count": 123
},
"relationships": {
"tracked_object": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "shipment"
}
},
"customer": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "party"
}
}
}
}
}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
Tracking Request ID
Body
application/json
Response
200 - application/json
OK
Available options:
tracking_request Example:
"ONEYSH9AME650500"
Available options:
pending, awaiting_manifest, created, failed, tracking_stopped Available options:
bill_of_lading, booking_number, container Example:
"bill_of_lading"
Required string length:
4Example:
"ONEY"
If the tracking request has failed, or is currently failing, the last reason we were unable to complete the request
Available options:
booking_cancelled, duplicate, expired, internal_processing_error, invalid_number, not_found, retries_exhausted, shipping_line_unreachable, unrecognized_response, data_unavailable How many times T49 has attempted to get the shipment from the shipping line
Was this page helpful?
curl --request PATCH \
--url https://api.terminal49.com/v2/tracking_requests/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"attributes": {
"ref_number": "REFNUMBER11"
}
}
}'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "tracking_request",
"attributes": {
"request_number": "ONEYSH9AME650500",
"ref_numbers": [
"<string>"
],
"tags": [
"<string>"
],
"status": "pending",
"failed_reason": "booking_cancelled",
"request_type": "bill_of_lading",
"scac": "ONEY",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_retrying": true,
"retry_count": 123
},
"relationships": {
"tracked_object": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "shipment"
}
},
"customer": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "party"
}
}
}
}
}