Skip to content
English
  • There are no suggestions because the search field is empty.

GoFreight API FAQ | GoFreight Help Center

Question:

How can I retrieve complete Ocean Import Shipment data using a single GoFreight API endpoint?

Answer:
Currently, retrieving the entire detailed shipment data through a single API endpoint is not supported.

For example, if you have the Master Bill of Lading (MBL) number for an Ocean Import shipment, you can follow these steps:

Please refer to the recommended API endpoints below:

  1. Call Get Ocean Import MB/L by Ref. endpoint with the file number to retrieve necessary data, including HBL Ref and Container Ref.
  2. Next, call Get Ocean Import HB/L by Ref. endpoint using the HBL Ref obtained from step 1 to retrieve additional data.
  3. Then, call Get Container by Ref. endpoint using the Container Ref retrieved from step 1 to get the required information.
  4. Finally, use the Get Ocean Import HB/L Commodities by HB/L Ref. endpoint with the HBL Ref from step 1 to retrieve commodity details.

Question:

Is it necessary to call two API endpoints to create both Shipment MBL and HBL?

Answer:
Not necessarily. The supported create endpoint, Create Ocean Import MB/L , allows you to include the master bill along with the hbl_list in the request body.
This enables the creation of both MBL and HBL in a single API call. The response will return references for both the master and house bills.

A separate HBL endpoint is only required if you need to create or update a house bill independently at a later time.


The same method can be applied to the following create endpoints:

  • Create Ocean Export MB/L
  • Create Air Import MAWB
  • Create Air Export MAWB

Question:

I am receiving a 401 error when calling a Webhook. How can I resolve this issue?

Answer:
Please reach out to support@gofreight.com.
The webhook requires additional configuration to function properly.


Question:

What do the Enum values mean when calling the following API endpoints:

  • Create Air Export MAWB
  • Update Air Export MAWB by Ref
  • Update Ocean Import MB/L by Ref.

Answer:
The following Enum values represent different shipment types.

Enum

Description

NR

Normal

CL

Co-Load

CS

Consol

DR

Direct

TR

Triangle

DT

Direct Triangle

TP

Third Party

FW

Forwarding

CB

Carrier Buyer Consol

 

 

Question:

Does GoFreight offer a Read-Only API or configurable API permissions?

Answer:
Currently, GoFreight API access can not be restricted by request type, feature, or module.

For example, API access cannot be configured to allow an employee to retrieve shipment data while preventing access to Accounting data.

In other words, GoFreight does not currently support customizable API permissions that provide access to specific modules while restricting others.

 

 

You might also be interested in:

- How to Exchange Shipment Data Using GoFreight-to-GoFreight EDI