Edit a Shipment

Edit a shipment

curl --request PATCH \
  --url https://api.terminal49.com/v2/shipments/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "ref_numbers": [
        "REFNUMBER10"
      ],
      "shipment_tags": [
        "tag1, tag2"
      ]
    }
  }
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "relationships": {
      "destination": {
        "data": {
          "type": "port",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "port_of_lading": {
        "data": {
          "type": "port",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "containers": {
        "data": [
          {
            "type": "container",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      },
      "port_of_discharge": {
        "data": {
          "type": "port",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "pod_terminal": {
        "data": {
          "type": "terminal",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "destination_terminal": {
        "data": {
          "type": "terminal",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "line_tracking_stopped_by_user": {
        "data": {
          "type": "user",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    },
    "attributes": {
      "bill_of_lading_number": "<string>",
      "normalized_number": "<string>",
      "ref_numbers": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "tags": [
        "<string>"
      ],
      "port_of_lading_locode": "<string>",
      "port_of_lading_name": "<string>",
      "port_of_discharge_locode": "<string>",
      "port_of_discharge_name": "<string>",
      "destination_locode": "<string>",
      "destination_name": "<string>",
      "shipping_line_scac": "<string>",
      "shipping_line_name": "<string>",
      "shipping_line_short_name": "<string>",
      "customer_name": "<string>",
      "pod_vessel_name": "<string>",
      "pod_vessel_imo": "<string>",
      "pod_voyage_number": "<string>",
      "pol_etd_at": "2023-11-07T05:31:56Z",
      "pol_atd_at": "2023-11-07T05:31:56Z",
      "pod_eta_at": "2023-11-07T05:31:56Z",
      "pod_original_eta_at": "2023-11-07T05:31:56Z",
      "pod_ata_at": "2023-11-07T05:31:56Z",
      "destination_eta_at": "2023-11-07T05:31:56Z",
      "destination_ata_at": "2023-11-07T05:31:56Z",
      "pol_timezone": "<string>",
      "pod_timezone": "<string>",
      "destination_timezone": "<string>",
      "line_tracking_last_attempted_at": "2023-11-07T05:31:56Z",
      "line_tracking_last_succeeded_at": "2023-11-07T05:31:56Z",
      "line_tracking_stopped_at": "2023-11-07T05:31:56Z",
      "line_tracking_stopped_reason": "all_containers_terminated"
    },
    "type": "shipment",
    "links": {
      "self": "<string>"
    }
  }
}

PATCH

shipments

{id}

Edit a shipment

curl --request PATCH \
  --url https://api.terminal49.com/v2/shipments/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "ref_numbers": [
        "REFNUMBER10"
      ],
      "shipment_tags": [
        "tag1, tag2"
      ]
    }
  }
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "relationships": {
      "destination": {
        "data": {
          "type": "port",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "port_of_lading": {
        "data": {
          "type": "port",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "containers": {
        "data": [
          {
            "type": "container",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      },
      "port_of_discharge": {
        "data": {
          "type": "port",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "pod_terminal": {
        "data": {
          "type": "terminal",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "destination_terminal": {
        "data": {
          "type": "terminal",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "line_tracking_stopped_by_user": {
        "data": {
          "type": "user",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    },
    "attributes": {
      "bill_of_lading_number": "<string>",
      "normalized_number": "<string>",
      "ref_numbers": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "tags": [
        "<string>"
      ],
      "port_of_lading_locode": "<string>",
      "port_of_lading_name": "<string>",
      "port_of_discharge_locode": "<string>",
      "port_of_discharge_name": "<string>",
      "destination_locode": "<string>",
      "destination_name": "<string>",
      "shipping_line_scac": "<string>",
      "shipping_line_name": "<string>",
      "shipping_line_short_name": "<string>",
      "customer_name": "<string>",
      "pod_vessel_name": "<string>",
      "pod_vessel_imo": "<string>",
      "pod_voyage_number": "<string>",
      "pol_etd_at": "2023-11-07T05:31:56Z",
      "pol_atd_at": "2023-11-07T05:31:56Z",
      "pod_eta_at": "2023-11-07T05:31:56Z",
      "pod_original_eta_at": "2023-11-07T05:31:56Z",
      "pod_ata_at": "2023-11-07T05:31:56Z",
      "destination_eta_at": "2023-11-07T05:31:56Z",
      "destination_ata_at": "2023-11-07T05:31:56Z",
      "pol_timezone": "<string>",
      "pod_timezone": "<string>",
      "destination_timezone": "<string>",
      "line_tracking_last_attempted_at": "2023-11-07T05:31:56Z",
      "line_tracking_last_succeeded_at": "2023-11-07T05:31:56Z",
      "line_tracking_stopped_at": "2023-11-07T05:31:56Z",
      "line_tracking_stopped_reason": "all_containers_terminated"
    },
    "type": "shipment",
    "links": {
      "self": "<string>"
    }
  }
}

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

Show child attributes

data.attributes

object

required

Show child attributes

data.attributes.ref_numbers

string[]

Shipment ref numbers.

Example:

["REFNUMBER10"]

data.attributes.shipment_tags

string[]

Tags related to a shipment

Response

200 - application/json

data

Shipment model · object

Show child attributes

data.id

string<uuid>

required

data.relationships

object

required

Show child attributes

data.relationships.destination

object

Show child attributes

data.relationships.destination.data

object

Show child attributes

data.relationships.destination.data.type

enum<string>

required

Available options:

port,

metro_area

data.relationships.destination.data.id

string<uuid>

required

data.relationships.port_of_lading

object

Show child attributes

data.relationships.port_of_lading.data

object

Show child attributes

data.relationships.port_of_lading.data.type

enum<string>

required

Available options:

port

data.relationships.port_of_lading.data.id

string<uuid>

required

data.relationships.containers

object

Show child attributes

data.relationships.containers.data

object[]

Show child attributes

data.relationships.containers.data.type

enum<string>

required

Available options:

container

data.relationships.containers.data.id

string<uuid>

required

data.relationships.port_of_discharge

object

Show child attributes

data.relationships.port_of_discharge.data

object

Show child attributes

data.relationships.port_of_discharge.data.type

enum<string>

required

Available options:

port

data.relationships.port_of_discharge.data.id

string<uuid>

required

data.relationships.pod_terminal

object

Show child attributes

data.relationships.pod_terminal.data

object

Show child attributes

data.relationships.pod_terminal.data.type

enum<string>

required

Available options:

terminal

data.relationships.pod_terminal.data.id

string<uuid>

required

data.relationships.destination_terminal

object

Show child attributes

data.relationships.destination_terminal.data

object

Show child attributes

data.relationships.destination_terminal.data.type

enum<string>

required

Available options:

terminal,

rail_terminal

data.relationships.destination_terminal.data.id

string<uuid>

required

data.relationships.line_tracking_stopped_by_user

object

Show child attributes

data.relationships.line_tracking_stopped_by_user.data

object

Show child attributes

data.relationships.line_tracking_stopped_by_user.data.type

enum<string>

required

Available options:

user

data.relationships.line_tracking_stopped_by_user.data.id

string<uuid>

required

data.attributes

object

required

Show child attributes

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<date-time>

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<date-time> | null

data.attributes.pol_atd_at

string<date-time> | null

data.attributes.pod_eta_at

string<date-time> | null

data.attributes.pod_original_eta_at

string<date-time> | null

data.attributes.pod_ata_at

string<date-time> | null

data.attributes.destination_eta_at

string<date-time> | null

data.attributes.destination_ata_at

string<date-time> | 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<date-time> | null

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

data.attributes.line_tracking_last_succeeded_at

string<date-time> | null

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

data.attributes.line_tracking_stopped_at

string<date-time> | 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,

past_full_out_window,

no_updates_at_line,

cancelled_by_user,

booking_cancelled,

data.type

enum<string>

required

Available options:

shipment

data.links

object

required

Show child attributes

data.links.self

string<uri>

required

Get a shipment Stop tracking a shipment

⌘I

Getting Started

In Depth Guides

Useful Info

Shipments

Tracking Requests

Webhooks

Webhook Notifications

Containers

Shipping Lines

Metro Areas

Ports

Vessels

Terminals

Parties

Authorizations

Path Parameters

Body

Response