GET STARTED
DOCUMENTS
APPS
API
INTEGRATION
GALLERY
Verified Gross Mass

The SOLAS (safety of life at sea) Verified Gross Mass (VGM) is an industry wide regulation that went into effect on July 1, 2016 for all countries and all ocean shipments. The Supplier/Shipper or 3PL are required to submit the Verified Gross Mass (VGM) container data to the carrier, prior to in-gate. This Verified Gross Mass Summary, which is accessed in scripting and over the API using the global identifier $VerifiedGrossMassSummaryC1, is a document to meet the requirements on our system.

Explanation of Extensible Verified Gross Mass Summary Events

Here is a list of all of the events that can be extended upon.

  • On Create
  • On Save

List of State : On State Function:

  • Draft: On State Fn
  • Submitted: On State Fn
  • Canceled: On State Fn

List of Action : Validation or Post Transition Function:

  • Submit: Validation Fn
  • Submit: Post Transition Fn
  • Reopen: Post Transition Fn

You can also add a custom action extension to this object.

Roles and Abilities of Verified Gross Mass Summary Extensions
Event Roles Query Modify Modify Others
On Create Seller, FreightForwarder, Shipper, Customer Yes Yes Yes
On Save Seller, FreightForwarder, Shipper, Customer Yes Yes Yes
Draft: On State Fn Seller, FreightForwarder, Shipper, Customer Yes No Yes
Submitted: On State Fn Seller, FreightForwarder, Shipper, Customer Yes No Yes
Canceled: On State Fn Seller, FreightForwarder, Shipper, Customer Yes No Yes
Submit: Validation Fn Seller, FreightForwarder, Shipper, Customer Yes No No
Submit: Post Transition Fn Seller, FreightForwarder, Shipper, Customer Yes Yes Yes
Reopen: Post Transition Fn Buyer, Seller, FreightForwarder, Shipper, Customer Yes Yes Yes
Available Actions - Ability to add a custom action extension. Seller, FreightForwarder, Shipper, Customer No Yes Yes
Workflow

This models the logical workflow of a VerifiedGrossMass. The model includes the party roles who can edit and take various actions (state transitions).

State Edit Roles Action To State Action Roles Notes
Draft Customer,Shipper,FreightForwarder,Seller submit Submitted Customer,Shipper,FreightForwarder,Seller
Cancel Canceled Customer,Shipper,FreightForwarder,Seller
Submitted Customer,Shipper,FreightForwarder,Seller,Buyer,Carrier Reopen Draft Customer,Shipper,FreightForwarder,Seller
Cancel Canceled Customer,Shipper,FreightForwarder,Seller
Canceled
Query Fields

The following fields can be used in your OQL to filter Verified Gross Mass:

  • gtnVgmNumber
  • state
  • submitterGrossMassNumber
  • keyReference
  • referenceID
  • carrierReferenceType
  • shipperReference
  • forwarderReference
  • shipper
  • forwarder
  • customer
  • responsibleParty
  • authorizedSubmitter
  • carrier
  • receiver
  • owner
  • responsibleContactName
  • responsiblePhoneOrEmail
  • submitterContactName
  • submitterPhoneOrEmail
  • createdBy
  • createdByOrg
  • lastModifiedDate
  • lastModifiedBy
  • modifiedByOrg
  • submittedBy
  • submittedByOrg
  • sourceId
  • buyer
  • seller