COLA logo
API docs by Redocly

Contargo REST APIs (1.0)

Download OpenAPI specification:

Contact COLA Integration: integration@contargo.net URL: https://integration.contargo.net License: MIT License Terms of Service

A set of APIs offered by Contargo for integration of external services and partners with the Contargo Open Logistics Application (COLA).

Contargo Integration Landingpage

Introduction

Contargo API endpoints allow integration with COLA (Contargo Open Logistics Application), e.g. in order to retrieve tracking information for Containers including their current location and for booking orders in STAR. Contargo APIs are HTTP-based REST APIs. The API specification is available as a OpenAPI 3 (Swagger) document and may be used by consumers to generate client code. See above for the download link.

This documentation lists all available endpoints, required parameters and responses that API clients can expect and can be used as reference. We also give example requests and responses in JSON that may be used when trying out this API. Examples are presented in the right-hand column for each endpoint respectively.

Interaction with Contargo APIs requires authentication via OAuth2. See the following section for details. Write to integration@contargo.net in order to request access to Contargo APIs.

Availability

The availability of API endpoints and features may vary depending on the region or terminal that is affected.
Some functionalities described in this documentation may not be enabled or accessible in your environment.

For information on the actual availability of specific endpoints or features for your setup,
please reference related regions or terminals when contacting integration@contargo.net.

We are happy to assist you in evaluating what is currently available for your organization.

Authentication

To use Contargo APIs, you need to authenticate via OAuth2. We support the Resource Owner Password Flow based on the username and credentials that are provided to you after completing the COLA account registration. Contact us when you want to use another authentication flow.

Resource Owner Password Flow

Since OAuth 2 is a well-known standard for authentication, we recommend using the framework or library of your choice to perform authentication. However, if you prefer to do this manually or want to follow along for testing purposes, the following section describes the required steps when performing these steps manually:

Retrieve access token

Use the provided credentials of your COLA account to retrieve a valid access token.

Prerequisite: Export your credentials to environment variables

export COLA_USERNAME=your_username
export COLA_PASSWORD=your_password

Example request to retrieve an access token:

curl -X POST https://login.contargo.net/auth/realms/cola/protocol/openid-connect/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=password" \
-d "username=${COLA_USERNAME}" \
-d "password=${COLA_PASSWORD}" \
-d "client_id=cola-api" \
-d "scope=openid" \
| egrep "^{"

In case your request was successful, the response includes the access token in the access_token field. The access token expires after the time given in the expires_in field (by default: 300 seconds = 5 minutes).

Example payload of a successful response:

{
  "access_token": "eyJhbGciOiJX1VAao-mm3_this_is_an_example_the_real_token_is_longer_MR_bkCrdBpJ4Y6nG_E7c1V0kvD88YHg",
  "expires_in": 300,
  "refresh_expires_in": 21600,
  "refresh_token": "eyJhbGciOiJIUzI1NiIs3LT0x_this_is_an_example_the_real_token_is_longer_EJZxDKx0ufJ4ckD_9xuYXe0Ek",
  "token_type": "bearer",
  "id_token": "eyJhbGcQIizX6wmq-_this_is_an_example_the_real_token_is_longer_EawmRy5rp2Y0uauWHLB01yZ0Q",
  "not-before-policy": 0,
  "session_state": "3b8a_this_is_an_example_adcbe2",
  "scope": "openid email profile cola:profile"
}

Use refresh token

You may use the refresh_token in order to request a new access-token. This token expires after refresh_expires_in seconds (by default: 21600 seconds = 6 hours).

Prerequisite: Export currently valid access token from previous response

export REFRESH_TOKEN=your-refresh-token-value

Example request to use the refresh token to get a new access token:

curl -X POST https://login.contargo.net/auth/realms/cola/protocol/openid-connect/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=refresh_token" \
-d "refresh_token=${REFRESH_TOKEN}" \
-d "client_id=cola-api"

Provide the access token in a request

Once an access_token has been retrieved, it can be used in multiple requests (while it remains active).

Make a Request with desired endpoint:

curl -H "Authorization: Bearer ${ACCESS_TOKEN}" "https://api.contargo.net/contargo/cola/1.0/[endpoint]"

Expiration

If the access-token expired, you get a response with status code 401 and response header like this:

www-authenticate: Bearer error="invalid_token", error_description="An error occurred while attempting to decode the Jwt: Jwt expired at 2025-06-13T10:47:31Z", error_uri="https://tools.ietf.org/html/rfc6750#section-3.1"

In that case, retrieve a new access token and retry your request using the new token.

Details for OAuth2 authentication:

Use the following data for setting up authentication:

OAuth2

This API uses OAuth 2 and supports the resource owner password flow. See https://integration.contargo.net/docs/#authentication for details

Security Scheme Type: OAuth2
Flow type: password
Token URL: https://login.contargo.net/auth/realms/cola/protocol/openid-connect/token
Refresh URL: https://login.contargo.net/auth/realms/cola/protocol/openid-connect/token
Scopes:
  • openid -

    Default scope for OpenIdConnect

Master-Data & Identifiers

Many COLA API endpoints require specific identifiers (such as IDs for locations, orders, tracking events, etc.) to be passed as parameters in the request. These identifiers are typically not human-friendly values and are intended to uniquely reference records within the system.

To retrieve the correct identifiers, clients should first query the corresponding master data APIs. These APIs provide the authoritative source for static or slowly-changing reference data. Once retrieved, the identifiers returned by the master data APIs can be used as inputs to other API operations.

This approach ensures consistency, avoids duplication, and enables better validation and error handling across the API ecosystem.

In the following sections, you'll find examples of how to retrieve master data and how to use the resulting identifiers in other requests.

Locations

Retrieve information about locations, i. e. terminals, loadingplaces, seaports, etc. that are relevant in the context of COLA. Typically the identifier of such locations is expected as input for operations that create or update resources, so this may be used in order to look up the related data.

Search for terminals, loadingplaces, seaports, etc.

This endpoint can both be used to retrieve all known locations as well as to search for a specific location using the provided criteria.

Authorizations:
OAuth2
query Parameters
type
string
Enum: "ORGANISATION" "ADMINISTRATIVE_TERMINAL" "OPERATIONAL_TERMINAL" "HINTERLAND_TERMINAL" "LOADINGPLACE" "SEAPORT" "SEAPORT_TERMINAL" "UNKNOWN"

Type of the Location to search for. In case no location type is given, locations of all types are returned.

  • ORGANISATION: The location of an organisation
  • ADMINISTRATIVE_TERMINAL: The location a (Contargo) administrative terminal
  • OPERATIONAL_TERMINAL: The location of a (Contargo) operational terminal
  • HINTERLAND_TERMINAL: The location of a (non-Contargo) hinterland terminal
  • LOADINGPLACE: The location of a loadingplace
  • SEAPORT: The location of a seaport
  • SEAPORT_TERMINAL: The location of a seaport terminal
  • UNKNOWN: A location of unknown type
name
string

Name of a location to search for. Search is case-insensitive and includes substrings. If empty or null, no filtering by name occurs.

page
integer <int32> >= 1
Default: 1

1-based index of the requested page of results

pageSize
integer <int32> >= 1
Default: 50

