Documentation Powered by ReDoc

BlueX Freight Commerce Platform (FCP) API

Introduction

This BlueX Freight Commerce Platform (FCP) 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.

Changelog

All notable changes to this project will be documented in this section.

2020-06-09

Added

  • Pricing transparency fields, e.g. surcharges, tieredSurcharges, includedSurcharges, and notApplicableSurcharges.

Changed

  • Storing price in string type instead of float for better accuracy
  • Move freeTime from containerPrice to offer

Getting Started

Before using the BlueX FCP 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.

API Security Model

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 FCP services via APIs, they are required to provide their API keys during the onboarding process.

API Key

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

Token

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.

Authentication

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.

Get a new access token

query Parameters
api-key
required
string
referral-user
required
string

Responses

200

OK

403

Forbidden

404

Not Found

get/v1/auth
https://api.bluextrade.com/v1/auth

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Refresh the access token

Authorizations:
JWT Token

Responses

200

OK

get/v1/refresh_token
https://api.bluextrade.com/v1/refresh_token

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Rates

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.

List available rates

List available rates on GreenX

Authorizations:
JWT Token
query Parameters
scac
required
string
Example: scac=EGLV

The brand SCAC code of the carrier to list rates for, eg. EGLV for Evergreen Marine Corp.

por
required
string
Example: por=CNSHA

Set to filter results to match UN/LOCODE of origin location.

fnd
required
string
Example: fnd=USLAX

Set to filter results to match UN/LOCODE of destination location.

departureFrom
required
string
Example: departureFrom=

Earliest departure date for requested rates in ISO Date Format yyyy-MM-dd, eg. 2020-01-23

departureTo
string
Example: departureTo=

Latest departure date for requested rates in ISO Date Format yyyy-MM-dd, eg. 2020-02-14

containers
Array of strings
Example: containers=2x20SD,3x40HQ

Container amounts and types for the request in <amount>x<container type> format.

commodities
Array of strings
Items Enum: "GDSM" "GARMENT" "FURNITURE"
Example: commodities=GDSM

Commodity Code of the content in the containers

porServiceMode
string
Value: "CY"
Example: porServiceMode=CY

Specify service mode for origin, Merchant haulage (CY) or Carrier haulage (SD)

fndServiceMode
string
Value: "CY"
Example: fndServiceMode=CY

Specify service mode for destination, Merchant haulage (CY) or Carrier haulage (SD)

sort
Array of strings
Items Enum: "price" "etd" "tt"
Example: sort=price,etd:asc,tt:desc

