In this guide, I will provide suggested steps on how to use the GoFreight API to create shipments in GoFreight. The most common scenario involves the Origin Agent sending shipment data from their system to GoFreight via the GoFreight API to create an import shipment.

The integration includes two main sections. The first is to submit BL data from the origin system to GoFreight, and the second is to upload documents/files to GoFreight’s BL document center.

Submit BL data to GoFreight, integration steps:

To successfully create shipment data in GoFreight, three key steps must be completed:

  1. Confirm the GoFreight Office Ref. where the shipment will be created
  2. Mapping Trade Partners to GoFreight
  3. Container Data Input
  4. Input Locations by UN/Locode
  5. Calling the GoFreight Create Ocean/Air Import MB/L API

1. Confirm the GoFreight Office Ref. where the shipment will be created

  1. GoFreight may have multiple offices. Confirm the rules for assigning shipments to the correct office with the GoFreight owner.
  2. Request the corresponding Office Ref. from GoFreight Customer Support. This reference will be required when calling the API.

2. Mapping Trade Partners to GoFreight

Please refer to the article Managing Trade Partners in GoFreight API Integration to know how to map Trade Partners to GoFreight.

3. Container Data Input

GoFreight differentiates between MB/L and HB/L containers.

  1. For MB/L, include all container numbers, packages, weights, and measurements associated with the MB/L.
  2. For HB/L, include only the container details specific to the HB/L (container number, packages, weight, and measurements).
  3. Ensure the sum of all HB/L container packages, weights, and measurements equals the corresponding MB/L totals.

4. Locations

All locations in GoFreight must use UN/LOCODE.

Call the Get Locations API to obtain a list of UN/LOCODEs supported by GoFreight.

5. Calling the Create Ocean/Air Import MB/L API

The Create Ocean Import MB/L API or Create Air Import MAWB API enables the origin agent to send shipment details directly to the destination agent’s GoFreight system.

After successfully creating the OI MB/L:

The API will return:

  • Ocean Import MB/L Reference
  • Ocean Import HB/L Reference
  • Container’s Reference

After successfully creating the OI MAWB:

The API will return:

  • Air Import MAWB Reference
  • Air Import HAWB Reference

Record these references in your system for:

  • Uploading files to the MB/L, MAWB, HB/L or HAWB document center.
  • Updating data in the future.

Uploading Documents to BL’s Doc Center, integration steps:

The Document API allows origin agents to upload required documents (e.g., Proforma Invoice, Packing List) directly to the shipment’s Document Center in GoFreight.

  1. Specify which GoFreight BL’s Document Center to upload the file to.
  2. Call the Upload Document API.

1. Specify which GoFreight BL’s Document Center to upload the file to.

You need to use the BL Ref. to specify which BL’s document center will the file be uploaded to. If you have previously created a shipment using the Create Shipment API and recorded the shipment’s MBL Ref., HBL Ref., or MAWB Ref., you can directly use it.

If you do not know the BL Ref., you can use the following API to input the MBL No., HBL No., MAWB No., or HAWB No. to retrieve the corresponding BL Ref.

  • To search by MB/L No.:
  • To search by HB/L No.:

2. Call the Upload Document API.

Uploading to OI MB/L:

Uploading to OI HB/L:

Ensure you specify the correct MB/L or HB/L Ref. to upload documents to the right shipment.

The documents will be automatically attached to the corresponding shipment in the Document Center.