The max. number of results to return per page

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    • "currentPage": 1,
    • "pageSize": 50,
    • "total": 1337
    },
  • "data": [
    • {
      • "id": "or_24277e9ef1ea8a41e4df0bb5c300aa966754f02241991d4e40d11fd3057c4fc5",
      • "designation": "Contargo Neuss GmbH",
      • "type": "ADMINISTRATIVE_TERMINAL",
      • "locationCode": "DENSS",
      • "internationalPortCode": "NLRTM",
      • "edifactLocationCode": "0APMA",
      • "address": {
        • "street": "Floßhafenstraße 37",
        • "postalCode": "41460",
        • "city": "Neuss",
        • "country": {
          • "name": "Germany",
          • "code": "DE"
          }
        },
      • "geoLocation": {
        • "coordinates": {
          • "latitude": 50.393994,
          • "longitude": 7.589209
          }
        }
      }
    ]
}

STAR

The STAR API provides programmatic access to Contargo’s STAR at star.contargo.net, enabling partners to create, update, retrieve and delete orders in STAR. Use this integration in order to import relevant orders into STAR, which can then be assigned to time slots by your Dispatchers without having to manually transfer the required data between systems.

Partners can use them to:

  • Query all open orders for the current user
  • Query the status of a single order
  • Create new orders
  • Update existing orders
  • Delete open orders (if no SlotRequest exists yet)

Return StarOrders

This endpoint returns existing and open (i.e. not yet used for booking a SlotRequest) StarOrders of the user

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
Example

A single open order was found

{
  • "ids": [
    • "0b52e366-2be7-4277-817f-70e1ba8b3917"
    ]
}

Create a new order in STAR

This endpoint allows the creation of new orders in STAR that can then be used to book SlotRequests directly in the application by a Dispatcher.

Authorizations:
OAuth2
Request Body schema: application/json
required

The STAR order to be created

terminalId
required
string

Identifier of the location of type ADMINISTRATIVE_TERMINAL at which the STAR order should be performed. Note that the corresponding identifier can be retrieved via the Locations-API.

action
required
string
Enum: "PICK_UP" "DROP_OFF"

The type of the order that is planned

  • PICK_UP: The loading unit is picked up at the terminal
  • DROP_OFF: The loading unit is dropped off at the terminal
reference
required
string

The reference to be used in order to perform the pick up or drop off at the terminal

required
object (StarUnit)

A loading unit in the context of STAR which desribes the properties of the loading unit being picked up or dropped off

object or null (StarClientContext)

Additional context for the order in STAR that can be used when booking a corresponding SlotRequest or for correlation by the client

Responses

Request samples

Content type
application/json
Example

An order with all available properties for creation filled

{
  • "terminalId": "at_6ccc3dd538333ee0d57537efd2d2a45729ca2c672e062e1d88dc655302c66f01",
  • "action": "DROP_OFF",
  • "reference": "REF123",
  • "unit": {
    • "loadingState": "EMPTY",
    • "handlingCode": "40DV",
    • "isoCode": "42G0",
    • "number": "MSKU 123456-7",
    • "dangerousGoodsIndication": "DANGEROUS",
    • "condition": "OK",
    • "seals": [
      • {
        • "type": "OPERATOR",
        • "number": "PA02265"
        }
      ]
    },
  • "clientContext": {
    • "plannedDate": {
      • "date": "2018-01-01",
      • "timeOfDay": "EARLY"
      },
    • "internalNote": "ASDF12345"
    }
}

Response samples

Content type
application/json
{
  • "id": "0b52e366-2be7-4277-817f-70e1ba8b3917"
}

Return StarOrder

This endpoint returns details of a specific StarOrder

Authorizations:
OAuth2
path Parameters
id
required
string

The ID of the order to retrieve

Responses

Response samples

Content type
application/json
Example

An order with all properties filled

{
  • "id": "0b52e366-2be7-4277-817f-70e1ba8b3917",
  • "terminalId": "at_6ccc3dd538333ee0d57537efd2d2a45729ca2c672e062e1d88dc655302c66f01",
  • "action": "DROP_OFF",
  • "reference": "REF123",
  • "unit": {
    • "loadingState": "EMPTY",
    • "handlingCode": "40DV",
    • "number": "MSKU 123456-7",
    • "dangerousGoodsIndication": "DANGEROUS",
    • "condition": "OK",
    • "seals": [
      • {
        • "type": "OPERATOR",
        • "number": "PA02265"
        }
      ]
    },
  • "clientContext": {
    • "plannedDate": {
      • "date": "2018-01-01",
      • "timeOfDay": "EARLY"
      },
    • "internalNote": "ASDF12345"
    }
}

Update an existing order in STAR

This endpoint allows to update an existing order in STAR, if it is still in a state where it is updateable.

Authorizations:
OAuth2
path Parameters
id
required
string

The ID of the order to update

Request Body schema: application/json
required

The order to be updated

terminalId
required
string

Identifier of the location of type ADMINISTRATIVE_TERMINAL at which the STAR order should be performed. Note that the corresponding identifier can be retrieved via the Locations-API.

action
required
string
Enum: "PICK_UP" "DROP_OFF"

The type of the order that is planned

  • PICK_UP: The loading unit is picked up at the terminal
  • DROP_OFF: The loading unit is dropped off at the terminal
reference
required
string

The reference to be used in order to perform the pick up or drop off at the terminal

required
object (StarUnit)

A loading unit in the context of STAR which desribes the properties of the loading unit being picked up or dropped off

object or null (StarClientContext)

Additional context for the order in STAR that can be used when booking a corresponding SlotRequest or for correlation by the client

Responses

Request samples

Content type
application/json
Example

An order with all available properties for update filled

{
  • "terminalId": "at_6ccc3dd538333ee0d57537efd2d2a45729ca2c672e062e1d88dc655302c66f01",
  • "action": "DROP_OFF",
  • "reference": "REF123",
  • "unit": {
    • "loadingState": "EMPTY",
    • "handlingCode": "40DV",
    • "isoCode": "42G0",
    • "number": "MSKU 123456-7",
    • "dangerousGoodsIndication": "DANGEROUS",
    • "condition": "OK",
    • "seals": [
      • {
        • "type": "OPERATOR",
        • "number": "PA02265"
        }
      ]
    },
  • "clientContext": {
    • "plannedDate": {
      • "date": "2018-01-01",
      • "timeOfDay": "EARLY"
      },
    • "internalNote": "ASDF12345"
    }
}

Response samples

Content type
application/json
{
  • "messages": [
    • "The mandatory property \"my property\" was missing!"
    ]
}

Delete an existing order in STAR

Delete an existing order in STAR in case it is in a state where it can still be deleted

Authorizations:
OAuth2
path Parameters
id
required
string

The ID of the order to delete

Responses

Response samples

Content type
application/json
{
  • "messages": [
    • "The mandatory property \"my property\" was missing!"
    ]
}

Tracking

The Tracking endpoints in the COLA API enable both the retrieval of tracking information for units and the submission of observed tracking events by authorized partners.

These endpoints support real-time visibility into the movement and status of transport units throughout the supply chain. Partners can use them to:

  • Query the current status and historical movement of containers.
  • Report events they have observed (e.g. pickup, delivery, gate-in/out) to enrich COLAs tracking system.

