Getting Started
Endpoints
- Shipments
- Invoices
- Locations
- Documents
- Tracking
- Purchase Orders
- Users
- Reporting
Tracking
Fetch a shipment's tracking.
Fetch a shipment’s tracking with its OVRSEA shipment id.
Copy
curl --request GET \
--url https://ymmguxlah4.execute-api.eu-west-1.amazonaws.com/v1/tracking/{ovrsea_shipment_id}
Copy
{
"ovrsea_shipment_id": "BATE",
"status": "<string>",
"tracking_steps": [
{
"type": "location",
"location": {
"id": 12345,
"company_name": "Logistics WorldWide Co",
"name": "Saint Quentin warehouse",
"address": "357 allée des Tilleuls",
"city": "Saint Quentin Fallavier",
"zip_code": 69300,
"country": "FR",
"contacts": [
{
"name": "Thierry Henriet",
"email": "log@patagonia.com",
"phone": 33134567891
}
],
"opening_hours": "Monday to Friday 8am to 5pm",
"requires_appointment": true,
"requires_tailgate_truck": false,
"additional_information": "Please avoid Friday after 4pm"
},
"port": {
"unlocode": "FR/LEH",
"city": "Le Havre",
"country": "FR"
},
"events": [
{
"description": "Loaded on Vessel",
"container_number": "MSDU8878398",
"date": "2021-09-20T10:02:09+01:00",
"status": "estimated"
}
]
}
],
"ocean_coordinates": [
{
"latitude": "48.858093",
"longitude": "2.294694"
}
]
}
Path Parameters
Response
200
application/json
Returns tracking for a shipment
Copy
curl --request GET \
--url https://ymmguxlah4.execute-api.eu-west-1.amazonaws.com/v1/tracking/{ovrsea_shipment_id}
Copy
{
"ovrsea_shipment_id": "BATE",
"status": "<string>",
"tracking_steps": [
{
"type": "location",
"location": {
"id": 12345,
"company_name": "Logistics WorldWide Co",
"name": "Saint Quentin warehouse",
"address": "357 allée des Tilleuls",
"city": "Saint Quentin Fallavier",
"zip_code": 69300,
"country": "FR",
"contacts": [
{
"name": "Thierry Henriet",
"email": "log@patagonia.com",
"phone": 33134567891
}
],
"opening_hours": "Monday to Friday 8am to 5pm",
"requires_appointment": true,
"requires_tailgate_truck": false,
"additional_information": "Please avoid Friday after 4pm"
},
"port": {
"unlocode": "FR/LEH",
"city": "Le Havre",
"country": "FR"
},
"events": [
{
"description": "Loaded on Vessel",
"container_number": "MSDU8878398",
"date": "2021-09-20T10:02:09+01:00",
"status": "estimated"
}
]
}
],
"ocean_coordinates": [
{
"latitude": "48.858093",
"longitude": "2.294694"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.