Get a Shipment

GET

shipments

{id}

Authorizations

Authorization

string

headerrequired

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

string

required

Shipment Id

Query Parameters

include

string

Comma delimited list of relations to include

Response

200 - application/json

data

object

data.id

string

required

data.relationships

object

required

data.relationships.destination

object

data.relationships.port_of_lading

object

data.relationships.containers

object

data.relationships.port_of_discharge

object

data.relationships.pod_terminal

object

data.relationships.destination_terminal

object

data.relationships.line_tracking_stopped_by_user

object

data.attributes

object

required

data.attributes.bill_of_lading_number

string

required

data.attributes.normalized_number

string

The normalized version of the shipment number used for querying the carrier

data.attributes.ref_numbers

string[] | null

data.attributes.created_at

string

data.attributes.tags

string[]

data.attributes.port_of_lading_locode

string | null

UN/LOCODE

data.attributes.port_of_lading_name

string | null

data.attributes.port_of_discharge_locode

string | null

UN/LOCODE

data.attributes.port_of_discharge_name

string | null

data.attributes.destination_locode

string | null

UN/LOCODE

data.attributes.destination_name

string | null

data.attributes.shipping_line_scac

string

data.attributes.shipping_line_name

string

data.attributes.shipping_line_short_name

string

data.attributes.customer_name

string | null

data.attributes.pod_vessel_name

string | null

data.attributes.pod_vessel_imo

string | null

data.attributes.pod_voyage_number

string | null

data.attributes.pol_etd_at

string | null

data.attributes.pol_atd_at

string | null

data.attributes.pod_eta_at

string | null

data.attributes.pod_original_eta_at

string | null

data.attributes.pod_ata_at

string | null

data.attributes.destination_eta_at

string | null

data.attributes.destination_ata_at

string | null

data.attributes.pol_timezone

string | null

IANA tz

data.attributes.pod_timezone

string | null

IANA tz

data.attributes.destination_timezone

string | null

IANA tz

data.attributes.line_tracking_last_attempted_at

string | null

When Terminal49 last tried to update the shipment status from the shipping line

data.attributes.line_tracking_last_succeeded_at

string | null

When Terminal49 last successfully updated the shipment status from the shipping line

data.attributes.line_tracking_stopped_at

string | null

When Terminal49 stopped checking at the shipping line

data.attributes.line_tracking_stopped_reason

enum<string> | null

The reason Terminal49 stopped checking

Available options:

all_containers_terminated,

past_arrival_window,

no_updates_at_line,

cancelled_by_user,

booking_cancelled

data.type

enum<string>

required

Available options:

shipment

data.links

object

required

included

object[]

included.id

string

required

included.type

enum<string>

required

Available options:

container

included.attributes

object

required

included.attributes.number

string

included.attributes.ref_numbers

string[]

included.attributes.equipment_type

enum<string> | null

Available options:

dry,

reefer,

open top,

flat rack,

bulk,

tank

included.attributes.equipment_length

enum<integer> | null

Available options:

10,

20,

40,

45

included.attributes.equipment_height

enum<string> | null

Available options:

standard,

high_cube

included.attributes.weight_in_lbs

number | null

included.attributes.created_at

string

included.attributes.seal_number

string | null

included.attributes.pickup_lfd

string | null

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

included.attributes.pickup_appointment_at

string | null

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

included.attributes.availability_known

boolean

Whether Terminal 49 is receiving availability status from the terminal.

included.attributes.available_for_pickup

boolean | null

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

included.attributes.pod_arrived_at

string | null

Time the vessel arrived at the POD

included.attributes.pod_discharged_at

string | null

Discharge time at the port of discharge

included.attributes.pod_full_out_at

string | null

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

included.attributes.terminal_checked_at

string | null

When the terminal was last checked.

included.attributes.pod_full_out_chassis_number

string | null

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

included.attributes.location_at_pod_terminal

string | null

Location at port of discharge terminal

included.attributes.final_destination_full_out_at

string | null

Pickup time at final destination for inland moves.

included.attributes.empty_terminated_at

string | null

Time empty container was returned.

included.attributes.holds_at_pod_terminal

object[]

included.attributes.fees_at_pod_terminal

object[]

included.attributes.pod_timezone

string | null

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

included.attributes.final_destination_timezone

string | null

IANA tz. Applies to attribute final_destination_full_out_at.

included.attributes.empty_terminated_timezone

string | null

IANA tz. Applies to attribute empty_terminated_at.

included.attributes.pod_rail_carrier_scac

string | null

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

included.attributes.ind_rail_carrier_scac

string | null

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

included.attributes.pod_last_tracking_request_at

string | null

included.attributes.shipment_last_tracking_request_at

string | null

included.attributes.pod_rail_loaded_at

string | null

included.attributes.pod_rail_departed_at

string | null

included.attributes.ind_eta_at

string | null

included.attributes.ind_ata_at

string | null

included.attributes.ind_rail_unloaded_at

string | null

included.attributes.ind_facility_lfd_on

string | null

included.relationships

object

Was this page helpful?

List shipments Edit a shipment

Getting Started

In Depth Guides

Useful Info

Shipments

Tracking Requests

Tracking requests

Webhooks

Webhook Notifications

Containers

Shipping Lines

Metro Areas

Ports

Vessels

Terminals

Authorizations

Path Parameters

Query Parameters

Response