Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MCP_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Search for bill of lading 123456789
| `get_container` | Get detailed container information |
| `get_shipment_details` | Get complete shipment routing and containers |
| `get_container_transport_events` | Get full event timeline |
| `get_container_route` | Get vessel routing with ETAs |
| `get_container_route` | Get ports in route order with ETAs and the current vessel |
| `get_supported_shipping_lines` | List 40+ supported carriers |
| `list_containers` | Browse all tracked containers |
| `list_shipments` | Browse all shipments |
Expand Down
904 changes: 464 additions & 440 deletions Terminal49-API.postman_collection.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ title: Edit a container
description: Update editable container attributes in the Terminal49 API, including weight, seal number, and reference fields, on active or completed shipments.
og:title: Edit a Container | Terminal49 API Documentation
og:description: Update container attributes like weight, seal number, or reference fields using the Terminal49 API. Apply changes to active or completed shipments.
openapi: patch /containers
openapi: patch /containers/{id}
---
2 changes: 1 addition & 1 deletion docs/api-docs/in-depth-guides/mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ T49_API_TOKEN=YOUR_API_KEY npm run mcp:stdio 2>&1 | head -20
| `get_shipment_details` | Get shipment and containers | `id: uuid`, `include_containers?: boolean`, `include_custom_fields?: boolean` |
| `get_container_transport_events` | Get event timeline | `id: uuid` |
| `get_supported_shipping_lines` | List carriers with SCAC codes | `search?: string` |
| `get_container_route` | Get multi-leg routing (paid feature) | `id: uuid` |
| `get_container_route` | Get ports in route order with ETAs and the current vessel (paid feature) | `id: uuid` |
| `list_shipments` | List shipments with filters + pagination | `status?`, `port?`, `carrier?`, `updated_after?`, `include_containers?`, `page?`, `page_size?` |
| `list_containers` | List containers with filters + pagination | `status?`, `port?`, `carrier?`, `updated_after?`, `include?`, `page?`, `page_size?` |
| `list_tracking_requests` | List tracking requests with filters | `filters?`, `status?`, `request_type?`, `page?`, `page_size?` |
Expand Down
29 changes: 26 additions & 3 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,14 @@
"pages": [
"sdk/reference/client/index",
"sdk/reference/client/classes/Terminal49Client",
"sdk/reference/client/interfaces/Terminal49ClientConfig"
"sdk/reference/client/interfaces/Terminal49ClientConfig",
"sdk/reference/client/interfaces/CustomFieldDefinitionListFilters",
"sdk/reference/client/interfaces/CustomFieldListFilters",
"sdk/reference/client/interfaces/TriggerWebhookParams",
"sdk/reference/client/interfaces/VesselFuturePositionsParams",
"sdk/reference/client/interfaces/VesselFuturePositionsWithCoordsParams",
"sdk/reference/client/interfaces/WebhookNotificationGetOptions",
"sdk/reference/client/interfaces/WebhookNotificationListOptions"
]
},
{
Expand All @@ -414,11 +421,18 @@
"sdk/reference/client/managers/index",
"sdk/reference/client/managers/classes/BaseManager",
"sdk/reference/client/managers/classes/ContainerManager",
"sdk/reference/client/managers/classes/DocumentManager",
"sdk/reference/client/managers/classes/DocumentSchemaManager",
"sdk/reference/client/managers/classes/EmailSubmissionManager",
"sdk/reference/client/managers/classes/ShipmentManager",
"sdk/reference/client/managers/classes/ShippingLineManager",
"sdk/reference/client/managers/classes/TrackingRequestManager",
"sdk/reference/client/managers/interfaces/CreateDocumentParams",
"sdk/reference/client/managers/interfaces/CreateTrackingRequestFromInferOptions",
"sdk/reference/client/managers/interfaces/DocumentListFilters",
"sdk/reference/client/managers/interfaces/TrackingRequestListFilters",
"sdk/reference/client/managers/interfaces/UpdateDocumentParams",
"sdk/reference/client/managers/type-aliases/DocumentRotation",
"sdk/reference/client/managers/type-aliases/TrackingRequestType"
]
},
Expand Down Expand Up @@ -459,9 +473,13 @@
"pages": [
"sdk/reference/types/models/index",
"sdk/reference/types/models/interfaces/Container",
"sdk/reference/types/models/interfaces/ContainerRoute",
"sdk/reference/types/models/interfaces/PaginatedResult",
"sdk/reference/types/models/interfaces/PaginationLinks",
"sdk/reference/types/models/interfaces/Route",
"sdk/reference/types/models/interfaces/RouteCoordinates",
"sdk/reference/types/models/interfaces/RoutePort",
"sdk/reference/types/models/interfaces/RouteVessel",
"sdk/reference/types/models/interfaces/RouteVesselPort",
"sdk/reference/types/models/interfaces/Shipment",
"sdk/reference/types/models/interfaces/ShippingLine",
"sdk/reference/types/models/interfaces/TrackingRequest"
Expand All @@ -478,7 +496,8 @@
"sdk/reference/types/options/type-aliases/IncludeParam",
"sdk/reference/types/options/type-aliases/ResponseFormat",
"sdk/reference/types/options/type-aliases/ShipmentInclude",
"sdk/reference/types/options/type-aliases/TrackingRequestInclude"
"sdk/reference/types/options/type-aliases/TrackingRequestInclude",
"sdk/reference/types/options/type-aliases/WebhookNotificationInclude"
]
}
]
Expand Down Expand Up @@ -641,6 +660,10 @@
{
"source": "/api-docs/getting-started/migrate-from-searates",
"destination": "/migrate/searates"
},
{
"source": "/sdk/reference/types/models/interfaces/Route",
"destination": "/sdk/reference/types/models/interfaces/ContainerRoute"
}
],
"contextual": {
Expand Down
15 changes: 11 additions & 4 deletions docs/mcp/home.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -373,10 +373,17 @@ List carriers supported by Terminal49 with their SCAC codes.

### `get_container_route`

Get detailed multi-leg routing with vessel itinerary.
Get a container's route: the ports in order with their arrival and departure times, and the vessel carrying the container while it is at sea.

The tool returns:
- `ports`: each port's sequence, label (`POL`, `TS1`, `POD`), name, country code, `inbound` ETA and ATA, and `outbound` ETD and ATD.
- `current_vessel`: name, IMO, voyage, position, heading, speed in knots, and the departure and arrival ports. It is `null` when the container is not at sea.
- `total_ports`: the number of ports on the route.

If Terminal49 has no route data for the container yet, the tool returns a `NoRouteData` result with a suggested alternative instead of an error.

<Warning>
This is a **paid feature**. If not enabled for your account, use `get_container_transport_events` for historical movement data instead.
This is a **paid feature**. If it is not enabled for your account, the tool returns a `FeatureNotEnabled` result. Use `get_container_transport_events` for historical movement data instead.

See [Entitlements and Paid Features](/api-docs/useful-info/entitlements) for the related Routing Data entitlement.
</Warning>
Expand All @@ -387,9 +394,9 @@ See [Entitlements and Paid Features](/api-docs/useful-info/entitlements) for the
**Good for**
- "What's the routing for this container?"
- "Which transshipment ports?"
- "What vessel is it on?"
- "What vessel is it on, and where is it now?"

**REST equivalent**: [GET /containers/{id}](/api-docs/api-reference/containers/get-a-container) (route data is included with the container)
**REST equivalent**: [GET /containers/{id}/map_geojson](/api-docs/api-reference/containers/get-container-map-geojson)

---

Expand Down
141 changes: 83 additions & 58 deletions docs/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -7489,63 +7489,6 @@
]
}
]
},
"patch": {
"summary": "Edit a container",
"operationId": "patch-containers-id",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/container"
}
}
}
}
}
}
},
"description": "Update a container",
"tags": [
"Containers"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"attributes",
"type"
],
"properties": {
"attributes": {
"type": "object",
"properties": {
"ref_numbers": {
"type": "array",
"items": {
"type": "string",
"example": "REF-12345"
}
}
}
}
}
}
}
}
}
}
}
}
},
"/containers/{id}": {
Expand Down Expand Up @@ -7734,6 +7677,73 @@
"description": "Comma delimited list of relations to include"
}
]
},
"patch": {
"summary": "Edit a container",
"operationId": "patch-containers-id",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/container"
}
}
}
}
}
}
},
"description": "Update a container",
"tags": [
"Containers"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"attributes",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"type": "string",
"enum": [
"container"
]
},
"attributes": {
"type": "object",
"properties": {
"ref_numbers": {
"type": "array",
"items": {
"type": "string",
"example": "REF-12345"
}
}
}
}
}
}
}
}
}
}
}
}
},
"/containers/{id}/raw_events": {
Expand Down Expand Up @@ -9811,9 +9821,16 @@
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"party"
]
},
"attributes": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -12110,9 +12127,16 @@
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"party"
]
},
"attributes": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -17170,7 +17194,8 @@
}
},
{
"type": "object"
"type": "object",
"additionalProperties": true
}
]
},
Expand Down
Loading
Loading