API Reference

Scalars

A breakdown of all the scalar types, both built-in and custom, that are employed in the API.

ScalarDescription
BOLThe bill of lading’s identifier issued by the carrier.
BooleanThe Boolean scalar type represents true or false.
ContainerNumberThe ContainerNumber scalar type represented as ISO 6346.
carrierBookingReferenceA unique number assigned to a scheduled transportation movement which allocates assets, space needed and a transport plan.
DateA date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
DateTimeUse JavaScript Date object for date/time fields.
FloatThe Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
GeoJSONFeatureCollectionScalarA JSON description of the shipment's geographic features, properties, and spatial extents.
GeoJSONPolygonGeometryScalarGeoJSON geometry of Polygon or MultiPolygon.
GeoJSONPositionScalarThe geographical location of the vessel.
IntThe Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
LocodeThe united nations code for trade and transport locations.
NonNegativeFloatFloats that will have a value of 0 or more.
NonNegativeIntAn Int scalar that must be greater than or equal to zero.
ObjectIdThe ObjectId scalar type represents a MongoDB unique ID.
PositiveIntAn Int scalar that must be a positive value.
SCACThe standard carrier alpha code.
StringThe String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
StringOrBooleanA String or a Boolean union type.
StringOrNumberA String or a Number union type.