Return Tracking Events

This endpoint returns tracking data of units. Events mark the time and location when a unit has been observed.

Authorizations:
OAuth2
query Parameters
orderId
string

The identifier of the order. To be given together with 'positionId'

positionId
string

The identifier of the position of the order. To be given together with 'orderId'

clientOrderReference
string

The client's reference for the order. To be given together with 'clientPositionReference'

clientPositionReference
string

The client's reference for the position. To be given together with 'clientOrderReference'

Responses

Response samples

Content type
application/json
{
  • "observedUntil": "2021-06-17T12:31:33.971Z",
  • "order": {
    • "orderId": "2020-1234-4543-3434",
    • "positionId": "1",
    • "clientOrderReference": "123456",
    • "clientPositionReference": "2",
    • "additionalClientOrderReferences": [
      • "string"
      ],
    • "additionalClientPositionReferences": [
      • "string"
      ],
    • "client": {
      • "id": "pa_45a8315ef1f2bd02d5e843a3a79ada2827fb733c714b25d1c83ad6c91b12dcd1",
      • "name": "Contargo GmbH & Co. KG",
      • "address": {
        • "street": "Floßhafenstraße 37",
        • "postalCode": "41460",
        • "city": "Neuss",
        • "country": {
          • "name": "Germany",
          • "code": "DE"
          }
        }
      }
    },
  • "loadingUnit": {
    • "containerClass": "CONTAINER",
    • "identification": "BIC",
    • "number": "MSKU 123456-7",
    • "sizeType": "42G0"
    },
  • "events": [
    • {
      • "id": "123e4567-e89b-12d3-a456-426614174000",
      • "timestamp": "2021-06-17T12:31:33.971Z",
      • "type": "GATE_IN",
      • "observation": {
        • "observedMeansOfTransport": {
          • "modeOfTransport": "BARGE",
          • "truck": {
            • "countryCode": "D",
            • "licensePlate": "TR XB 32",
            • "forwarder": "Deisser GmbH"
            },
          • "barge": {
            • "name": "Covano",
            • "imo": "2323931",
            • "eni": "02332799"
            },
          • "train": {
            • "identifier": "MSC-SHUTTLE-FRANKFURT"
            }
          },
        • "observedLoadingUnit": {
          • "loadingUnit": {
            • "containerClass": "CONTAINER",
            • "identification": "BIC",
            • "number": "MSKU 123456-7",
            • "sizeType": "42G0"
            },
          • "loadingState": "EMPTY",
          • "condition": "OK",
          • "weight": {
            • "gross": 13684,
            • "net": 11000,
            • "tare": 2684
            },
          • "oversize": {
            • "excessLengthFront": 0,
            • "excessLengthBack": 127,
            • "excessWidthRight": 127,
            • "excessWidthLeft": 127,
            • "excessHeight": 42
            },
          • "observedTemperature": {
            • "temperature": 17.4,
            • "humidity": 40.1
            },
          • "seals": [
            • {
              • "type": "OPERATOR",
              • "number": "PA02265"
              }
            ]
          },
        • "location": {
          • "id": "or_24277e9ef1ea8a41e4df0bb5c300aa966754f02241991d4e40d11fd3057c4fc5",
          • "designation": "Contargo Neuss GmbH",
          • "type": "ADMINISTRATIVE_TERMINAL",
          • "locationCode": "DENSS",
          • "internationalPortCode": "NLRTM",
          • "edifactLocationCode": "0APMA",
          • "address": {
            • "street": "Floßhafenstraße 37",
            • "postalCode": "41460",
            • "city": "Neuss",
            • "country": {
              • "name": "Germany",
              • "code": "DE"
              }
            },
          • "geoLocation": {
            • "coordinates": {
              • "latitude": 50.393994,
              • "longitude": 7.589209
              }
            }
          }
        }
      }
    ]
}

Report a new Tracking Event for a Position of an Order

This endpoint allows to report new Tracking Events that occurred during the transport of a unit.

Authorizations:
OAuth2
Request Body schema: application/json
required

The tracking event to be reported

object (IncomingTrackingOrder)

Information about the order related to tracking events

object (TrackingTransportIdentifier)

Identifier of the transport for which a tracking event is reported

required
object (TrackingEvent)

An event that marks the observation of a unit at a specific time and location

object (Operator)

A company that is part of and operates in the intermodal domain

Responses

Request samples

Content type
application/json
{
  • "order": {
    • "orderId": "2020-1234-4543-3434",
    • "positionId": "1",
    • "clientOrderReference": "123456",
    • "clientPositionReference": "2"
    },
  • "transport": {
    • "identifier": "{738FABEE}NHdhcmQ_dHJhPTEyMjAyMDIwMzUtMi01LTEmcG9zPTImb3JkPTEyMjAyMDIwMzU",
    • "voyageNumber": "SHP98755"
    },
  • "event": {
    • "timestamp": "2021-06-17T12:31:33.971Z",
    • "type": "GATE_IN",
    • "observation": {
      • "observedMeansOfTransport": {
        • "modeOfTransport": "BARGE",
        • "truck": {
          • "countryCode": "D",
          • "licensePlate": "TR XB 32"
          },
        • "barge": {
          • "name": "Covano",
          • "imo": "2323931",
          • "eni": "02332799"
          },
        • "train": {
          • "identifier": "MSC-SHUTTLE-FRANKFURT"
          }
        },
      • "observedLoadingUnit": {
        • "loadingUnit": {
          • "containerClass": "CONTAINER",
          • "identification": "BIC",
          • "number": "MSKU 123456-7",
          • "sizeType": "42G0"
          },
        • "loadingState": "EMPTY",
        • "condition": "OK",
        • "weight": {
          • "gross": 13684,
          • "net": 11000,
          • "tare": 2684
          },
        • "oversize": {
          • "excessLengthFront": 0,
          • "excessLengthBack": 127,
          • "excessWidthRight": 127,
          • "excessWidthLeft": 127,
          • "excessHeight": 42
          },
        • "observedTemperature": {
          • "temperature": 17.4,
          • "humidity": 40.1
          },
        • "seals": [
          • {
            • "type": "OPERATOR",
            • "number": "PA02265"
            }
          ]
        },
      • "location": {
        • "id": "or_24277e9ef1ea8a41e4df0bb5c300aa966754f02241991d4e40d11fd3057c4fc5",
        • "designation": "Contargo Neuss GmbH",
        • "type": "ADMINISTRATIVE_TERMINAL",
        • "locationCode": "DENSS",
        • "internationalPortCode": "NLRTM",
        • "edifactLocationCode": "0APMA",
        • "address": {
          • "street": "Floßhafenstraße 37",
          • "postalCode": "41460",
          • "city": "Neuss",
          • "country": {
            • "name": "Germany",
            • "code": "DE"
            }
          },
        • "geoLocation": {
          • "coordinates": {
            • "latitude": 50.393994,
            • "longitude": 7.589209
            }
          }
        }
      }
    },
  • "reporter": {
    • "id": "pa_45a8315ef1f2bd02d5e843a3a79ada2827fb733c714b25d1c83ad6c91b12dcd1",
    • "name": "Contargo GmbH & Co. KG",
    • "address": {
      • "street": "Floßhafenstraße 37",
      • "postalCode": "41460",
      • "city": "Neuss",
      • "country": {
        • "name": "Germany",
        • "code": "DE"
        }
      }
    }
}

