This BlueX Open Freight Marketplace (OFM) API document explains the various product offerings from Evergreen's GreenX platform through API integrations. The API supports carrier port pairs, schedules, and spot rates, and enables users to search for rates and book through GreenX seamlessly via a Deep Link provided by the API.

The API currently supports only Evergreen’s GreenX platform, and we are actively working on supporting further carrier API integrations, along with more new features, such as inventory management, instant booking, and many more.

BlueX presents data via a REST API using JSON serialization and is protected with JWT. To access the API, please first click "Getting Started" to get onboarded and collect your API key.

All BlueX API requests are sent to https://api.bluextrade.com.

Before using the BlueX OFM API, please first register as a developer on our registration page. The BlueX team will review your application, and once your registration is confirmed, you will receive an API key and onboarding information for your developers.

Our API is accessible over HTTPs and returns JSON responses, and can only be accessed through BlueX provided API keys and tokens. When customers or third-party service providers access the BlueX OFM services via APIs, they are required to provide their API keys during the onboarding process.

Before accessing API, the client must have an API key. The API key is obtained offline. It identifies who is the client.

The client calls HTTP GET /v1/auth?api-key=[api key]&referral-user=[referral user] with a valid API key and a referral user string. The referral user is a string can identify the user who invoke /v1/auth/ with the API key. Both the api-key and referral-user are required. /v1/auth will return a JSON response. The token is in the "token" field of the response. This is an example of the response.

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcm9maWxlIjp7ImNvbXBhbnkiOiJTYW5kYm94IHRlc3QgY29tcGFueSJ9LCJwb2xpY3kiOlt7InNlcnZpY2UiOiJzY2hlZHVsZSIsImFsbG93Ijp0cnVlfV0sImV4cGlyZWRfYXQiOjE1ODQwMDY0NzF9.TaRCEr9p88s_oxUxsxJ6-K2ccrMnzLhKR2W0ossH6uE"
}

The token is a JWT token. To access all APIs (except /v1/auth), the client must put the token in the HTTP header. Here is an example.

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcm9maWxlIjp7ImNvbXBhbnkiOiJTYW5kYm94IHRlc3QgY29tcGFueSJ9LCJwb2xpY3kiOlt7InNlcnZpY2UiOiJzY2hlZHVsZSIsImFsbG93Ijp0cnVlfV0sImV4cGlyZWRfYXQiOjE1ODQwMDY0NzF9.TaRCEr9p88s_oxUxsxJ6-K2ccrMnzLhKR2W0ossH6uE

The system will verify if the token is issued by the system or if the token is expired. The client request will be rejected if the token not passed the verification process.

Token Refresh

The tokens issued by the system will be expired automatically. A token will expire one day after it is issued. The client can obtain new token by calling /v1/auth with the API key or calling HTTP GET /v1/refresh_token. The response of /v1/refresh_token is the same as /v1/auth.

To authenticate in the JWT bearer flow, you will need to obtain a JWT containing data on the authentication request, before exchanging it for an access token.

The "Rates" API supports features for customers to receive container information and spot rates. Customers can also receive information from GreenX about service routes, vessel/voyage, and container types.

The "Schedules" API provides information about routes and schedules on end-to-end searches, which includes vessel/voyage, service routes, POR, POL, POD and PDL, ETA, ETD, and transit times.

The "Locations" API provides information on which supported origin and destination ports offer spot rates on GreenX. Other information includes port codes, city names, countries, and geolocation