Sorting is determined through the use of the sort query string parameter. The value of this parameter is a comma-separated list of sort keys. Sort directions can optionally be appended to each sort key, separated by the : character. The available sort keys are price for sorting by the total price, etd for sorting by the estimated time of departure from the first loading port, and tt for sorting by the transit time from the origin location to the destination location. The supported sort directions are either asc for ascending or desc for descending.

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/v1/rates
https://api.bluextrade.com/v1/rates

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "offers":
    [
    • {
      • "id": "quote-01",
      • "brandScac": "EGLV",
      • "productCode": "AS1234",
      • "schedule":
        {
        • "id": "schedule-01",
        • "brandScac": "EGLV",
        • "from":
          {
          • "location":
            {
            • "code": "CNSHA",
            • "unlocode": "CNSHA"
            },
          • "etd": 1591574400
          },
        • "to":
          {
          • "location":
            {
            • "code": "USLAX",
            • "unlocode": "USLAX"
            },
          • "eta": 1592784000
          },
        • "firstLoadingPort":
          {
          • "location":
            {
            • "code": "CNSHA",
            • "unlocode": "CNSHA",
            • "name": "Shanghai",
            • "fullName": "Shanghai"
            },
          • "etd": 1591574400
          },
        • "lastDischargePort":
          {
          • "location":
            {
            • "code": "USLAX",
            • "unlocode": "USLAX"
            },
          • "eta": 1592784000
          },
        • "vessel":
          {
          • "name": "EVER LEADER"
          },
        • "voyageNumber": "0911-046E",
        • "transitTime": 14,
        • "legs":
          [
          • {
            • "from":
              {
              • "location":
                {
                • "code": "CNSHA",
                • "unlocode": "CNSHA"
                },
              • "etd": 1591574400
              },
            • "to":
              {
              • "location":
                {
                • "code": "USLAX",
                • "unlocode": "USLAX"
                },
              • "eta": 1592784000
              },
            • "transportMode": "VESSEL",
            • "tradeLane": "CPS",
            • "vessel":
              {
              • "name": "EVER LEADER"
              },
            • "voyageNumber": "0911-046E",
            • "transitTime": 14
            }
          ]
        },
      • "price":
        {
        • "containerPrices":
          [
          • {
            • "containerType": "20SD",
            • "bas":
              {
              • "currency": "USD",
              • "rate": "2010",
              • "qty": 2,
              • "amount": "4020",
              • "rateBasis": "PER_CONTAINER",
              • "rateType": "PAID_WITH_FREIGHT",
              • "chargeCode": "BAS",
              • "chargeDescription": "Basic Ocean Freight"
              },
            • "surcharges":
              [
              • {
                • "currency": "USD",
                • "rate": "500",
                • "qty": 2,
                • "amount": "1000",
                • "rateBasis": "PER_CONTAINER",
                • "rateType": "PAID_AT_ORIGIN",
                • "chargeCode": "CSC",
                • "chargeDescription": "Container Service Charge"
                },
              • {
                • "currency": "TWD",
                • "rate": "100",
                • "qty": 2,
                • "amount": "200",
                • "rateBasis": "PER_CONTAINER",
                • "rateType": "PAID_AT_DESTINATION",
                • "chargeCode": "THC/D",
                • "chargeDescription": "Terminal Handling Charge at Destination"
                }
              ]
            },
          • {
            • "containerType": "40SD",
            • "bas":
              {
              • "currency": "USD",
              • "rate": "2200",
              • "qty": 8,
              • "amount": "17600",
              • "rateBasis": "PER_CONTAINER",
              • "rateType": "PAID_WITH_FREIGHT",
              • "chargeCode": "BAS",
              • "chargeDescription": "Basic Ocean Freight"
              },
            • "surcharges":
              [
              • {
                • "currency": "USD",
                • "rate": "500",
                • "qty": 8,
                • "amount": "4000",
                • "rateBasis": "PER_CONTAINER",
                • "rateType": "PAID_AT_ORIGIN",
                • "chargeCode": "CSC",
                • "chargeDescription": "Container Service Charge"
                },
              • {
                • "currency": "TWD",
                • "rate": "120",
                • "qty": 8,
                • "amount": "960",
                • "rateBasis": "PER_CONTAINER",
                • "rateType": "PAID_AT_DESTINATION",
                • "chargeCode": "THC/D",
                • "chargeDescription": "Terminal Handling Charge at Destination"
                }
              ],
            • "tieredSurcharges":
              [
              • {
                • "currency": "USD",
                • "rate": "10",
                • "rateBasis": "PER_CONTAINER",
                • "rateType": "PAID_AT_ORIGIN",
                • "chargeCode": "HWCS",
                • "chargeDescription": "Heavy Weight Container Surcharge",
                • "tierType": "G.W.(Ton)",
                • "from": "18.001",
                • "to": "22"
                },
              • {
                • "currency": "USD",
                • "rate": "15",
                • "rateBasis": "PER_CONTAINER",
                • "rateType": "PAID_AT_ORIGIN",
                • "chargeCode": "HWCS",
                • "chargeDescription": "Heavy Weight Container Surcharge",
                • "tierType": "G.W.(Ton)",
                • "from": "22.001",
                • "to": "30"
                },
              • {
                • "currency": "USD",
                • "rate": "20",
                • "rateBasis": "PER_CONTAINER",
                • "rateType": "PAID_AT_ORIGIN",
                • "chargeCode": "HWCS",
                • "chargeDescription": "Heavy Weight Container Surcharge",
                • "tierType": "G.W.(Ton)",
                • "from": "30.001",
                • "to": "35"
                }
              ]
            },
          • {
            • "containerType": "40HQ",
            • "bas":
              {
              • "currency": "USD",
              • "rate": "2200",
              • "rateBasis": "PER_CONTAINER",
              • "rateType": "PAID_WITH_FREIGHT",
              • "chargeCode": "BAS",
              • "chargeDescription": "Basic Ocean Freight"
              },
            • "surcharges":
              [
              • {
                • "currency": "USD",
                • "rate": "500",
                • "rateBasis": "PER_CONTAINER",
                • "rateType": "PAID_AT_ORIGIN",
                • "chargeCode": "CSC",
                • "chargeDescription": "Container Service Charge"
                },
              • {
                • "currency": "TWD",
                • "rate": "140",
                • "rateBasis": "PER_CONTAINER",
                • "rateType": "PAID_AT_DESTINATION",
                • "chargeCode": "THC/D",
                • "chargeDescription": "Terminal Handling Charge at Destination"
                }
              ]
            }
          ],
        • "surcharges":
          [
          • {
            • "currency": "USD",
            • "rate": "25",
            • "qty": 10,
            • "amount": "250",
            • "rateBasis": "PER_CONTAINER",
            • "rateType": "PAID_AT_ORIGIN",
            • "chargeCode": "BAF",
            • "chargeDescription": "Bunker Adjustment Factor"
            },
          • {
            • "currency": "USD",
            • "rate": "30",
            • "qty": 1,
            • "amount": "30",
            • "rateBasis": "PER_DOCUMENT",
            • "rateType": "PAID_AT_ORIGIN",
            • "chargeCode": "SCMC",
            • "chargeDescription": "Bunker Adjustment Factor"
            }
          ],
        • "includedSurcharges":
          [
          • {
            • "currency": "USD",
            • "rate": "100",
            • "qty": 10,
            • "amount": "1000",
            • "rateBasis": "PER_DOCUMENT",
            • "rateType": "PAID_AT_ORIGIN",
            • "chargeCode": "BSC",
            • "chargeDescription": "Booking Service Charge"
            }
          ],
        • "notApplicableSurcharges":
          [
          • {
            • "chargeCode": "A.P.",
            • "chargeDescription": "Additional Premium"
            }
          ],
        • "currency": "USD",
        • "exchangeRate": "1",
        • "totalRate": "28060",
        • "totalRateUsd": "28060",
        • "effectiveFrom": 1577836800,
        • "effectiveTill": 1609459199,
        • "annotation":
          {
          • "demurrage": "119 days DM at POL and POD",
          • "detention": "POL:179 days,POD:189 days",
          • "outport": "output",
          • "remarks": "remarks",
          • "included": "included",
          • "subjectTo": "subjectTo"
          }
        },
      • "inventory":
        {
        • "bookingClosingDate": 1588896000,
        • "ct20sdAvailable": 10,
        • "ct40sd40hqAvailable": 20,
        • "ct45hqAvailable": 30
        },
      • "polFreeTime":
        {
        • "demurrage":
          {
          • "type": "CALENDAR_DAY",
          • "days": 5
          },
        • "detention":
          {
          • "type": "CALENDAR_DAY",
          • "days": 7
          }
        },
      • "podFreeTime":
        {
        • "bt":
          {
          • "type": "CALENDAR_DAY",
          • "days": 13
          },
        • "chassis":
          {
          • "type": "WORKING_DAY",
          • "days": 8
          }
        },
      • "orderLink": "https://www.carrierx.bluex.com/quote/search#H4sIAAAAAAAA_0zOwUrDQBDG8Vcp33kqk7TSOCdrjVUUPaT1UoqUzQZ62E26uxEl7LvL1og9_n_wDTNAf3WQ7Lq4KRbMvCC4HoLeHsNH0D7c9l67K9UaEA4Kgq09hslG-zBZtaY72G8QTjUED8vn8v5pXVabJB4ywKvzpFy_vIPQtQ6C1Wv1uAShsWm0re7eKhDqBoKcc57yfMpZknAhMwZBOchuQIBknDPhBJlFGmH-C8UI-R9w3BOUSdd22f78hP80KThlY-v_jPEnAAD__xTuG0UPAQAA"
      }
    ]
}

