Edit a Shipment

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

Path Parameters

string

required

Shipment Id

Body

application/json

data

object

Response

200 - application/json

data

object

data.attributes

object

required

data.attributes.bill_of_lading_number

string

required

data.attributes.created_at

string

data.attributes.customer_name

string | null

data.attributes.destination_ata_at

string | null

data.attributes.destination_eta_at

string | null

data.attributes.destination_locode

string | null

UN/LOCODE

data.attributes.destination_name

string | null

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.attributes.normalized_number

string

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

data.attributes.pod_ata_at

string | null

data.attributes.pod_eta_at

string | null

data.attributes.pod_original_eta_at

string | null

data.attributes.pod_timezone

string | null

IANA tz

data.attributes.pod_vessel_imo

string | null

data.attributes.pod_vessel_name

string | null

data.attributes.pod_voyage_number

string | null

data.attributes.pol_atd_at

string | null

data.attributes.pol_etd_at

string | null

data.attributes.pol_timezone

string | null

IANA tz

data.attributes.port_of_discharge_locode

string | null

UN/LOCODE

data.attributes.port_of_discharge_name

string | null

data.attributes.port_of_lading_locode

string | null

UN/LOCODE

data.attributes.port_of_lading_name

string | null

data.attributes.ref_numbers

string[] | null

data.attributes.shipping_line_name

string

data.attributes.shipping_line_scac

string

data.attributes.shipping_line_short_name

string

data.attributes.tags

string[]

data.id

string

required

data.links

object

required

data.relationships

object

required

data.relationships.containers

object

data.relationships.destination

object

data.relationships.destination_terminal

object

data.relationships.line_tracking_stopped_by_user

object

data.relationships.pod_terminal

object

data.relationships.port_of_discharge

object

data.relationships.port_of_lading

object

data.type

enum<string>

required

Available options:

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

Body

Response