Skip to navigation

Search ports

Company token. Up to 20 ports that match the name, alternate name, code, UN/LOCODE or country code. An empty data list means no match; msg then suggests another spelling.

Authentication

AuthorizationBearer

Send Authorization: Bearer <token>. Company endpoints take the company API token from POST /api/v1/partners/login. /transporters endpoints take the transporter token from POST /api/v1/partners/transporters/login. You can also send the token as an access_token query parameter or body field.

Query parameters

searchstringRequired>=2 characters

At least 2 characters of the port name, code or UN/LOCODE, for example Jeddah or SA JED.

Response

Success
statusinteger
msgstring
msgslist of strings
datalist of objects

Errors

401
Unauthorized Error
412
Precondition Failed Error
429
Too Many Requests Error