Terminal49

https://terminal49.com/docs/
Admin
Terminal49 is a shipment and container tracking platform that provides real-time visibility into...
Tokens:234,184
Snippets:418
Trust Score:9.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Webhook Notification Example (cURL)

Source: https://terminal49.com/docs/api-docs/api-reference/webhook-notifications/get-webhook-notification-payload-examples

This snippet demonstrates how to fetch an example payload for a webhook notification using cURL. It requires an API key for authentication and targets the /v2/webhook_notifications/examples endpoint. The output is a JSON object containing example notification data.

```curl
curl --request GET \
  --url https://api.terminal49.com/v2/webhook_notifications/examples \
  --header 'Authorization: <api-key>'
```

--------------------------------

### Initialize and Start Map (JavaScript)

Source: https://terminal49.com/docs/api-docs/in-depth-guides/terminal49-map

This JavaScript code demonstrates how to create a map instance using the `window.TntMap` class, providing the map container ID and an authentication token. It then starts the map initialization.

```javascript
const map = new window.TntMap("#map", {
  authToken: publishableApiKey,
});

await map.start();
```

--------------------------------

### GET /v2/webhook_notifications/examples

Source: https://terminal49.com/docs/api-docs/api-reference/webhook-notifications/get-webhook-notification-payload-examples

Retrieve examples of webhook notification payloads. This endpoint allows you to get sample data for various webhook events to understand the structure and content of the notifications you might receive.

```APIDOC
## GET /v2/webhook_notifications/examples

### Description
Retrieve examples of webhook notification payloads. This endpoint allows you to get sample data for various webhook events to understand the structure and content of the notifications you might receive.

### Method
GET

### Endpoint
https://api.terminal49.com/v2/webhook_notifications/examples

### Parameters
#### Query Parameters
- **event** (enum<string>) - Optional - The webhook notification event name you wish to see an example of. Available options include `container.transport.vessel_arrived`, `container.transport.vessel_discharged`, and many others.
Example: `"container.transport.full_out"`

#### Request Body
This endpoint does not accept a request body.

### Request Example
```curl
curl --request GET \
  --url https://api.terminal49.com/v2/webhook_notifications/examples \
  --header 'Authorization: <api-key>'
```

### Response
#### Success Response (200)
- **data** (array) - An array of webhook notification objects.
- **links** (object) - Pagination links.
- **meta** (object) - Metadata about the response, including size and total count.
- **included** (array) - An array of related resource objects, such as webhook configurations.

#### Response Example
```json
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "webhook_notification",
      "attributes": {
        "event": "container.transport.vessel_arrived",
        "delivery_status": "pending",
        "created_at": "<string>"
      },
      "relationships": {
        "webhook": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "webhook"
          }
        },
        "reference_object": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "tracking_request"
          }
        }
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "webhook",
      "attributes": {
        "url": "<string>",
        "active": true,
        "events": [
          "container.transport.vessel_arrived"
        ],
        "secret": "<string>",
        "headers": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ]
      }
    }
  ]
}
```

#### Authorizations
API key and secret are sent via the `Authorization` request header.
`Authorization: Token YOUR_API_KEY`
```

--------------------------------

### List Shipments - Example Response

Source: https://terminal49.com/docs/api-docs/api-reference/shipments/get-a-shipment

An example JSON response structure for listing shipments, detailing tracking information, availability, timezone data, and carrier SCAC codes.

