Getting Started

Sections

Theme switcher

Voyage

Header Parameters

Authorizationstring Required

Bearer token used for authentication.

Body Parameters

firstint

Maximum number of items to return from the start of the list.

lastint

Maximum number of items to return from the end of the list.

beforestring

Return items that come before the specified cursor.

afterstring

Return items that come after the specified cursor.

typestring

Filter by the type of voyage (e.g. 'laden', 'ballast').

onlyCurrentboolean

Filter to include only current voyages. Default: false

excludeCabotageboolean

Filter to exclude cabotage voyages. Default: false

commoditiesarray

List of commodity names, IDs or groups to filter the voyages.

startobject

Filter by the start date/time.

Showย child attributes

endobject

Filter by the end date/time.

Showย child attributes

loadStsboolean

Include only voyages that have a loaded status.

dischStsboolean

Include only voyages that have a discharged status.

includePredictedboolean

Filter to include predicted voyages. Default: false

loadAreasarray

Filter by the IDs, names, or UNLOCODEs of the load areas.

dischAreasarray

Filter by the IDs, names, or UNLOCODEs of the discharge areas.

lastUpdatedobject

Filter by the last updated date/time.

Showย child attributes

vesselBuiltobject

Filter by the year the vessel was built (inclusive).

Showย child attributes

vesselBeamobject

Filter by the beam of the vessel.

Showย child attributes

vesselLoaobject

Filter by the length overall (LOA) of the vessel.

Showย child attributes

vesselDraftobject

Filter by the draft of the vessel.

Showย child attributes

vesselDwtobject

Filter by the deadweight tonnage of the vessel.

Showย child attributes

vesselTeuobject

Filter by the TEU capacity of the vessel.

Showย child attributes

vesselCubicobject

Filter by the cubic capacity of the vessel.

Showย child attributes

vesselFleetsarray

Filter by the fleet names the vessel belongs to.

vesselIdsarray

Filter by the vessel IDs.

vesselImosarray

Filter by the IMO numbers of the vessels.

vesselSegmentsarray

Filter by the vessel segments (e.g. 'dry', 'tanker', 'lng', 'chemical').

vesselTypesarray

Filter by the vessel types (e.g. 'Bulk carrier', 'Tanker').

vesselSubtypesarray

Filter by the vessel subโ€‘types

Response

200
Object

Response Attributes

dataobject

Showย child attributes

POST

/

Select
1

Response