Purpose

This Integration is used to send Advanced Shipment Notices & Milestones from a freight provider to a shipper.

Roles

These roles describe the different systems involved in this integration

Freight TMS this is the freight provider's system that houses shipment data that needs to be provided
Shipper TMS this is the system that will receive updates about the shipment.

Flow Types

Flow Type	Key	Description	Input Converter	Output Converter
Send ASNs	`asn.send_asn`	Send an advanced shipment notice.	Freight TMS	Shipper TMS
Send Milestones	`asn.send_milestone`	Send a milestone update	Freight TMS	Shipper TMS

Send ASNs

Sample payload output by the Input Converter and sent to the Output Converter (download JSONSchema)

{
  "shipment": {
    "forwarder_reference": "HB001",
    "ship_from": {
      // finish this
    },
    "mode": "SEA", // mode for the main leg
    "transport_legs": [
      // finish this
    ]
  }
}

Send Milestones

Sample payload output by the Input Converter and sent to the Output Converter (download JSONSchema)

{
  "shipment": {
    "forwarder_reference": "HB001", // return the same reference numbers from the registration
    "emissions_stuff": {} // finish this with real data -- BSG
  }
}