Visibility - Register Shipment

The Register Shipment document is responsible for registering your TMS shipment data with a visibility provider.

NameDescription
Root
Root_containers
NameData TypeDescriptionRequired
tms_system_identifierStringThe 'primary key' uniquely identifying the shipment in the source TMS system. This value is registered with the visibility provider and should be included in all event updates.YES
master_billStringThe full carrier master bill number of the shipment that is being registered with the visibility provider. The visibility provider registers an interest in the Master Bill with the appropriate carrier.
containersArray<Root_containers>
carrier_booking_numberStringThe reservation number issued by the carrier or agent for the shipment. Some visibility providers can utilize this number to register interest with the appropriate carrier.
carrier_scacStringThe carrier that issued the master_bill or carrier_booking_number or is transporting the container. When given, this will be the carrier that the visibility provider registers and interest with.
transport_modeStringThe primary mode of transportation the shipment is travelling via. Allowed values: sea, air.YES
containerization_typeStringThe shipper container mode the shipment is being transported under. This value may be used to determine if a master_bill, container_number is registed with the visibility provider. Typically, container numbers are registered for LCL shipments and master bill or carrier booking numbers are utilized for FCL shipments. Allowed values: fcl, lcl.
NameData TypeDescriptionRequired
container_numberStringThe full container number to register with the visibility provider. In LCL scenarios, the visibility provider will register an interest in the Container Number with the appropriate carrier.