```JSON
{
        "shipment_last_tracking_request_at": "2024-06-26T15:05:20Z",
        "availability_known": true,
        "pod_timezone": "America/New_York",
        "final_destination_timezone": "US/Eastern",
        "empty_terminated_timezone": "US/Eastern",
        "pod_rail_carrier_scac": "CSXT",
        "ind_rail_carrier_scac": "CSXT",
        "pod_rail_loaded_at": null,
        "pod_rail_departed_at": null,
        "ind_eta_at": null,
        "ind_ata_at": null,
        "ind_rail_unloaded_at": null,
        "ind_facility_lfd_on": null,
      "relationships": {
        "shipment": {
          "data": {
            "id": "02b1bd6f-407c-45bb-8645-06e7ee34e7e3",
            "type": "shipment"
          }
        },
        "pickup_facility": {
          "data": null
        },
        "pod_terminal": {
          "data": {
            "id": "b859f5c3-8515-41da-bf20-39c0a5ada887",
            "type": "terminal"
          }
        },
        "transport_events": {
          "data": [
            {
              "id": "45b542cb-332b-4684-b915-42e3a0759823",
              "type": "transport_event"
            },
            {
              "id": "174ed528-a1a9-4002-aef0-f2c9369199da",
              "type": "transport_event"
            },
            {
              "id": "7a2f30a6-a756-4c14-9477-fbfc1c7fe2f8",
              "type": "transport_event"
            },
            {
              "id": "e7365004-175a-46e8-96cd-dbed0f3daf21",
              "type": "transport_event"
            },
            {
              "id": "7c567bf3-7f01-4a3d-a176-eaa1f7165585",
              "type": "transport_event"
            }
          ]
        },
        "raw_events": {
          "data": [
            {
              "id": "2956f71c-bfb9-4e49-b9e2-1b4d53c74cac",
              "type": "raw_event"
            },
            {
              "id": "391e0eda-65b5-4fc3-a53d-25ecd9570259",
              "type": "raw_event"
            },
            {
              "id": "74810c04-6c8a-4194-8cff-52936584a965",
              "type": "raw_event"
            },
            {
              "id": "4b1500e2-b23b-4896-87bd-c38b1d16f385",
              "type": "raw_event"
            },
            {
              "id": "8b9a7d88-720a-4304-8c1e-a3336e39f481",
              "type": "raw_event"
            },
            {
              "id": "bf1f59c5-5dd8-4013-87f9-d7056bc87114",
              "type": "raw_event"
            }
          ]
        }
      }
    }
  ]
```

--------------------------------

### Refresh Container Response Example

Source: https://terminal49.com/docs/api-docs/api-reference/containers/refresh-container

This snippet shows an example JSON response when a container refresh request is successfully initiated. The response confirms the start of the refresh process for specified terminal services.

```JSON
{
  "message": "Started refresh for Shipping line, Terminal, Rail"
}
```

--------------------------------

### Map Initialization with DOM Element (JavaScript)

Source: https://terminal49.com/docs/api-docs/in-depth-guides/terminal49-map

This JavaScript example shows how to initialize the Terminal49 map by passing a DOM element reference obtained via `document.querySelector` instead of a CSS selector string.

```javascript
const element = document.querySelector("#map");
const map = new window.TntMap(element, {
  authToken: publishableApiKey,
});
```

--------------------------------

### Get Shipment Request Example

Source: https://terminal49.com/docs/api-docs/api-reference/shipments/edit-a-shipment

Example of how to request shipment details using the API. This involves specifying the shipment ID in the path.

```http
GET /shipments/{id}
Host: api.terminal49.com
Authorization: Token YOUR_API_TOKEN
```

--------------------------------

### GET /v2/containers

Source: https://terminal49.com/docs/api-docs/in-depth-guides/quickstart

Lists all tracked containers associated with your account.

```APIDOC
## GET /v2/containers

### Description
Lists all of your tracked containers. This provides an alternative level of tracking information.

### Method
GET

### Endpoint
https://api.terminal49.com/v2/containers

### Parameters
#### Headers
- **Content-Type** (string) - Required - `application/vnd.api+json`
- **Authorization** (string) - Required - `Token YOUR_API_KEY`

### Request Example
```json
{
  "method": "get",
  "url": "https://api.terminal49.com/v2/containers",
  "headers": {
    "Content-Type": "application/vnd.api+json",
    "Authorization": "Token YOUR_API_KEY"
  }
}
```

### Response
#### Success Response (200)
Details of tracked containers (response structure not provided in the input).

#### Response Example
(No example provided in the input text)
```

--------------------------------

### API Request Example (JSON)

Source: https://terminal49.com/docs/api-docs/api-reference/containers/list-containers

Example JSON structure for a successful API response, showing container data, included shipments, links for pagination, and metadata.

```json
{
  "data": [
    {
      "id": "9d19125a-2944-442c-8132-bf0d83670e5c",
      "type": "transport_event"
    },
    {
      "id": "b2ff0b47-3151-41e2-8c46-7f95cdbe4167",
      "type": "transport_event"
    },
    {
      "id": "e52feaa3-7a50-4570-a2ea-bf06f955ce23",
      "type": "transport_event"
    },
    {
      "id": "c56d95e5-774f-432c-b6f4-c53967f07292",
      "type": "transport_event"
    },
    {
      "id": "9b1d8b48-e870-46fa-bc46-10f9b30c64d4",
      "type": "transport_event"
    },
    {
      "id": "3e1d3571-6b24-4ad2-a071-4e70d59af521",
      "type": "transport_event"
    },
    {
      "id": "60f5eefe-13d5-4f85-9b65-d13b4c67115a",
      "type": "transport_event"
    }
  ],
  "included": [],
  "links": {
    "self": "https://api.terminal49.com/v2/containers?page[size]=5",
    "current": "https://api.terminal49.com/v2/containers?page[number]=1&page[size]=5",
    "next": "https://api.terminal49.com/v2/containers?page[number]=2&page[size]=5",
    "last": "https://api.terminal49.com/v2/containers?page[number]=11846&page[size]=5"
  },
  "meta": {
    "size": 5,
    "total": 59229
  }
}
```

