Freight shipment updated

Body

application/json

connection_id

string

required

Example:

"connection_id"

data

FreightShipmentSchema · object

required

Show child attributes

data.id

string

The unique ID of the shipment.

Example:

"shipment_id"

data.eta_date

string<date-time> | null

The estimated arrival date of the shipment.

Example:

"2021-01-01T00:00:00Z"

data.created_date

string<date-time>

The date the freight shipment was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string<date-time>

The date the freight shipment was last updated.

Example:

"2022-01-02T05:05:05Z"

data.cost

number | null

The cost of the shipment.

Example:

1

data.shipment_date

string<date-time> | null

The date the shipment was sent from its origin.

Example:

"2021-01-01T00:00:00Z"

data.arrival_date

string<date-time> | null

The actual date the shipment arrived at its destination.

Example:

"2021-01-01T00:00:00Z"

data.raw_status

string | null

The raw status of the shipment from the freight forwarder.

Example:

"status"

data.status

enum<string>

The status of the freight shipment. See the freight shipment information for more details.

Available options:

pre_transit,

in_transit,

arrival_port,

en_route_to_destination,

final_destination

Example:

"pre_transit"

data.shipment_method

string

The mode by which the shipment was transported (e.g. air, ocean)

Example:

"shipment_method"

data.external_system_url

string | null

URL link to the freight shipment in the external system (WMS/Freight etc).

Example:

"https://example.com/freightshipment/123"

data.additional_fields

object

Integration-specific fields

Show child attributes

data.additional_fields.{key}

any

Example:

{ "key": "value" }

event_type

string

required

Example:

"freight-shipment.updated"

integration_name

string

required

Example:

"integration_name"

integration_type

string

required

Example:

"freight"

previous_attributes

FreightShipmentSchema · object

required

Show child attributes

previous_attributes.id

string

The unique ID of the shipment.

Example:

"shipment_id"

previous_attributes.eta_date

string<date-time> | null

The estimated arrival date of the shipment.

Example:

"2021-01-01T00:00:00Z"

previous_attributes.created_date

string<date-time>

The date the freight shipment was created.

Example:

"2022-01-01T00:00:00Z"

previous_attributes.updated_date

string<date-time>

The date the freight shipment was last updated.

Example:

"2022-01-02T05:05:05Z"

previous_attributes.cost

number | null

The cost of the shipment.

Example:

1

previous_attributes.shipment_date

string<date-time> | null

The date the shipment was sent from its origin.

Example:

"2021-01-01T00:00:00Z"

previous_attributes.arrival_date

string<date-time> | null

The actual date the shipment arrived at its destination.

Example:

"2021-01-01T00:00:00Z"

previous_attributes.raw_status

string | null

The raw status of the shipment from the freight forwarder.

Example:

"status"

previous_attributes.status

enum<string>

The status of the freight shipment. See the freight shipment information for more details.

Available options:

pre_transit,

in_transit,

arrival_port,

en_route_to_destination,

final_destination

Example:

"pre_transit"

previous_attributes.shipment_method

string

The mode by which the shipment was transported (e.g. air, ocean)

Example:

"shipment_method"

previous_attributes.external_system_url

string | null

URL link to the freight shipment in the external system (WMS/Freight etc).

Example:

"https://example.com/freightshipment/123"

previous_attributes.additional_fields

object

Integration-specific fields

Show child attributes

previous_attributes.additional_fields.{key}

any

Example:

{ "key": "value" }

Response

200

Success

Home

How-To Guides

Use Cases

Freight shipment updated

Body

Response