Skip to content

Adds a new Trip

Request

Security
BearerToken
Bodyapplication/json
entityTypestring
Value:"trip"
Example:"trip"
idstring

Uniquely identifies this entity. A URI can be assigned by the client to indicate where more information can be retrieved. Note that every entity always has a unique EntityId. However since, OTM5.2 it is not required to send it in the request. One can be generated for you by the server.

Example:"50824123-0924-4563-ac1e-ca0e37487823"
namestring

Name of the entity. For display purposes and search only.

Example:"Daily supply trip"
creationDatestring, (date-time)

The creation date of this entity.

lastModifiedstring, (date-time)

The last modified date of this entity. If none is given the creation date is used instead.

contextEventsArray of any(event)

The context events provides some optional information about the events that can provide additional information on the current state of this entity.

For example: your system might send ETA information for the arrival of a vehicle on a location. To make it clear what caused this ETA to be updated, we can include some information about what caused this ETA update by including an event as context. If your ETA update was caused by a location update, this event can be included as context. If the ETA was caused by a traffic accident on the route of the vehicle, you can include that event in the context.

externalAttributesobject
externalIdentifiersArray of objects(externalIdentifiers)

Standardized identifiers of this entity as known in external systems. Use this to exchange repeatable partner or system specific identifiers without overloading externalAttributes.

Example:
[
  {
    "id": "AAA",
    "scheme": "CAS"
  }
]
statusstring(status)

Status defines whether this entity (e.g. trip or consignment) is a draft, requested, confirmed, in transit, completed, closed, rejected or cancelled. Status closed is about administrative closure, while completed is about the realization of e.g. a trip or consignment. A trip or consignment can be completed but not closed yet, e.g. when the invoice has not been paid yet. The values accepted (replaced by confirmed) and modified (replaced the lastModified field on every entity) are deprecated since OTM5.1, but will be supported for the whole OTM5.X line.

Enum:"draft""requested""rejected""confirmed""inTransit""completed""closed""cancelled""accepted""modified"
Example:"inTransit"
transportModestring

Method of transport used for the carriage of goods on this trip, can either be using a ship (maritime or inland waterway), a truck/car/van/bike/etc. (road), using the train (rail), or using a plane (air). These values are based on the recommendation of UNECE.

Enum:"maritime""road""rail""air""inlandWaterway"
Example:"road"
vehicleany
Example:
{
  "uuid": "b9bb914d-845e-46f2-91ff-31fa4bac2fbe",
  "entityType": "vehicle",
  "associationType": "reference"
}
actorsArray of any

The actors associated with this trip, for instance the client or the executing party

actionsArray of any(action-association)

All actions that are/were happening on this trip, such as stopping at certain locations and loading and unloading of consignments.

constraintany
curl -i -X PUT \
  https://otm-api-spec.redocly.app/_mock/api/5.9/otm/api/v5/trips \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "50824123-0924-4563-ac1e-ca0e37487823",
    "name": "Daily supply trip",
    "status": "inTransit",
    "transportMode": "road",
    "vehicle": {
      "uuid": "b9bb914d-845e-46f2-91ff-31fa4bac2fbe",
      "entityType": "vehicle",
      "associationType": "reference"
    }
  }'

Responses

The same entity

Bodyapplication/json
entityTypestring
Value:"trip"
Example:"trip"
idstring

Uniquely identifies this entity. A URI can be assigned by the client to indicate where more information can be retrieved. Note that every entity always has a unique EntityId. However since, OTM5.2 it is not required to send it in the request. One can be generated for you by the server.

Example:"50824123-0924-4563-ac1e-ca0e37487823"
namestring

Name of the entity. For display purposes and search only.

Example:"Daily supply trip"
creationDatestring, (date-time)

The creation date of this entity.

lastModifiedstring, (date-time)

The last modified date of this entity. If none is given the creation date is used instead.

contextEventsArray of any(event)

The context events provides some optional information about the events that can provide additional information on the current state of this entity.

For example: your system might send ETA information for the arrival of a vehicle on a location. To make it clear what caused this ETA to be updated, we can include some information about what caused this ETA update by including an event as context. If your ETA update was caused by a location update, this event can be included as context. If the ETA was caused by a traffic accident on the route of the vehicle, you can include that event in the context.

externalAttributesobject
externalIdentifiersArray of objects(externalIdentifiers)

Standardized identifiers of this entity as known in external systems. Use this to exchange repeatable partner or system specific identifiers without overloading externalAttributes.

Example:
[
  {
    "id": "AAA",
    "scheme": "CAS"
  }
]
statusstring(status)

Status defines whether this entity (e.g. trip or consignment) is a draft, requested, confirmed, in transit, completed, closed, rejected or cancelled. Status closed is about administrative closure, while completed is about the realization of e.g. a trip or consignment. A trip or consignment can be completed but not closed yet, e.g. when the invoice has not been paid yet. The values accepted (replaced by confirmed) and modified (replaced the lastModified field on every entity) are deprecated since OTM5.1, but will be supported for the whole OTM5.X line.

Enum:"draft""requested""rejected""confirmed""inTransit""completed""closed""cancelled""accepted""modified"
Example:"inTransit"
transportModestring

Method of transport used for the carriage of goods on this trip, can either be using a ship (maritime or inland waterway), a truck/car/van/bike/etc. (road), using the train (rail), or using a plane (air). These values are based on the recommendation of UNECE.

Enum:"maritime""road""rail""air""inlandWaterway"
Example:"road"
vehicleany
Example:
{
  "uuid": "b9bb914d-845e-46f2-91ff-31fa4bac2fbe",
  "entityType": "vehicle",
  "associationType": "reference"
}
actorsArray of any

The actors associated with this trip, for instance the client or the executing party

actionsArray of any(action-association)

All actions that are/were happening on this trip, such as stopping at certain locations and loading and unloading of consignments.

constraintany
Response
{
  "id": "50824123-0924-4563-ac1e-ca0e37487823",
  "name": "Daily supply trip",
  "status": "inTransit",
  "transportMode": "road",
  "vehicle": {
    "uuid": "b9bb914d-845e-46f2-91ff-31fa4bac2fbe",
    "entityType": "vehicle",
    "associationType": "reference"
  }
}