Response samples

Content type
application/json
{
  • "messages": [
    • "The mandatory property \"my property\" was missing!"
    ]
}

Open a real-time stream of tracking events

Subscribe a client to retrieve tracking events for all of his orders. This endpoint uses ServerSentEvents (SSE) and the connection remains open indefinitely. It is the clients responsibility to reopen the connection in case of timeout or connection errors and to close it, when no further updates should be received. Note that the documented payload is part of the "data" field of each ServerSentEvent.

Authorizations:
OAuth2

Responses

Schemas

Address

street
string

The street incl. number.

postalCode
string

The postal code (zip code).

city
string

The city

object (Country)

A political state, nation, or territory in the sense of http://www.unece.org/cefact/locode/service/location

{
  • "street": "Floßhafenstraße 37",
  • "postalCode": "41460",
  • "city": "Neuss",
  • "country": {
    • "name": "Germany",
    • "code": "DE"
    }
}

ApiResponseMessage

messages
Array of strings [ 0 .. 1000 ] items

Error messages of the failed api call

{
  • "messages": [
    • "The mandatory property \"my property\" was missing!"
    ]
}

Barge

name
string

Name of the barge that processes the delivery or pick up of units

imo
string

IMO (International Maritime Organization) identifier of the barge

eni
string

ENI (European Number of Identification) of the barge

{
  • "name": "Covano",
  • "imo": "2323931",
  • "eni": "02332799"
}

Coordinates

latitude
number <double>

The latitude (in decimal degrees) specifies the north–south position of a point on the Earth's surface.

longitude
number <double>

The longitude (in decimal degrees) specifies the east–west position of a point on the Earth's surface.

{
  • "latitude": 50.393994,
  • "longitude": 7.589209
}

Country

name
string

The (english) name of the country, as specified by the UN country code mapping

code
string

The two digit UN code of the country, see http://www.unece.org/cefact/locode/service/location for details

{
  • "name": "Germany",
  • "code": "DE"
}

GeoLocation

object or null (Coordinates)

Coordinates of a location in latitude and longitude.

{
  • "coordinates": {
    • "latitude": 50.393994,
    • "longitude": 7.589209
    }
}

IncomingTrackingOrder

orderId
required
string

The unique Contargo identifier for this Order

positionId
required
string

Identifies the position in an order, as provided by Contargo. This identifier is unique within this order.

clientOrderReference
string

Reference for the order used by the client.

clientPositionReference
string

Reference for the position used by the client. This must be an unique identifier within htis order.

{
  • "orderId": "2020-1234-4543-3434",
  • "positionId": "1",
  • "clientOrderReference": "123456",
  • "clientPositionReference": "2"
}

LoadingUnitObservation

object (LoadingUnitTracking)

A loading unit that was observed at some location. Note that this is similar, but not identical to the content of the "Loading Unit" schema.

loadingState
string
Default: "UNKNOWN"
Enum: "FULL" "EMPTY" "UNKNOWN"

The loading state of a loading unit

  • FULL: A loading unit that contains one or more goods for transport
  • EMPTY: A loading unit that does not contain any goods (but may contain flexitanks, inlets, etc.)
  • UNKNOWN: Unknown loading state
condition
string
Default: "UNKNOWN"
Enum: "OK" "DAMAGED" "UNKNOWN"

Condition the loading unit is in

  • OK: An undamaged loading unit
  • DAMAGED: A damaged loading unit
  • UNKNOWN: A loading unit in unknown condition
object (Weight)

Describes weight of an entity, e.g. goods or loading units

object (Oversize)

Describes oversize of a good, relative to the loading unit the good is contained in. All given values have to be read as if you are standing in front of the unit's door (facing to it)

object or null (ObservedTemperature)

Describes the observed temperature of a temperature controlled loading unit ("reefer")

Array of objects (Seal) [ 0 .. 100 ] items

Seals that are present on the loading unit

{
  • "loadingUnit": {
    • "containerClass": "CONTAINER",
    • "identification": "BIC",
    • "number": "MSKU 123456-7",
    • "sizeType": "42G0"
    },
  • "loadingState": "EMPTY",
  • "condition": "OK",
  • "weight": {
    • "gross": 13684,
    • "net": 11000,
    • "tare": 2684
    },
  • "oversize": {
    • "excessLengthFront": 0,
    • "excessLengthBack": 127,
    • "excessWidthRight": 127,
    • "excessWidthLeft": 127,
    • "excessHeight": 42
    },
  • "observedTemperature": {
    • "temperature": 17.4,
    • "humidity": 40.1
    },
  • "seals": [
    • {
      • "type": "OPERATOR",
      • "number": "PA02265"
      }
    ]
}

LoadingUnitTracking

containerClass
required
string
Enum: "CONTAINER" "SWAP_BODY" "TRAILER" "VEHICLE" "MAFI" "NON_MOBILE" "OTHER"