List supported containers

List supported containers on GreenX

Authorizations:
JWT Token

Responses

200

OK

401

Unauthorized

403

Forbidden

get/v1/rates/containers
https://api.bluextrade.com/v1/rates/containers

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "containers":
    [
    • {
      • "id": "20SD",
      • "name": "20DRY",
      • "label": "20' Standard Dry",
      • "type": "DRY",
      • "iso": "22G1",
      • "size": 20,
      • "height": "8 6"
      },
    • {
      • "id": "45HQ",
      • "name": "45HDRY",
      • "label": "45' High Cube Dry",
      • "type": "HDRY",
      • "iso": "L5G1",
      • "size": 45,
      • "height": "9 6"
      }
    ]
}

Schedules

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.

List schedules

List all the schedules on GreenX

Authorizations:
JWT Token
query Parameters
scac
required
string

The brand SCAC code of the carrier to list rates for, eg. EGLV for Evergreen Marine Corp.

por
required
string

Set to filter results to match UN/LOCODE of origin location.

fnd
required
string

Set to filter results to match UN/LOCODE of destination location.

departureFrom
required
string

Earliest departure date for requested rates in ISO Date Format yyyy-MM-dd, eg. 2020-01-23

departureTo
string

Latest departure date for requested rates in ISO Date Format yyyy-MM-dd, eg. 2020-02-14

Responses

200

OK

401

Unauthorized

403

Forbidden

get/v2/schedules
https://api.bluextrade.com/v2/schedules

Response samples

Content type
application/json
Copy
 Expand all Collapse all