Edit a Container

Edit a container

curl --request PATCH \
  --url https://api.terminal49.com/v2/containers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "ref_numbers": [
        "REF-12345"
      ]
    }
  }
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "container",
    "attributes": {
      "number": "<string>",
      "ref_numbers": [
        "<string>"
      ],
      "equipment_type": "dry",
      "equipment_length": null,
      "equipment_height": "standard",
      "weight_in_lbs": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "seal_number": "<string>",
      "pickup_lfd": "2023-11-07T05:31:56Z",
      "pickup_appointment_at": "2023-11-07T05:31:56Z",
      "availability_known": true,
      "available_for_pickup": true,
      "pod_arrived_at": "2023-11-07T05:31:56Z",
      "pod_discharged_at": "2023-11-07T05:31:56Z",
      "pod_full_out_at": "2023-11-07T05:31:56Z",
      "terminal_checked_at": "2023-11-07T05:31:56Z",
      "pod_full_out_chassis_number": "<string>",
      "location_at_pod_terminal": "<string>",
      "final_destination_full_out_at": "2023-11-07T05:31:56Z",
      "empty_terminated_at": "2023-11-07T05:31:56Z",
      "holds_at_pod_terminal": [
        {
          "name": "<string>",
          "status": "pending",
          "description": "<string>"
        }
      ],
      "fees_at_pod_terminal": [
        {
          "type": "demurrage",
          "amount": 123,
          "currency_code": "USD"
        }
      ],
      "pod_timezone": "<string>",
      "final_destination_timezone": "<string>",
      "empty_terminated_timezone": "<string>",
      "pod_rail_carrier_scac": "<string>",
      "ind_rail_carrier_scac": "<string>",
      "pod_last_tracking_request_at": "2023-11-07T05:31:56Z",
      "shipment_last_tracking_request_at": "2023-11-07T05:31:56Z",
      "pod_rail_loaded_at": "2023-11-07T05:31:56Z",
      "pod_rail_departed_at": "2023-11-07T05:31:56Z",
      "ind_eta_at": "2023-11-07T05:31:56Z",
      "ind_ata_at": "2023-11-07T05:31:56Z",
      "ind_rail_unloaded_at": "2023-11-07T05:31:56Z",
      "ind_facility_lfd_on": "2023-11-07T05:31:56Z",
      "import_deadlines": {
        "pickup_lfd_terminal": "2023-11-07T05:31:56Z",
        "pickup_lfd_rail": "2023-11-07T05:31:56Z",
        "pickup_lfd_line": "2023-11-07T05:31:56Z"
      },
      "current_status": "new"
    },
    "relationships": {
      "shipment": {
        "data": {
          "id": "<string>",
          "type": "shipment"
        }
      },
      "pickup_facility": {
        "data": {
          "id": "<string>",
          "type": "terminal"
        }
      },
      "pod_terminal": {
        "data": {
          "id": "<string>",
          "type": "terminal"
        }
      },
      "transport_events": {
        "data": [
          {
            "id": "<string>",
            "type": "transport_event"
          }
        ]
      },
      "raw_events": {
        "data": [
          {
            "id": "<string>",
            "type": "raw_event"
          }
        ]
      }
    }
  }
}

PATCH

containers

Edit a container