The class of loading units that can be used to transport goods. Each class has different characteristics, e.g some of them are standardized, while others are not

  • CONTAINER: A standardized container according to ISO 668 (https://de.wikipedia.org/wiki/ISO-Container).
  • SWAP_BODY: A non standardized container (german: Wechselaufbau, Wechselbehälter, Wechselbrücke)
  • TRAILER: A trailer without a front axle (https://de.wikipedia.org/wiki/Sattelauflieger). german: Sattelauflieger
  • VEHICLE: Other types of vehicles that don't match any more specific type
  • MAFI: A specialized vehicle to move loading units on site, e.g. in a terminal or seaport
  • NON_MOBILE: Other types of non-mobile loading units.
  • OTHER: All other types of loading units
identification
string or null
Enum: "BIC" "ILU" "SOC" "OTHER"

Type of identifier that is used in order to identify the loading unit

  • BIC: Bureau International des Containers et du Transport Intermodal (BIC) code according to ISO 6346 for ISO containers
  • ILU: Intermodal loading unit (ILU) code according to EN 13044-1 for swap bodies and trailers
  • SOC: Shipper Owned Container (SOC) with no standardized format
  • OTHER: Any other type of identifier
number
string or null

Number that identifies the loading unit

sizeType
string or null

ISO container size type (DIN EN ISO 6346), also known as "iso code"

{
  • "containerClass": "CONTAINER",
  • "identification": "BIC",
  • "number": "MSKU 123456-7",
  • "sizeType": "42G0"
}

Location

id
string

Unique identifier of the location

designation
required
string

Name of the location

type
string
Enum: "ORGANISATION" "ADMINISTRATIVE_TERMINAL" "OPERATIONAL_TERMINAL" "HINTERLAND_TERMINAL" "LOADINGPLACE" "SEAPORT" "SEAPORT_TERMINAL" "UNKNOWN"

The type of a location

  • ORGANISATION: The location of an organisation
  • ADMINISTRATIVE_TERMINAL: The location a (Contargo) administrative terminal
  • OPERATIONAL_TERMINAL: The location of a (Contargo) operational terminal
  • HINTERLAND_TERMINAL: The location of a (non-Contargo) hinterland terminal
  • LOADINGPLACE: The location of a loadingplace
  • SEAPORT: The location of a seaport
  • SEAPORT_TERMINAL: The location of a seaport terminal
  • UNKNOWN: A location of unknown type
locationCode
string or null

The UN location code of the city in which the location resides (if applicable).

internationalPortCode
string or null

The international port code (in case this is a SEAPORT or a SEAPORT_TERMINAL)

edifactLocationCode
string or null

The location code used in edifact messages, also known as "BICS code" or "term code"

object (Address)

A physical address that describes a location, e.g. of a terminal.

object (GeoLocation)

A physical location described by one or multiple codes.

{
  • "id": "or_24277e9ef1ea8a41e4df0bb5c300aa966754f02241991d4e40d11fd3057c4fc5",
  • "designation": "Contargo Neuss GmbH",
  • "type": "ADMINISTRATIVE_TERMINAL",
  • "locationCode": "DENSS",
  • "internationalPortCode": "NLRTM",
  • "edifactLocationCode": "0APMA",
  • "address": {
    • "street": "Floßhafenstraße 37",
    • "postalCode": "41460",
    • "city": "Neuss",
    • "country": {
      • "name": "Germany",
      • "code": "DE"
      }
    },
  • "geoLocation": {
    • "coordinates": {
      • "latitude": 50.393994,
      • "longitude": 7.589209
      }
    }
}

MeansOfTransportObservation

modeOfTransport
string
Default: "UNKNOWN"
Enum: "BARGE" "RAIL" "TRUCK" "UNKNOWN"

The mode of transport that was used

  • BARGE: Transport is performed by barge
  • RAIL: Transport is performed by train
  • TRUCK: Transport is performed by truck
  • UNKNOWN: The means of transport is not (yet) known
object or null (Truck)

A vehicle that is used to transport full or empty Units between loading places

object or null (Barge)

A barge that is used to transport full or empty Units between terminals

object or null (Train)

A train that is used to transport full or empty Units between loading places

{
  • "modeOfTransport": "BARGE",
  • "truck": {
    • "countryCode": "D",
    • "licensePlate": "TR XB 32",
    • "forwarder": "Deisser GmbH"
    },
  • "barge": {
    • "name": "Covano",
    • "imo": "2323931",
    • "eni": "02332799"
    },
  • "train": {
    • "identifier": "MSC-SHUTTLE-FRANKFURT"
    }
}

Observation

object (MeansOfTransportObservation)

The observations that have been made regarding the means of transport

object (LoadingUnitObservation)

The observations that have been made regarding the loading unit

object (Location)

A location at which an action in the context of the intermodal domain can occur

{
  • "observedMeansOfTransport": {
    • "modeOfTransport": "BARGE",
    • "truck": {
      • "countryCode": "D",
      • "licensePlate": "TR XB 32",
      • "forwarder": "Deisser GmbH"
      },
    • "barge": {
      • "name": "Covano",
      • "imo": "2323931",
      • "eni": "02332799"
      },
    • "train": {
      • "identifier": "MSC-SHUTTLE-FRANKFURT"
      }
    },
  • "observedLoadingUnit": {
    • "loadingUnit": {
      • "containerClass": "CONTAINER",
      • "identification": "BIC",
      • "number": "MSKU 123456-7",
      • "sizeType": "42G0"
      },
    • "loadingState": "EMPTY",
    • "condition": "OK",
    • "weight": {
      • "gross": 13684,
      • "net": 11000,
      • "tare": 2684
      },
    • "oversize": {
      • "excessLengthFront": 0,
      • "excessLengthBack": 127,
      • "excessWidthRight": 127,
      • "excessWidthLeft": 127,
      • "excessHeight": 42
      },
    • "observedTemperature": {
      • "temperature": 17.4,
      • "humidity": 40.1
      },
    • "seals": [
      • {
        • "type": "OPERATOR",
        • "number": "PA02265"
        }
      ]
    },
  • "location": {
    • "id": "or_24277e9ef1ea8a41e4df0bb5c300aa966754f02241991d4e40d11fd3057c4fc5",
    • "designation": "Contargo Neuss GmbH",
    • "type": "ADMINISTRATIVE_TERMINAL",
    • "locationCode": "DENSS",
    • "internationalPortCode": "NLRTM",
    • "edifactLocationCode": "0APMA",
    • "address": {
      • "street": "Floßhafenstraße 37",
      • "postalCode": "41460",
      • "city": "Neuss",
      • "country": {
        • "name": "Germany",
        • "code": "DE"
        }
      },
    • "geoLocation": {
      • "coordinates": {
        • "latitude": 50.393994,
        • "longitude": 7.589209
        }
      }
    }
}

ObservedTemperature

temperature
number <double>

The temperature that the loading unit is currently set to have (in degrees celsius)

humidity
number <double>

The humidity that the loading unit is currently set to have (in percent)

{
  • "temperature": 17.4,
  • "humidity": 40.1
}

Operator

id
string

Unique identifier of the operator.

name
string

Name of the operator

object (Address)

A physical address that describes a location, e.g. of a terminal.

{
  • "id": "pa_45a8315ef1f2bd02d5e843a3a79ada2827fb733c714b25d1c83ad6c91b12dcd1",
  • "name": "Contargo GmbH & Co. KG",
  • "address": {
    • "street": "Floßhafenstraße 37",
    • "postalCode": "41460",
    • "city": "Neuss",
    • "country": {
      • "name": "Germany",
      • "code": "DE"
      }
    }
}

Oversize

excessLengthFront
integer <int32>

Excess length of the good in front of the loading unit. Relative to the loading unit (in full centimeters)

excessLengthBack
integer <int32>

Excess length of the good to the back of the loading unit. Relative to the loading unit (in full centimeters)

excessWidthRight
integer <int32>

Excess width of the good to the right of the loading unit. Relative to the loading unit (in full centimeters)

excessWidthLeft
integer <int32>

Excess width of the good to the left of the loading unit. Relative to the loading unit (in full centimeters)

excessHeight
integer <int32>

Excess height of the good, relative to the loading unit (in full centimeters)

{
  • "excessLengthFront": 0,
  • "excessLengthBack": 127,
  • "excessWidthRight": 127,
  • "excessWidthLeft": 127,
  • "excessHeight": 42
}

PaginatedLocationResponse

object (Pagination)

Contains meta information about pagination

Array of objects (Location) [ 0 .. 1000 ] items

Contains the data of the requested page

{
  • "pagination": {
    • "currentPage": 1,
    • "pageSize": 50,
    • "total": 1337
    },
  • "data": [
    • {
      • "id": "or_24277e9ef1ea8a41e4df0bb5c300aa966754f02241991d4e40d11fd3057c4fc5",
      • "designation": "Contargo Neuss GmbH",
      • "type": "ADMINISTRATIVE_TERMINAL",
      • "locationCode": "DENSS",
      • "internationalPortCode": "NLRTM",
      • "edifactLocationCode": "0APMA",
      • "address": {
        • "street": "Floßhafenstraße 37",
        • "postalCode": "41460",
        • "city": "Neuss",
        • "country": {
          • "name": "Germany",
          • "code": "DE"
          }
        },
      • "geoLocation": {
        • "coordinates": {
          • "latitude": 50.393994,
          • "longitude": 7.589209
          }
        }
      }
    ]
}

Pagination

currentPage
integer <int32>

The 1-based index of the current page

pageSize
integer <int32>

The max. size of the current page

total
integer <int32>

The total number of data elements

{
  • "currentPage": 1,
  • "pageSize": 50,
  • "total": 1337
}

Seal

type
string
Enum: "OPERATOR" "CUSTOMS" "UNKNOWN"

Type of the seal, usually determined by the entity that puts the seal on a loading unit

  • OPERATOR: A seal that was put on the loading unit from the operator
  • CUSTOMS: A seal that was put on the loading unit from a customs agency
  • UNKNOWN: A seal of unknown type
number
string

Unique seal number

{
  • "type": "OPERATOR",
  • "number": "PA02265"
}

StarClientContext

object or null (StarPlannedDate)

A preliminary time for which the order is planned to be executed

internalNote
string or null <= 20 characters [a-zA-Z0-9\-/#\\]

A note that can be used for correlation information

{
  • "plannedDate": {
    • "date": "2018-01-01",
    • "timeOfDay": "EARLY"
    },
  • "internalNote": "ASDF12345"
}

StarOrder

id
string

Unique identifier of the STAR order

terminalId
required
string

Identifier of the location of type ADMINISTRATIVE_TERMINAL at which the STAR order should be performed. Note that the corresponding identifier can be retrieved via the Locations-API.

action
required
string
Enum: "PICK_UP" "DROP_OFF"

The type of the order that is planned

  • PICK_UP: The loading unit is picked up at the terminal
  • DROP_OFF: The loading unit is dropped off at the terminal
reference
required
string

The reference to be used in order to perform the pick up or drop off at the terminal

required
object (StarUnit)

A loading unit in the context of STAR which desribes the properties of the loading unit being picked up or dropped off

object or null (StarClientContext)

Additional context for the order in STAR that can be used when booking a corresponding SlotRequest or for correlation by the client

{
  • "id": "0b52e366-2be7-4277-817f-70e1ba8b3917",
  • "terminalId": "at_6ccc3dd538333ee0d57537efd2d2a45729ca2c672e062e1d88dc655302c66f01",
  • "action": "DROP_OFF",
  • "reference": "REF123",
  • "unit": {
    • "loadingState": "EMPTY",
    • "handlingCode": "40DV",
    • "number": "MSKU 123456-7",
    • "dangerousGoodsIndication": "DANGEROUS",
    • "condition": "OK",
    • "seals": [
      • {
        • "type": "OPERATOR",
        • "number": "PA02265"
        }
      ]
    },
  • "clientContext": {
    • "plannedDate": {
      • "date": "2018-01-01",
      • "timeOfDay": "EARLY"
      },
    • "internalNote": "ASDF12345"
    }
}

StarOrderCreated

id
string

Unique identifier of a STAR order

{
  • "id": "0b52e366-2be7-4277-817f-70e1ba8b3917"
}

StarPlannedDate

date
string <date>

The date for which the order is scheduled

timeOfDay
string
Enum: "UNKNOWN" "EARLY" "MIDDAY" "LATE"

The time of day at which the order is planned to be executed

  • UNKNOWN: The time is unknown
  • EARLY: The order is scheduled to be early in the day
  • MIDDAY: The order is scheduled to be in the middle of the day
  • LATE: The order is scheduled to be late in the day
{
  • "date": "2018-01-01",
  • "timeOfDay": "EARLY"
}

StarUnit

loadingState
required
string
Enum: "FULL" "EMPTY" "UNKNOWN"

The loading state of a loading unit

  • FULL: A loading unit that contains one or more goods for transport
  • EMPTY: A loading unit that does not contain any goods (but may contain flexitanks, inlets, etc.)
  • UNKNOWN: Unknown loading state
handlingCode
string or null

Handling code used by Contargo in order to specify the (general) type of loading unit, e.g. in case a specific ISO code is not known yet or not relevant. Either the "handlingCode" or the "isoCode" must be given.

isoCode
string or null

ISO container size type (DIN EN ISO 6346) to specify the type of loading unit. May be intepreted broadly and reference the whole group of corresponding size types. Either the "handlingCode" or the "isoCode" must be given.

number
string or null

Number that identifies the loading unit

dangerousGoodsIndication
string
Enum: "DANGEROUS" "NOT_DANGEROUS" "UNKNOWN"

Indicates if a loading unit is going to contain dangerous goods or not

  • DANGEROUS: The unit currently does or will eventually contain dangerous goods during the transport or is planned to be used for a dangerous goods transport on the return leg, i.e. driver and vehicle should be ready to support this although no actual dangerous goods will be present in the unit yet
  • NOT_DANGEROUS: The unit won't contain dangerous goods during the transport, i.e. neither in the current transport not subsequent legs
  • UNKNOWN: It is (currently) unknown, wether or not the unit will contain dangerous goods during the transport. Note that this has to be specified eventually, before the order can be used for booking a SlotRequest.
condition
string
Enum: "OK" "DAMAGED" "UNKNOWN"

Condition the loading unit is in

  • OK: An undamaged loading unit
  • DAMAGED: A damaged loading unit
  • UNKNOWN: A loading unit in unknown condition
Array of objects (Seal) [ 0 .. 100 ] items

Seals that are present on the loading unit

{
  • "loadingState": "EMPTY",
  • "handlingCode": "40DV",
  • "number": "MSKU 123456-7",
  • "dangerousGoodsIndication": "DANGEROUS",
  • "condition": "OK",
  • "seals": [
    • {
      • "type": "OPERATOR",
      • "number": "PA02265"
      }
    ]
}

TrackedUnit

observedUntil
required
string <date-time>

The point in time until which the tracking events occurred. Events observed after this point will not be part of this response.

required
object (TrackingOrder)

Information about the order related to tracking events

object (LoadingUnitTracking)

A loading unit that was observed at some location. Note that this is similar, but not identical to the content of the "Loading Unit" schema.

required
Array of objects (TrackingEvent) [ 0 .. 100 ] items

The observed events that occurred regarding the tracked unit.

{
  • "observedUntil": "2021-06-17T12:31:33.971Z",
  • "order": {
    • "orderId": "2020-1234-4543-3434",
    • "positionId": "1",
    • "clientOrderReference": "123456",
    • "clientPositionReference": "2",
    • "additionalClientOrderReferences": [
      • "string"
      ],
    • "additionalClientPositionReferences": [
      • "string"
      ],
    • "client": {
      • "id": "pa_45a8315ef1f2bd02d5e843a3a79ada2827fb733c714b25d1c83ad6c91b12dcd1",
      • "name": "Contargo GmbH & Co. KG",
      • "address": {
        • "street": "Floßhafenstraße 37",
        • "postalCode": "41460",
        • "city": "Neuss",
        • "country": {
          • "name": "Germany",
          • "code": "DE"
          }
        }
      }
    },
  • "loadingUnit": {
    • "containerClass": "CONTAINER",
    • "identification": "BIC",
    • "number": "MSKU 123456-7",
    • "sizeType": "42G0"
    },
  • "events": [
    • {
      • "id": "123e4567-e89b-12d3-a456-426614174000",
      • "timestamp": "2021-06-17T12:31:33.971Z",
      • "type": "GATE_IN",
      • "observation": {
        • "observedMeansOfTransport": {
          • "modeOfTransport": "BARGE",
          • "truck": {
            • "countryCode": "D",
            • "licensePlate": "TR XB 32",
            • "forwarder": "Deisser GmbH"
            },
          • "barge": {
            • "name": "Covano",
            • "imo": "2323931",
            • "eni": "02332799"
            },
          • "train": {
            • "identifier": "MSC-SHUTTLE-FRANKFURT"
            }
          },
        • "observedLoadingUnit": {
          • "loadingUnit": {
            • "containerClass": "CONTAINER",
            • "identification": "BIC",
            • "number": "MSKU 123456-7",
            • "sizeType": "42G0"
            },
          • "loadingState": "EMPTY",
          • "condition": "OK",
          • "weight": {
            • "gross": 13684,
            • "net": 11000,
            • "tare": 2684
            },
          • "oversize": {
            • "excessLengthFront": 0,
            • "excessLengthBack": 127,
            • "excessWidthRight": 127,
            • "excessWidthLeft": 127,
            • "excessHeight": 42
            },
          • "observedTemperature": {
            • "temperature": 17.4,
            • "humidity": 40.1
            },
          • "seals": [
            • {
              • "type": "OPERATOR",
              • "number": "PA02265"
              }
            ]
          },
        • "location": {
          • "id": "or_24277e9ef1ea8a41e4df0bb5c300aa966754f02241991d4e40d11fd3057c4fc5",
          • "designation": "Contargo Neuss GmbH",
          • "type": "ADMINISTRATIVE_TERMINAL",
          • "locationCode": "DENSS",
          • "internationalPortCode": "NLRTM",
          • "edifactLocationCode": "0APMA",
          • "address": {
            • "street": "Floßhafenstraße 37",
            • "postalCode": "41460",
            • "city": "Neuss",
            • "country": {
              • "name": "Germany",
              • "code": "DE"
              }
            },
          • "geoLocation": {
            • "coordinates": {
              • "latitude": 50.393994,
              • "longitude": 7.589209
              }
            }
          }
        }
      }
    ]
}

TrackingEvent

id
string

Unique identifier of the tracking event

timestamp
required
string <date-time>

The exact time when the event occured in UTC

type
required
string
Default: "UNKNOWN"
Enum: "GATE_OUT" "GATE_IN" "ARRIVED" "DEPARTED" "HANDLING_STARTED" "HANDLING_FINISHED" "UNKNOWN"

Type of event; list of possible values is not complete and may be extended in the future. Clients should deal with unknown values gracefully.

  • GATE_OUT: Event is triggered when a unit is observed passing a gate on the way out.
  • GATE_IN: Event is triggered when a unit is observed passing a gate on the way in.
  • ARRIVED: Event is triggered when a unit is observed arriving at a loading place.
  • DEPARTED: Event is triggered when a unit is observed leaving a loading place.
  • HANDLING_STARTED: Event is triggered when handling of a unit at a terminal has started.
  • HANDLING_FINISHED: Event is triggered when handling of a unit at a terminal has been finished.
  • UNKNOWN: Event of type that could not be mapped to any exposed type has been observed.
object (Observation)

The observations that have been made, e.g. regarding the tracked loading unit or means of transport

{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "timestamp": "2021-06-17T12:31:33.971Z",
  • "type": "GATE_IN",
  • "observation": {
    • "observedMeansOfTransport": {
      • "modeOfTransport": "BARGE",
      • "truck": {
        • "countryCode": "D",
        • "licensePlate": "TR XB 32",
        • "forwarder": "Deisser GmbH"
        },
      • "barge": {
        • "name": "Covano",
        • "imo": "2323931",
        • "eni": "02332799"
        },
      • "train": {
        • "identifier": "MSC-SHUTTLE-FRANKFURT"
        }
      },
    • "observedLoadingUnit": {
      • "loadingUnit": {
        • "containerClass": "CONTAINER",
        • "identification": "BIC",
        • "number": "MSKU 123456-7",
        • "sizeType": "42G0"
        },
      • "loadingState": "EMPTY",
      • "condition": "OK",
      • "weight": {
        • "gross": 13684,
        • "net": 11000,
        • "tare": 2684
        },
      • "oversize": {
        • "excessLengthFront": 0,
        • "excessLengthBack": 127,
        • "excessWidthRight": 127,
        • "excessWidthLeft": 127,
        • "excessHeight": 42
        },
      • "observedTemperature": {
        • "temperature": 17.4,
        • "humidity": 40.1
        },
      • "seals": [
        • {
          • "type": "OPERATOR",
          • "number": "PA02265"
          }
        ]
      },
    • "location": {
      • "id": "or_24277e9ef1ea8a41e4df0bb5c300aa966754f02241991d4e40d11fd3057c4fc5",
      • "designation": "Contargo Neuss GmbH",
      • "type": "ADMINISTRATIVE_TERMINAL",
      • "locationCode": "DENSS",
      • "internationalPortCode": "NLRTM",
      • "edifactLocationCode": "0APMA",
      • "address": {
        • "street": "Floßhafenstraße 37",
        • "postalCode": "41460",
        • "city": "Neuss",
        • "country": {
          • "name": "Germany",
          • "code": "DE"
          }
        },
      • "geoLocation": {
        • "coordinates": {
          • "latitude": 50.393994,
          • "longitude": 7.589209
          }
        }
      }
    }
}

TrackingEventReport

object (IncomingTrackingOrder)

Information about the order related to tracking events

object (TrackingTransportIdentifier)

Identifier of the transport for which a tracking event is reported

required
object (TrackingEvent)

An event that marks the observation of a unit at a specific time and location

object (Operator)

A company that is part of and operates in the intermodal domain

{
  • "order": {
    • "orderId": "2020-1234-4543-3434",
    • "positionId": "1",
    • "clientOrderReference": "123456",
    • "clientPositionReference": "2"
    },
  • "transport": {
    • "identifier": "{738FABEE}NHdhcmQ_dHJhPTEyMjAyMDIwMzUtMi01LTEmcG9zPTImb3JkPTEyMjAyMDIwMzU",
    • "voyageNumber": "SHP98755"
    },
  • "event": {
    • "id": "123e4567-e89b-12d3-a456-426614174000",
    • "timestamp": "2021-06-17T12:31:33.971Z",
    • "type": "GATE_IN",
    • "observation": {
      • "observedMeansOfTransport": {
        • "modeOfTransport": "BARGE",
        • "truck": {
          • "countryCode": "D",
          • "licensePlate": "TR XB 32",
          • "forwarder": "Deisser GmbH"
          },
        • "barge": {
          • "name": "Covano",
          • "imo": "2323931",
          • "eni": "02332799"
          },
        • "train": {
          • "identifier": "MSC-SHUTTLE-FRANKFURT"
          }
        },
      • "observedLoadingUnit": {
        • "loadingUnit": {
          • "containerClass": "CONTAINER",
          • "identification": "BIC",
          • "number": "MSKU 123456-7",
          • "sizeType": "42G0"
          },
        • "loadingState": "EMPTY",
        • "condition": "OK",
        • "weight": {
          • "gross": 13684,
          • "net": 11000,
          • "tare": 2684
          },
        • "oversize": {
          • "excessLengthFront": 0,
          • "excessLengthBack": 127,
          • "excessWidthRight": 127,
          • "excessWidthLeft": 127,
          • "excessHeight": 42
          },
        • "observedTemperature": {
          • "temperature": 17.4,
          • "humidity": 40.1
          },
        • "seals": [
          • {
            • "type": "OPERATOR",
            • "number": "PA02265"
            }
          ]
        },
      • "location": {
        • "id": "or_24277e9ef1ea8a41e4df0bb5c300aa966754f02241991d4e40d11fd3057c4fc5",
        • "designation": "Contargo Neuss GmbH",
        • "type": "ADMINISTRATIVE_TERMINAL",
        • "locationCode": "DENSS",
        • "internationalPortCode": "NLRTM",
        • "edifactLocationCode": "0APMA",
        • "address": {
          • "street": "Floßhafenstraße 37",
          • "postalCode": "41460",
          • "city": "Neuss",
          • "country": {
            • "name": "Germany",
            • "code": "DE"
            }
          },
        • "geoLocation": {
          • "coordinates": {
            • "latitude": 50.393994,
            • "longitude": 7.589209
            }
          }
        }
      }
    },
  • "reporter": {
    • "id": "pa_45a8315ef1f2bd02d5e843a3a79ada2827fb733c714b25d1c83ad6c91b12dcd1",
    • "name": "Contargo GmbH & Co. KG",
    • "address": {
      • "street": "Floßhafenstraße 37",
      • "postalCode": "41460",
      • "city": "Neuss",
      • "country": {
        • "name": "Germany",
        • "code": "DE"
        }
      }
    }
}

TrackingOrder

orderId
string

The unique Contargo identifier for this Order

positionId
string

Identifies the position in an order, as provided by Contargo. This identifier is unique within this order.

clientOrderReference
string

Reference for the order used by the client.

clientPositionReference
string

Reference for the position used by the client. This must be an unique identifier within htis order.

additionalClientOrderReferences
Array of strings [ 0 .. 100 ] items

Additional references to the order given by the client that may be used for correlation on the client side

additionalClientPositionReferences
Array of strings [ 0 .. 100 ] items

Additional references to the position given by the client that may be used for correlation on the client side

object (Operator)

A company that is part of and operates in the intermodal domain

{
  • "orderId": "2020-1234-4543-3434",
  • "positionId": "1",
  • "clientOrderReference": "123456",
  • "clientPositionReference": "2",
  • "additionalClientOrderReferences": [
    • "string"
    ],
  • "additionalClientPositionReferences": [
    • "string"
    ],
  • "client": {
    • "id": "pa_45a8315ef1f2bd02d5e843a3a79ada2827fb733c714b25d1c83ad6c91b12dcd1",
    • "name": "Contargo GmbH & Co. KG",
    • "address": {
      • "street": "Floßhafenstraße 37",
      • "postalCode": "41460",
      • "city": "Neuss",
      • "country": {
        • "name": "Germany",
        • "code": "DE"
        }
      }
    }
}

TrackingSseEvent

id
string

Unique identifier of the tracking event

event
string

The type of event

retry
integer <int32>

The minimum time in milliseconds after which a reconnect should occur

comment
string

An optional comment regarding the event

object (TrackingEvent)

An event that marks the observation of a unit at a specific time and location

{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "event": "gate-out",
  • "retry": 60000,
  • "comment": "An optional comment",
  • "data": {
    • "id": "123e4567-e89b-12d3-a456-426614174000",
    • "timestamp": "2021-06-17T12:31:33.971Z",
    • "type": "GATE_IN",
    • "observation": {
      • "observedMeansOfTransport": {
        • "modeOfTransport": "BARGE",
        • "truck": {
          • "countryCode": "D",
          • "licensePlate": "TR XB 32",
          • "forwarder": "Deisser GmbH"
          },
        • "barge": {
          • "name": "Covano",
          • "imo": "2323931",
          • "eni": "02332799"
          },
        • "train": {
          • "identifier": "MSC-SHUTTLE-FRANKFURT"
          }
        },
      • "observedLoadingUnit": {
        • "loadingUnit": {
          • "containerClass": "CONTAINER",
          • "identification": "BIC",
          • "number": "MSKU 123456-7",
          • "sizeType": "42G0"
          },
        • "loadingState": "EMPTY",
        • "condition": "OK",
        • "weight": {
          • "gross": 13684,
          • "net": 11000,
          • "tare": 2684
          },
        • "oversize": {
          • "excessLengthFront": 0,
          • "excessLengthBack": 127,
          • "excessWidthRight": 127,
          • "excessWidthLeft": 127,
          • "excessHeight": 42
          },
        • "observedTemperature": {
          • "temperature": 17.4,
          • "humidity": 40.1
          },
        • "seals": [
          • {
            • "type": "OPERATOR",
            • "number": "PA02265"
            }
          ]
        },
      • "location": {
        • "id": "or_24277e9ef1ea8a41e4df0bb5c300aa966754f02241991d4e40d11fd3057c4fc5",
        • "designation": "Contargo Neuss GmbH",
        • "type": "ADMINISTRATIVE_TERMINAL",
        • "locationCode": "DENSS",
        • "internationalPortCode": "NLRTM",
        • "edifactLocationCode": "0APMA",
        • "address": {
          • "street": "Floßhafenstraße 37",
          • "postalCode": "41460",
          • "city": "Neuss",
          • "country": {
            • "name": "Germany",
            • "code": "DE"
            }
          },
        • "geoLocation": {
          • "coordinates": {
            • "latitude": 50.393994,
            • "longitude": 7.589209
            }
          }
        }
      }
    }
}

TrackingTransportIdentifier

identifier
string

The unique identifier of the transport for which feasibility is reported

voyageNumber
string

Identifier of the voyage onto which the transport is booked

{
  • "identifier": "{738FABEE}NHdhcmQ_dHJhPTEyMjAyMDIwMzUtMi01LTEmcG9zPTImb3JkPTEyMjAyMDIwMzU",
  • "voyageNumber": "SHP98755"
}

Train

identifier
string

Identifier of the train that processes the delivery or pick up of units

{
  • "identifier": "MSC-SHUTTLE-FRANKFURT"
}

Truck

countryCode
string

EU country code of the truck that processes the delivery or pick up of units. Can be left empty, when the country code is unknown

licensePlate
string

License plate of the truck that processes the delivery or pick up of units

forwarder
string

Company that has taken the order to transport goods from A to B

{
  • "countryCode": "D",
  • "licensePlate": "TR XB 32",
  • "forwarder": "Deisser GmbH"
}

Weight

gross
number

gross weight in kg

net
number

net weight in kg

tare
number

tare weight in kg

{
  • "gross": 13684,
  • "net": 11000,
  • "tare": 2684
}