1. REST API for Oracle IoT Fleet Monitoring Cloud Service
  2. Tasks
  3. Shipment Management (To be Deprecated, see Description)

Update shipment by ID

post

/fleetMonitoring/clientapi/v2/shipments/{shipmentId}

This operation updates the information about a shipment specified by its shipment ID. Unit sensitive fields like weight, volume, distance needs to be given in SI(metric) units

Request

Supported Media Types
Path Parameters
Query Parameters
Header Parameters
  • To perform a partial update of the shipment, POST request should be orchestrated with method override set to PATCH.
  • To allow targeting requests to different organizations. The header value should contain the organization identifier(orgId). This header is optional, if not provided orgId will be ORA_DEFAULT_ORG
Body ()
Root Schema : ShipmentImpl_update
Type: object
Show Source
Nested Schema : Equipment_update
Type: object
Show Source
Nested Schema : extendedFields
Type: array
List of extended field values supported for this shipment
Show Source
Nested Schema : ExternalEntityIDRefs_update
Type: object
Show Source
Nested Schema : stops
Type: array
List of stops
Show Source
Nested Schema : ShipmentExtendedField_update
Type: object
Show Source
  • Type of the extended field. Following group types are supported &qot;VehicleIdentifier&qot;, &qot;ShipmentIdentifier&qot;, &qot;CarrierIdentifier&qot;;One of [VehicleIdentifier, ShipmentIdentifier, CarrierIdentifier].
  • Unique name of the extended field
Nested Schema : TripStopRecord_update
Type: object
Show Source
Nested Schema : GeoPosition_update
Type: object
Show Source
Nested Schema : additionalElements
Type: array
Property description was not set
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : ShipmentImpl_receive
Type: object
Show Source
Nested Schema : DriverEntityIDRefs_receive
Type: object
Show Source
Nested Schema : Equipment_receive
Type: object
Show Source
Nested Schema : extendedFields
Type: array
List of extended field values supported for this shipment
Show Source
Nested Schema : MetricSnapshot_receive
Type: object
Show Source
Nested Schema : ExternalEntityIDRefs_receive
Type: object
Show Source
Nested Schema : stops
Type: array
List of stops
Show Source
Nested Schema : ShipmentExtendedField_receive
Type: object
Show Source
  • Type of the extended field. Following group types are supported &qot;VehicleIdentifier&qot;, &qot;ShipmentIdentifier&qot;, &qot;CarrierIdentifier&qot;;One of [VehicleIdentifier, ShipmentIdentifier, CarrierIdentifier].
  • Unique name of the extended field
Nested Schema : metricValues
Type: array
The metric values of an entity
Show Source
Nested Schema : MetricValue_receive
Type: object
Show Source
Nested Schema : esAdditionalData
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : EsJoinFieldValue_receive
Type: object
Show Source
Nested Schema : GeoPosition_receive
Type: object
Show Source
Nested Schema : metadata
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : params
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : additionalElements
Type: array
Property description was not set
Show Source
Nested Schema : TripStopRecord_receive
Type: object
Show Source

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

401 Response

Unauthorized. The request requires user authentication.

404 Response

Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

405 Response

Method Not Allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

406 Response

Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

415 Response

Unsupported Media Type. The request entity has a media type which the server or resource does not support.
Back to Top

Examples

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   --header "X-HTTP-Method-Override: PATCH" 
   https://iotserver/fleetMonitoring/clientapi/v2/shipments/{shipmentId}

Example of Request Body

The following example shows the content of the request body in JSON format:

{
    "name": "Planned_Shipment-1",
    "weight": 6.5,
    "volume": 6.8
    "plannedDriveDurationSeconds": 11000,
    "plannedDriveDistance": 207.53849404103548
}

Example of Response Body

The following example shows the content of the response body in JSON format:

{
    "id": "FB7FD9B7-11C5-49E9-B02B-E0D8547FD22C",
    "externalId": "Planned-Shipment-2",
    "name": "Planned_Shipment-2",
    "cost": 60,
    "isTPLManaged": false,
    "equipment": {
        "externalId": "EQUIP-3",
        "groupId": "TestGrp"
    },
    "orderCount": 3,
    "shipUnitCount": 4,
    "carrierName": "MyGlobalCarrier",
    "domainName": "D1",
    "weight": 6.5,
    "volume": 6.8,
    "loadedDistance": 6.8,
    "weightUtilization": 1.2,
    "volumeUtilization": 3.6,
    "equipmentUtilization": 8.9,
    "unLoadedDistance": 7.8,
    "plannedDriveDurationSeconds": 11000,
    "plannedDriveDistance": 128.95876200245783,
    "earliestStartTime": 1512905400000,
    "latestStartTime": 1518078200000,
    "externalReference": "BM1234565",
    "driverId": {
        "loginId": "iotFmDriver8"
    },
    "powerUnitId": {},
    "stops": [
        {
            "address": "500 Oracle Parkway::Redwood City::CA::US::94065",
            "geoLocation": [
                -122.26223,
                37.53084
            ],
            "estimatedTimeToNextStop": 792,
            "distanceToNextStop": 288,
            "expectedDurationFromStart": 0,
            "city": "Redwood City",
            "country": "US",
            "estimatedArrivalTime": 1517305083000,
            "estimatedDepartureTime": 1517300083000,
            "plannedArrivalTime": 1517305083000,
            "plannedDepartureTime": 1517405083000,
            "postalCode": "94065",
            "state": "CA",
            "stopDurationInSeconds": 0,
            "stopType": "P",
            "street": "500 Oracle Parkway",
            "stopSequence": 1
        },
        {
            "address": "4210 Network Circle::Santa Clara::CA::US::95054",
            "geoLocation": [
                -121.95267,
                37.39124
            ],
            "estimatedTimeToNextStop": 78,
            "distanceToNextStop": 25,
            "expectedDurationFromStart": 792,
            "city": "Santa Clara",
            "country": "US",
            "estimatedArrivalTime": 1517305083000,
            "estimatedDepartureTime": 1517405083000,
            "plannedArrivalTime": 1517305083000,
            "plannedDepartureTime": 1517405083000,
            "postalCode": "95054",
            "state": "CA",
            "stopDurationInSeconds": 0,
            "stopType": "P",
            "street": "4210 Network Circle",
            "stopSequence": 2
        },
        {
            "address": "475 Sansome Street::San Francisco::CA::US::94111",
            "geoLocation": [
                -122.40143,
                37.79461
            ],
            "estimatedTimeToNextStop": 366,
            "distanceToNextStop": 21.000000000000004,
            "expectedDurationFromStart": 870,
            "city": "San Francisco",
            "country": "US",
            "estimatedArrivalTime": 1517516083000,
            "estimatedDepartureTime": 1518516083000,
            "plannedArrivalTime": 1517516083000,
            "plannedDepartureTime": 1518516083000,
            "postalCode": "94111",
            "state": "CA",
            "stopDurationInSeconds": 0,
            "stopType": "D",
            "street": "475 Sansome Street",
            "stopSequence": 3
        }
    ],
    "lastModifiedBy": "iot",
    "lastModifiedTime": "2018-04-18T09:24:10.980Z",
    "lastModifiedTimeAsString": 1524043450980,
    "createdBy": "iot",
    "createdTime": "2018-04-18T09:15:27.121Z",
    "startTime": 0,
    "endTime": 0,
    "costCurrency": "EURO",
    "status": "PLANNED",
    "stopCount": 3,
    "stopsCompleted": 0,
    "links": [
        {
            "href": "https://iotserver:443/fleetMonitoring/clientapi/v2/shipments/FB7FD9B7-11C5-49E9-B02B-E0D8547FD22C/",
            "rel": "self"
        },
        {
            "href": "https://iotserver:443/fleetMonitoring/clientapi/v2/shipments/FB7FD9B7-11C5-49E9-B02B-E0D8547FD22C/",
            "rel": "canonical"
        }
    ]
}



Complete cURL Example

The following example shows a complete cURL command that you can use to perform the described operation:

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   --header "X-HTTP-Method-Override: PATCH"  
   -d '{"stops":[{"plannedArrivalTime":1469184297746,"plannedDepartureTime":1469184297746,"timeZone":"Time zone of the time fields","geoLocation":{"longitude":0.0,"latitude":0.0,"altitude":0.0,"additionalElements":["additionalElements_1","additionalElements_2","additionalElements_3"],"valid":false},"city":"Name of City","street":"Name of Street","postalCode":"Postal/Zip code","distanceToNextStop":0.0,"address":"Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.","state":"Name of State","country":"Name of country"}],"cost":12345,"trackingId":"632663148b1-4e07","plannedDriveDistance":12345,"plannedDriveDurationSeconds":12345,"volume":12345,"costCurrency":"Property description was not set","equipment":{"externalId":"437b69dc7b9e-7f22","groupId":"7cc46051eea-33ca"},"orderCount":12345,"shipUnitCount":12345,"carrierName":"Carrier Name","weightUtilization":12345,"volumeUtilization":12345,"equipmentUtilization":12345,"earliestStartTime":1469184297746,"latestStartTime":1469184297746,"powerUnitLicensePlateNumber":"Power Unit Registration Number.","domainName":"Domain Name","unLoadedDistance":12345,"loadedDistance":12345,"powerUnitId":{"id":"2fd6f3417f7-5941","externalId":"36634cc5200d-6d23"},"isTPLManaged":false,"transportMode":"Transport mode. e.g. (TruckLoad, TL, LessThanTruckLoad, LTL etc)","shipperName":"Name of the shipper or consignor","shipperId":"7d52760ac1a-2476","carrierId":"6ad17148354a-4598","earliestEndTime":1469184297746,"extendedFields":[{"name":"Unique name of the extended field","group":"Type of the extended field. Following group types are supported &qot;VehicleIdentifier&qot;, &qot;ShipmentIdentifier&qot;, &qot;CarrierIdentifier&qot;;One of [VehicleIdentifier, ShipmentIdentifier, CarrierIdentifier]."}],"trackerStatus":"Tracker status of the tracked shipment being monitored by data aggregator","weight":12345,"name":"Shipment Name"}'
   https://iotserver/fleetMonitoring/clientapi/v2/shipments/{shipmentId}



Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.
Back to Top