curl --request PATCH \
  --url https://api.terminal49.com/v2/containers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "ref_numbers": [
        "REF-12345"
      ]
    }
  }
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "container",
    "attributes": {
      "number": "<string>",
      "ref_numbers": [
        "<string>"
      ],
      "equipment_type": "dry",
      "equipment_length": null,
      "equipment_height": "standard",
      "weight_in_lbs": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "seal_number": "<string>",
      "pickup_lfd": "2023-11-07T05:31:56Z",
      "pickup_appointment_at": "2023-11-07T05:31:56Z",
      "availability_known": true,
      "available_for_pickup": true,
      "pod_arrived_at": "2023-11-07T05:31:56Z",
      "pod_discharged_at": "2023-11-07T05:31:56Z",
      "pod_full_out_at": "2023-11-07T05:31:56Z",
      "terminal_checked_at": "2023-11-07T05:31:56Z",
      "pod_full_out_chassis_number": "<string>",
      "location_at_pod_terminal": "<string>",
      "final_destination_full_out_at": "2023-11-07T05:31:56Z",
      "empty_terminated_at": "2023-11-07T05:31:56Z",
      "holds_at_pod_terminal": [
        {
          "name": "<string>",
          "status": "pending",
          "description": "<string>"
        }
      ],
      "fees_at_pod_terminal": [
        {
          "type": "demurrage",
          "amount": 123,
          "currency_code": "USD"
        }
      ],
      "pod_timezone": "<string>",
      "final_destination_timezone": "<string>",
      "empty_terminated_timezone": "<string>",
      "pod_rail_carrier_scac": "<string>",
      "ind_rail_carrier_scac": "<string>",
      "pod_last_tracking_request_at": "2023-11-07T05:31:56Z",
      "shipment_last_tracking_request_at": "2023-11-07T05:31:56Z",
      "pod_rail_loaded_at": "2023-11-07T05:31:56Z",
      "pod_rail_departed_at": "2023-11-07T05:31:56Z",
      "ind_eta_at": "2023-11-07T05:31:56Z",
      "ind_ata_at": "2023-11-07T05:31:56Z",
      "ind_rail_unloaded_at": "2023-11-07T05:31:56Z",
      "ind_facility_lfd_on": "2023-11-07T05:31:56Z",
      "import_deadlines": {
        "pickup_lfd_terminal": "2023-11-07T05:31:56Z",
        "pickup_lfd_rail": "2023-11-07T05:31:56Z",
        "pickup_lfd_line": "2023-11-07T05:31:56Z"
      },
      "current_status": "new"
    },
    "relationships": {
      "shipment": {
        "data": {
          "id": "<string>",
          "type": "shipment"
        }
      },
      "pickup_facility": {
        "data": {
          "id": "<string>",
          "type": "terminal"
        }
      },
      "pod_terminal": {
        "data": {
          "id": "<string>",
          "type": "terminal"
        }
      },
      "transport_events": {
        "data": [
          {
            "id": "<string>",
            "type": "transport_event"
          }
        ]
      },
      "raw_events": {
        "data": [
          {
            "id": "<string>",
            "type": "raw_event"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

data

object

Show child attributes

data.attributes

object

required

Show child attributes

data.attributes.ref_numbers

string[]

Response

200 - application/json

data

Container model · object

Represents the equipment during a specific journey.

Show child attributes

data.id

string<uuid>

required

data.type

enum<string>

required

Available options:

container

data.attributes

object

required

Show child attributes

data.attributes.number

string

data.attributes.ref_numbers

string[]

data.attributes.equipment_type

enum<string> | null

Available options:

dry,

reefer,

open top,

flat rack,

bulk,

tank,

data.attributes.equipment_length

enum<integer> | null

Available options:

10,

20,

40,

45

data.attributes.equipment_height

enum<string> | null

Available options:

standard,

high_cube,

data.attributes.weight_in_lbs

number | null

data.attributes.created_at

string<date-time>

data.attributes.seal_number

string | null

data.attributes.pickup_lfd

string<date-time> | null

Coalesces import_deadlines values giving preference to pickup_lfd_line

data.attributes.pickup_appointment_at

string<date-time> | null

When available the pickup appointment time at the terminal is returned.

data.attributes.availability_known

boolean

Whether Terminal 49 is receiving availability status from the terminal.

data.attributes.available_for_pickup

boolean | null

If availability_known is true, then whether container is available to be picked up at terminal.

data.attributes.pod_arrived_at

string<date-time> | null

Time the vessel arrived at the POD

data.attributes.pod_discharged_at

string<date-time> | null

Discharge time at the port of discharge

data.attributes.pod_full_out_at

string<date-time> | null

Full Out time at port of discharge. Null for inland moves.

data.attributes.terminal_checked_at

string<date-time> | null

When the terminal was last checked.

data.attributes.pod_full_out_chassis_number

string | null

The chassis number used when container was picked up at POD (if available)

data.attributes.location_at_pod_terminal

string | null

Location at port of discharge terminal

data.attributes.final_destination_full_out_at

string<date-time> | null

Pickup time at final destination for inland moves.

data.attributes.empty_terminated_at

string<date-time> | null

Time empty container was returned.

data.attributes.holds_at_pod_terminal

terminal_hold · object[]

Show child attributes

data.attributes.holds_at_pod_terminal.name

string

required

data.attributes.holds_at_pod_terminal.status

enum<string>

required

Available options:

pending,

hold

data.attributes.holds_at_pod_terminal.description

string | null

Text description from the terminal (if any)

data.attributes.fees_at_pod_terminal

terminal_fee · object[]

Show child attributes

data.attributes.fees_at_pod_terminal.type

enum<string>

required

Available options:

demurrage,

exam,

extended_dwell_time,

other,

total

data.attributes.fees_at_pod_terminal.amount

number

required

The fee amount in local currency

data.attributes.fees_at_pod_terminal.currency_code

string

The ISO 4217 currency code of the fee is charged in. E.g. USD

Example:

"USD"

data.attributes.pod_timezone

string | null

IANA tz. Applies to attributes pod_arrived_at, pod_discharged_at, pickup_appointment_at, pod_full_out_at.

data.attributes.final_destination_timezone

string | null

IANA tz. Applies to attribute final_destination_full_out_at.

data.attributes.empty_terminated_timezone

string | null

IANA tz. Applies to attribute empty_terminated_at.

data.attributes.pod_rail_carrier_scac

string | null

The SCAC of the rail carrier for the pickup leg of the container's journey.(BETA)

data.attributes.ind_rail_carrier_scac

string | null

The SCAC of the rail carrier for the delivery leg of the container's journey.(BETA)

data.attributes.pod_last_tracking_request_at

string<date-time> | null

data.attributes.shipment_last_tracking_request_at

string<date-time> | null

data.attributes.pod_rail_loaded_at

string<date-time> | null

data.attributes.pod_rail_departed_at

string<date-time> | null

data.attributes.ind_eta_at

string<date-time> | null

data.attributes.ind_ata_at

string<date-time> | null

data.attributes.ind_rail_unloaded_at

string<date-time> | null

data.attributes.ind_facility_lfd_on

string<date-time> | null

deprecated

Please use import_deadlines.pickup_lfd_rail

data.attributes.import_deadlines

object

Import pickup deadlines for the container

Show child attributes

data.attributes.import_deadlines.pickup_lfd_terminal

string<date-time> | null

The last free day for pickup before demmurage accrues. Corresponding timezone is pod_timezone.

data.attributes.import_deadlines.pickup_lfd_rail

string<date-time> | null

The last free day for pickup before demmurage accrues. Corresponding timezone is final_destination_timezone.

data.attributes.import_deadlines.pickup_lfd_line

string<date-time> | null

The last free day as reported by the line. Corresponding timezone is final_destination_timezone or pod_timezone.

data.attributes.current_status

enum<string>

The current status of the container in its journey. Read guide to learn more.

Available options:

new,

on_ship,

available,

not_available,

grounded,

on_rail,

picked_up,

off_dock,

delivered,

dropped,

loaded,

empty_returned,

awaiting_inland_transfer

data.relationships

object

Show child attributes

data.relationships.shipment

object

Show child attributes

data.relationships.shipment.data

object

Show child attributes

data.relationships.shipment.data.id

string

data.relationships.shipment.data.type

enum<string>

Available options:

shipment

data.relationships.pickup_facility

object

Show child attributes

data.relationships.pickup_facility.data

object

Show child attributes

data.relationships.pickup_facility.data.id

string

data.relationships.pickup_facility.data.type

enum<string>

Available options:

terminal

data.relationships.pod_terminal

object

Show child attributes

data.relationships.pod_terminal.data

object

Show child attributes

data.relationships.pod_terminal.data.id

string

data.relationships.pod_terminal.data.type

enum<string>

Available options:

terminal

data.relationships.transport_events

object

Show child attributes

data.relationships.transport_events.data

object[]

Show child attributes

data.relationships.transport_events.data.id

string

data.relationships.transport_events.data.type

enum<string>

Available options:

transport_event

data.relationships.raw_events

object

Show child attributes

data.relationships.raw_events.data

object[]

Show child attributes

data.relationships.raw_events.data.id

string

data.relationships.raw_events.data.type

enum<string>

Available options:

raw_event

List containers Get a container

⌘I

Getting Started

In Depth Guides

Useful Info

Shipments

Tracking Requests

Webhooks

Webhook Notifications

Containers

Shipping Lines

Metro Areas

Ports

Vessels

Terminals

Parties

Authorizations

Body

Response