--------------------------------

### GET /vessels/{id}/future_positions_with_coordinates

Source: https://terminal49.com/docs/api-docs/api-reference/vessels/get-vessel-future-positions-with-coordinates

Fetches future positions of a vessel given its ID and starting coordinates. This endpoint is useful for tracking vessel movements over time.

```APIDOC
## GET /vessels/{id}/future_positions_with_coordinates

### Description
Retrieves future positional data for a specific vessel, including its coordinates and estimated future path. This endpoint is crucial for logistics and maritime tracking applications.

### Method
GET

### Endpoint
/vessels/{id}/future_positions_with_coordinates

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the vessel.

#### Query Parameters
- **latitude** (number) - Required - The starting latitude coordinate for the position query.
- **longitude** (number) - Required - The starting longitude coordinate for the position query.
- **port_id** (string<uuid>) - Required - The destination port ID.
- **previous_port_id** (string<uuid>) - Required - The ID of the previous port.

### Request Example
```bash
curl --request GET \
  --url https://api.terminal49.com/v2/vessels/{id}/future_positions_with_coordinates?latitude=34.0522&longitude=-118.2437&port_id=your_port_id&previous_port_id=your_previous_port_id \
  --header 'Authorization: <api-key>'
```

### Response
#### Success Response (200)
- **data** (object) - Contains the vessel's current and future positional information.
  - **id** (string) - The vessel's unique identifier.
  - **type** (string) - The resource type, 'vessel'.
  - **attributes** (object) - Contains detailed attributes of the vessel.
    - **name** (string) - The name of the vessel.
    - **imo** (string) - The vessel's IMO number.
    - **mmsi** (string) - The vessel's MMSI number.
    - **latitude** (number) - The current latitude of the vessel.
    - **longitude** (number) - The current longitude of the vessel.
    - **nautical_speed_knots** (number) - The current speed of the vessel in nautical knots.
    - **navigational_heading_degrees** (number) - The current navigational heading in degrees.
    - **position_timestamp** (string) - The timestamp of the last known position.
    - **positions** (array) - An array of future estimated positions.
      - **latitude** (number) - The estimated latitude.
      - **longitude** (number) - The estimated longitude.
      - **heading** (number) - The estimated heading.
      - **timestamp** (string) - The estimated timestamp for the position.
      - **estimated** (boolean) - Indicates if the position is an estimate.
- **links** (object) - Contains links related to the vessel data.
  - **self** (string) - A link to the self-resource.

#### Response Example
```json
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "vessel",
    "attributes": {
      "name": "Example Vessel",
      "imo": "9123456",
      "mmsi": "123456789",
      "latitude": 34.0522,
      "longitude": -118.2437,
      "nautical_speed_knots": 15,
      "navigational_heading_degrees": 180,
      "position_timestamp": "2023-11-07T05:31:56Z",
      "positions": [
        {
          "latitude": 34.1000,
          "longitude": -118.3000,
          "heading": 175,
          "timestamp": "2023-11-07T06:00:00Z",
          "estimated": true
        }
      ]
    }
  },
  "links": {
    "self": "https://api.terminal49.com/v2/vessels/3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
```

#### Error Responses
- **403** - Forbidden: Indicates that the API key is invalid or lacks the necessary permissions.
```

--------------------------------

### Party Creation Response (JSON)

Source: https://terminal49.com/docs/api-docs/api-reference/parties/create-a-party

This is an example of a successful JSON response when a party is created via the Terminal49 API. It includes the unique ID, type, attributes of the created party, and a link to the resource.

```json
{
  "data": {
    "id": "ba4cb904-827f-4038-8e31-1e92b3356218",
    "type": "party",
    "attributes": {
      "company_name": "COMPANY NAME"
    }
  },
  "links": {
    "self": "/v2/parties/ba4cb904-827f-4038-8e31-1e92b3356218"
  }
}
```

--------------------------------

### POST /v2/parties

Source: https://terminal49.com/docs/api-docs/api-reference/parties/create-a-party

Creates a new party in the system. Requires authentication via an API key in the Authorization header.

```APIDOC
## POST /v2/parties

### Description
Creates a new party by sending party details in the request body.

### Method
POST

### Endpoint
https://api.terminal49.com/v2/parties

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - API key for authentication, format: `Token YOUR_API_TOKEN`
- **Content-Type** (string) - Required - `application/json`

#### Request Body
- **data** (object) - Required
  - **attributes** (object) - Required
    - **company_name** (string) - Required - The name of the company for the party.

### Request Example
```json
{
  "data": {
    "attributes": {
      "company_name": "COMPANY NAME"
    }
  }
}
```

### Response
#### Success Response (201)
- **data** (object) - Contains the created party details.
  - **id** (string) - The unique identifier for the party.
  - **type** (string) - The type of the resource, always "party".
  - **attributes** (object) - The attributes of the created party.
    - **company_name** (string) - The name of the company.
- **links** (object) - Contains links related to the party.
  - **self** (string) - The URL of the created party.

#### Response Example
```json
{
  "data": {
    "id": "ba4cb904-827f-4038-8e31-1e92b3356218",
    "type": "party",
    "attributes": {
      "company_name": "COMPANY NAME"
    }
  },
  "links": {
    "self": "/v2/parties/ba4cb904-827f-4038-8e31-1e92b3356218"
  }
}
```

#### Error Response (422)
- Unprocessable Entity: Indicates issues with the request payload.
```

--------------------------------

### Create Party using cURL

Source: https://terminal49.com/docs/api-docs/api-reference/parties/create-a-party

This snippet demonstrates how to create a new party using a cURL request. It specifies the POST method, the API endpoint, and includes the necessary Authorization and Content-Type headers, along with a JSON payload containing the company name.

```bash
curl --request POST \
  --url https://api.terminal49.com/v2/parties \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{ \
  "data": { \
    "attributes": { \
      "company_name": "COMPANY NAME" \
    } \
  } \
}'
```

--------------------------------

### Tracking Request Response Example (JSON)

Source: https://terminal49.com/docs/api-docs/api-reference/tracking-requests/get-a-single-tracking-request

This is an example of a successful JSON response from the Terminal49 API when retrieving a tracking request. It details the request's attributes, status, and relationships, including embedded shipment information with ports, vessel details, and timestamps.

```JSON
{
  "data": {
    "id": "ba4cb904-827f-4038-8e31-1e92b3356218",
    "type": "tracking_request",
    "attributes": {
      "request_number": "MEDUFR030802",
      "request_type": "bill_of_lading",
      "scac": "MSCU",
      "ref_numbers": [],
      "created_at": "2020-04-04T16:13:35-07:00",
      "updated_at": "2020-04-04T17:13:35-07:00",
      "status": "created",
      "failed_reason": null
    },
    "relationships": {
      "tracked_object": {
        "data": {
          "id": "eb6f218a-0b4a-47f9-8ef9-759aa5e0ea83",
          "type": "shipment"
        }
      }
    },
    "links": {
      "self": "/v2/tracking_requests/ba4cb904-827f-4038-8e31-1e92b3356218"
    }
  },
  "included": [
    {
      "id": "eb6f218a-0b4a-47f9-8ef9-759aa5e0ea83",
      "type": "shipment",
      "attributes": {
        "created_at": "2020-04-04T16:13:37-07:00",
        "bill_of_lading_number": "MEDUFR030802",
        "ref_numbers": [],
        "shipping_line_scac": "MSCU",
        "shipping_line_name": "Mediterranean Shipping Company",
        "port_of_lading_locode": "FRFOS",
        "port_of_lading_name": "Fos-Sur-Mer",
        "port_of_discharge_locode": "USOAK",
        "port_of_discharge_name": "Oakland",
        "pod_vessel_name": "MSC ALGECIRAS",
        "pod_vessel_imo": "9605243",
        "pod_voyage_number": "920A",
        "destination_locode": "USOAK",
        "destination_name": "Oakland",
        "destination_timezone": "America/Los_Angeles",
        "destination_ata_at": "2019-06-21T18:46:00-07:00",
        "destination_eta_at": null,
        "pol_etd_at": null,
        "pol_atd_at": "2019-05-24T03:00:00-07:00",
        "pol_timezone": "Europe/Paris",
        "pod_eta_at": null,
        "pod_ata_at": "2019-06-21T18:46:00-07:00",
        "pod_timezone": "America/Los_Angeles"
      },
      "relationships": {
        "port_of_lading": {
          "data": {
            "id": "6d8c6c29-72a6-49ad-87b7-fd045f202212",
            "type": "port"
          }
        },
        "port_of_discharge": {
          "data": {
            "id": "42d1ba3a-f4b8-431d-a6fe-49fd748a59e7",
            "type": "port"
          }
        },
        "pod_terminal": {
          "data": null
        },
        "destination": {
          "data": {
            "id": "42d1ba3a-f4b8-431d-a6fe-49fd748a59e7",
            "type": "port"
          }
        },
        "containers": {
          "data": [
            {
              "id": "11c1fa10-52a5-48e2-82f4-5523756b3d0f",
              "type": "container"
            }
          ]
        }
      },
      "links": {
        "self": "/v2/shipments/eb6f218a-0b4a-47f9-8ef9-759aa5e0ea83"
      }
    }
  ]
}
```

--------------------------------

### Traversing Relationships

Source: https://terminal49.com/docs/api-docs/in-depth-guides/including-resources

Demonstrates how to traverse nested relationships by chaining relationship names with dots in the 'include' query parameter. For example, to get the port of lading for a container's shipment.

```APIDOC
## GET /containers/{id}

### Description
Retrieves a specific container and allows for traversing nested relationships, such as accessing the 'port_of_lading' of a container's associated 'shipment'.

### Method
GET

### Endpoint
/containers/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the container.

#### Query Parameters
- **include** (string) - Optional - A comma-delimited list of relationships to include, allowing for nested traversal (e.g., "shipment,shipment.port_of_lading").

### Request Example
```
GET /containers/12345?include=shipment,shipment.port_of_lading
```

### Response
#### Success Response (200)
- **data** (object) - Contains the container information and a `relationships` object.
- **data.relationships.shipment.data.relationships.port_of_lading** (object) - Information about the port of lading for the shipment.

#### Response Example
```json
{
  "data": {
    "id": "12345",
    "type": "container",
    "attributes": {
      "name": "Container XYZ"
    },
    "relationships": {
      "shipment": {
        "data": {
          "id": "shipment-abc",
          "type": "shipment",
          "relationships": {
            "port_of_lading": {
              "data": {
                "id": "pol-789",
                "type": "port"
              }
            }
          }
        }
      }
    }
  }
}
```
```

--------------------------------

### List Webhook Notifications

Source: https://terminal49.com/docs/api-docs/api-reference/webhook-notifications/get-webhook-notification-payload-examples

Retrieves a list of webhook notifications for the specified project.

```APIDOC
## GET /websites/terminal49/webhooks

### Description
Retrieves a list of webhook notifications associated with the terminal49 website.

### Method
GET

### Endpoint
/websites/terminal49/webhooks

### Parameters

#### Query Parameters
- **limit** (integer) - Optional - The maximum number of notifications to return.
- **offset** (integer) - Optional - The number of notifications to skip.

#### Request Body
None

### Response
#### Success Response (200)
- **data** (webhook_notification[]) - An array of webhook notification objects.
  - **links** (object) - Contains links for pagination and related resources.
  - **meta** (object) - Contains metadata about the response.
  - **included** (array) - Optional. An array of included related objects, which can be of types: webhook, Tracking Request, Transport Event Model, or Estimated Event Model.

#### Response Example
```json
{
  "data": [
    {
      "type": "webhook_notification",
      "id": "wn_abc123",
      "attributes": { ... },
      "relationships": { ... }
    }
  ],
  "links": {
    "self": "/websites/terminal49/webhooks?limit=10",
    "next": "/websites/terminal49/webhooks?limit=10&offset=10"
  },
  "meta": {
    "count": 50
  },
  "included": [
    {
      "type": "webhook",
      "id": "wh_xyz789",
      "attributes": { ... }
    }
  ]
}
```
```

--------------------------------

### Create Webhook using cURL

Source: https://terminal49.com/docs/api-docs/api-reference/webhooks/create-a-webhook

This cURL command demonstrates how to create a new webhook subscription with a specified URL and a list of events to monitor. It requires an API key for authorization and sends the webhook configuration in JSON format.

```cURL
curl --request POST \
  --url https://api.terminal49.com/v2/webhooks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{ \
  "data": { \
    "attributes": { \
      "url": "https://webhook.site/", \
      "events": [ \
        "container.transport.vessel_arrived", \
        "container.transport.vessel_discharged", \
        "container.transport.vessel_loaded", \
        "container.transport.vessel_departed", \
        "container.transport.rail_departed", \
        "container.transport.rail_arrived", \
        "container.transport.rail_loaded", \
        "container.transport.rail_unloaded", \
        "container.transport.transshipment_arrived", \
        "container.transport.transshipment_discharged", \
        "container.transport.transshipment_loaded", \
        "container.transport.transshipment_departed", \
        "container.transport.feeder_arrived", \
        "container.transport.feeder_discharged", \
        "container.transport.feeder_loaded", \
        "container.transport.feeder_departed", \
        "container.transport.empty_out", \
        "container.transport.full_in", \
        "container.transport.full_out", \
        "container.transport.empty_in", \
        "container.transport.vessel_berthed", \
        "shipment.estimated.arrival", \
        "tracking_request.succeeded", \
        "tracking_request.failed", \
        "tracking_request.awaiting_manifest", \
        "tracking_request.tracking_stopped", \
        "container.created", \
        "container.updated", \
        "container.pod_terminal_changed", \
        "container.transport.arrived_at_inland_destination", \
        "container.transport.estimated.arrived_at_inland_destination", \
        "container.pickup_lfd.changed", \
        "container.transport.available" \
      ], \
      "active": true \
    }, \
    "type": "webhook" \
  } \
}'
```

--------------------------------

### Map Integration with Module Type (JavaScript)

Source: https://terminal49.com/docs/api-docs/in-depth-guides/terminal49-map

This JavaScript code utilizes the 'module' attribute for the script tag, enabling top-level async/await for map initialization, starting, and data loading.

```javascript
<script type="module">
  const map = new window.TntMap("#map", {
    authToken: publishableApiKey,
  });

  await map.start();
  await map.load(shipmentId, containerId);
</script>
```

--------------------------------

### Complete Map Integration (JavaScript)

Source: https://terminal49.com/docs/api-docs/in-depth-guides/terminal49-map

This combined JavaScript code initializes the map, starts it, and loads specific shipment and container data. It assumes `publishableApiKey`, `shipmentId`, and `containerId` are defined.

```javascript
const map = new window.TntMap("#map", {
  authToken: publishableApiKey,
});

await map.start();
await map.load(shipmentId, containerId);
```

--------------------------------

### GET /v2/shipments

Source: https://terminal49.com/docs/api-docs/in-depth-guides/quickstart

Lists all tracked shipments associated with your account.

```APIDOC
## GET /v2/shipments

### Description
Lists all of your tracked shipments. This endpoint can be used after a tracking request has been successfully processed.

### Method
GET

### Endpoint
https://api.terminal49.com/v2/shipments

### Parameters
#### Headers
- **Content-Type** (string) - Required - `application/vnd.api+json`
- **Authorization** (string) - Required - `Token YOUR_API_KEY`

### Request Example
```json
{
  "method": "get",
  "url": "https://api.terminal49.com/v2/shipments",
  "headers": {
    "Content-Type": "application/vnd.api+json",
    "Authorization": "Token YOUR_API_KEY"
  }
}
```

### Response
#### Success Response (200)
Details of tracked shipments (response structure not provided in the input).

#### Response Example
(No example provided in the input text)
```

--------------------------------

### Container Update Changeset Example

Source: https://terminal49.com/docs/api-docs/in-depth-guides/webhooks

Demonstrates the `changeset` attribute within a `container.updated` event, illustrating how property changes are recorded. The example shows a change in the `pickup_lfd` property from null to a specific date.

```json
{
  "changeset": {
    "pickup_lfd": [null, "2020-05-20 00:00:00"]
  }
}
```

--------------------------------

### Create a party (POST)

Source: https://terminal49.com/docs/api-docs/in-depth-guides/adding-customer

Creates a new party associated with your account. This party can then be linked to tracking requests. The response provides the unique ID for the newly created party.

```json
{
  "data": {
    "type": "party",
    "attributes": {
      "company_name": "COMPANY NAME"
    }
  }
}
```

--------------------------------

### List Tracked Shipments

Source: https://terminal49.com/docs/api-docs/getting-started/list-shipments-and-containers

This example demonstrates how to list tracked shipments using Google Apps Script. It makes a GET request to the /v2/shipments endpoint and parses the JSON response to extract shipment details.

```APIDOC
## GET /v2/shipments

### Description
Retrieves a list of all tracked shipments.

### Method
GET

### Endpoint
https://api.terminal49.com/v2/shipments

### Headers
- **Content-Type**: application/vnd.api+json
- **Authorization**: Token YOUR_API_KEY

### Response
#### Success Response (200)
- **data** (array) - An array of shipment objects.
  - **id** (string) - The unique identifier for the shipment.
  - **attributes** (object) - Contains details about the shipment:
    - **shipping_line_scac** (string) - SCAC code of the shipping line.
    - **shipping_line_name** (string) - Name of the shipping line.
    - **bill_of_lading_number** (string) - Bill of Lading number.
    - **pod_vessel_name** (string) - Name of the vessel at the port of discharge.
    - **port_of_lading_name** (string) - Name of the port of lading.
    - **pol_etd_at** (string) - Estimated time of departure from the port of lading.
    - **pol_atd_at** (string) - Actual time of departure from the port of lading.
    - **port_of_discharge_name** (string) - Name of the port of discharge.
    - **pod_eta_at** (string) - Estimated time of arrival at the port of discharge.
    - **pod_ata_at** (string) - Actual time of arrival at the port of discharge.
  - **relationships** (object) - Contains relationships to other resources:
    - **containers** (object)
      - **data** (array) - An array of container objects associated with the shipment.

### Request Example
```javascript
function listTrackedShipments(){
  var options = {
    "method" : "GET",
    "headers" : {
      "content-type": "application/vnd.api+json",
      "authorization" : "Token YOUR_API_KEY"
    },
      "payload" : ""
   };
  try {
    var response = UrlFetchApp.fetch("https://api.terminal49.com/v2/shipments", options);
    var json = response.getContentText();
    var shipments = JSON.parse(json)["data"];
    var shipment_values = [];
    shipment_values = extractShipmentValues(shipments);
    listShipmentValues(shipment_values);
  } catch (error){
    Logger.log("error communicating with t49 / shipments: " + error);
  }
}
```

### Response Example
```json
{
  "data": [
    {
      "id": "shipment_id_1",
      "type": "shipment",
      "attributes": {
        "shipping_line_scac": "MAEU",
        "shipping_line_name": "Maersk Line",
        "bill_of_lading_number": "MAEU12345678",
        "pod_vessel_name": "Vessel Explorer",
        "port_of_lading_name": "Port of Shanghai",
        "pol_etd_at": "2023-10-26T10:00:00Z",
        "pol_atd_at": "2023-10-26T11:30:00Z",
        "port_of_discharge_name": "Port of Los Angeles",
        "pod_eta_at": "2023-11-15T08:00:00Z",
        "pod_ata_at": "2023-11-14T20:00:00Z"
      },
      "relationships": {
        "containers": {
          "data": [
            { "id": "container_id_1", "type": "container" },
            { "id": "container_id_2", "type": "container" }
          ]
        }
      }
    }
  ]
}
```
```

--------------------------------

### Map Integration with IIFE (JavaScript)

Source: https://terminal49.com/docs/api-docs/in-depth-guides/terminal49-map

This JavaScript code uses an Immediately Invoked Function Expression (IIFE) to encapsulate the map initialization, start, and data loading process. This pattern is useful for browser environments.

```javascript
<script>
  (async () => {
    const map = new window.TntMap("#map", {
      authToken: publishableApiKey,
    });

    await map.start();
    await map.load(shipmentId, containerId);
  })();
</script>
```

--------------------------------

### Create Test Webhook Endpoint

Source: https://terminal49.com/docs/api-docs/api-reference/webhooks/create-a-webhook

Allows the creation of a test webhook endpoint for a specific project. Upon successful creation, it returns a 201 status code and the details of the created webhook.

```APIDOC
## POST /websites/terminal49/webhooks

### Description
Creates a test webhook endpoint for the specified project.

### Method
POST

### Endpoint
/websites/terminal49/webhooks

### Parameters
#### Request Body
- **data** (object) - Required - Contains the data for the webhook.

### Request Example
```json
{
  "data": {}
}
```

### Response
#### Success Response (201)
- **data** (object) - Details of the created webhook.

#### Response Example
```json
{
  "data": {
    "id": "wh_12345",
    "url": "https://example.com/webhook",
    "project_id": "proj_abcde",
    "created_at": "2023-10-27T10:00:00Z"
  }
}
```
```

--------------------------------

### Example JSON Response for Transport Events

Source: https://terminal49.com/docs/api-docs/api-reference/containers/get-a-containers-transport-events

Illustrates a sample JSON response containing a list of transport events for a container. Each event includes attributes like event type, timestamps, location, and relationships to other entities such as shipments and vessels.

```json
{
  "data": [
    {
      "id": "68c3c29a-504a-4dbb-ad27-7194ef42d484",
      "type": "transport_event",
      "attributes": {
        "event": "container.transport.vessel_discharged",
        "created_at": "2020-05-14T00:05:41Z",
        "voyage_number": "15W10",
        "timestamp": "2020-04-13T00:00:00Z",
        "location_locode": "USOAK",
        "timezone": "America/Los_Angeles"
      },
      "relationships": {
        "shipment": {
          "data": {
            "id": "06264731-503e-498e-bc76-f90b87b31562",
            "type": "shipment"
          }
        },
        "container": {
          "data": {
            "id": "eeafd337-72b5-4e5c-87cb-9ef83fa99cf4",
            "type": "container"
          }
        },
        "vessel": {
          "data": {
            "id": "345c05ab-4217-4ffe-a1a4-6c03b9ad2b36",
            "type": "vessel"
          }
        },
        "location": {
          "data": {
            "id": "42d1ba3a-f4b8-431d-a6fe-49fd748a59e7",
            "type": "port"
          }
        },
        "terminal": {
          "data": {
            "id": "3e550f0e-ac2a-48fb-b242-5be45ecf2c78",
            "type": "terminal"
          }
        }
      }
    },
    {
      "id": "03349405-a9be-4f3e-abde-28f2cb3922bd",
      "type": "transport_event",
      "attributes": {
        "event": "container.transport.vessel_arrived",
        "created_at": "2020-05-14T00:05:41Z",
        "voyage_number": "15W10",
        "timestamp": "2020-04-13T01:24:00Z",
        "location_locode": "USOAK",
        "timezone": "America/Los_Angeles"
      },
      "relationships": {
        "shipment": {
          "data": {
            "id": "06264731-503e-498e-bc76-f90b87b31562",
            "type": "shipment"
          }
        },
        "container": {
          "data": {
            "id": "eeafd337-72b5-4e5c-87cb-9ef83fa99cf4",
            "type": "container"
          }
        },
        "vessel": {
          "data": {
            "id": "345c05ab-4217-4ffe-a1a4-6c03b9ad2b36",
            "type": "vessel"
          }
        },
        "location": {
          "data": {
            "id": "42d1ba3a-f4b8-431d-a6fe-49fd748a59e7",
            "type": "port"
          }
        },
        "terminal": {
          "data": {
            "id": "3e550f0e-ac2a-48fb-b242-5be45ecf2c78",
            "type": "terminal"
          }
        }
      }
    },
    {
      "id": "ba9f85b4-658d-4f23-9308-635964df8037",
      "type": "transport_event",
      "attributes": {
        "event": "container.transport.empty_in",
        "created_at": "2020-05-14T00:05:42Z",
        "voyage_number": null,
        "timestamp": "2020-04-15T00:00:00Z",
        "location_locode": null,
        "timezone": null
      },
      "relationships": {
        "shipment": {
          "data": {
            "id": "06264731-503e-498e-bc76-f90b87b31562",
            "type": "shipment"
          }
        },
        "container": {
          "data": {
            "id": "eeafd337-72b5-4e5c-87cb-9ef83fa99cf4",
            "type": "container"
          }
        },
        "vessel": {
          "data": null
        },
        "location": {
          "data": null
        },
        "terminal": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "self": "https://api.terminal49.com/v2/containers/eeafd337-72b5-4e5c-87cb-9ef83fa99cf4/transport_events",
    "current": "https://api.terminal49.com/v2/containers/eeafd337-72b5-4e5c-87cb-9ef83fa99cf4/transport_events?page[number]=1"
  }
}
```

--------------------------------

### Truck Movement Event Data Structure

Source: https://terminal49.com/docs/api-docs/api-reference/containers/get-a-containers-raw-events

Represents a raw event data entry for truck movement activities like 'full_out' or 'empty_in'. Lacks vessel or location specific data in these examples. 'data': null indicates no specific vessel or location data.

```json
{
  "id": "50f11e4f-411e-48e2-8141-64226500df9c",
  "type": "raw_event",
  "attributes": {
    "timestamp": "2020-04-14T00:00:00Z",
    "estimated": false,
    "actual_on": "2020-04-14",
    "estimated_at": null,
    "actual_at": null,
    "event": "full_out",
    "index": 10,
    "original_event": "Truck Departure from",
    "created_at": "2020-04-18T00:18:27Z",
    "voyage_number": null,
    "location_name": null,
    "location_locode": null,
    "vessel_name": null,
    "vessel_imo": null,
    "timezone": null
  },
  "relationships": {
    "location": {
      "data": null
    },
    "vessel": {
      "data": null
    }
  }
}
```
Tokens:
Raw