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

List shipments

get

/fleetMonitoring/clientapi/v2/shipments

This operation returns details of the all the shipments present in the current application instance.The values of unit sensitive field like weight, volume, distance will be in accordance with system unit configuration.

Note :
Shipments can be filtered based on fields like startTime, endTime etc. using MongoDB style query.

Example :
https://iotserver:443/fleetMonitoring/clientapi/v2/shipments?q={"startTime":{"$gt":1527685009925,"$lt":1527686009925}}

Request

Query Parameters
Header Parameters
  • 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
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : ShipmentImpl_receive_list
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
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

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.

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.
Back to Top

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/shipments

Example of Response Body

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

{
    "items": [
        {
            "id": "C6868594-EDEB-46D3-991B-EA387C901EF2",
            "externalId": "Planned-Shipment-2",
            "name": "Planned_Shipment-2",
            "cost": 60,
            "costCurrency": "EURO",
            "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,
            "earliestStartTime": 1012409946000,
            "latestStartTime": 4512582746000,
            "externalReference": "BM1234565",
            "driverId": {
                "id": "BDF34C99-D53B-49E7-963C-7606DA494A70",
                "externalId": "driver2"
            },
            "powerUnitId": {
                "id": "6692F861-DAAF-4B11-BF69-73E1AC711270",
                "externalId": "pu5"
            },
            "powerUnitLicensePlateNumber": "KA5-1",
            "stops": [
                {
                    "address": "199 Coyote Ranch Rd::San Jose::CA::US::95138",
                    "geoLocation": [
                        -121.74271,
                        37.22656
                    ],
                    "estimatedTimeToNextStop": 792,
                    "distanceToNextStop": 288,
                    "expectedDurationFromStart": 0,
                    "city": "San Jose",
                    "country": "US",
                    "estimatedArrivalTime": 1517305083000,
                    "estimatedDepartureTime": 1517300083000,
                    "plannedArrivalTime": 1517305083000,
                    "plannedDepartureTime": 1517405083000,
                    "postalCode": "95138",
                    "state": "CA",
                    "stopType": "P",
                    "street": "199 Coyote Ranch Rd",
                    "stopDurationInSeconds": 0,
                    "stopSequence": 1
                },
                {
                    "address": "27701 Lake Hughes Rd::Castaic::CA::US::91384",
                    "geoLocation": [
                        -118.62244,
                        34.49378
                    ],
                    "estimatedTimeToNextStop": 78,
                    "distanceToNextStop": 25,
                    "expectedDurationFromStart": 792,
                    "city": "Castaic",
                    "country": "US",
                    "estimatedArrivalTime": 1517305083000,
                    "estimatedDepartureTime": 1517405083000,
                    "plannedArrivalTime": 1517305083000,
                    "plannedDepartureTime": 1517405083000,
                    "postalCode": "91384",
                    "state": "CA",
                    "stopType": "P",
                    "street": "27701 Lake Hughes Rd",
                    "stopDurationInSeconds": 0,
                    "stopSequence": 2
                },
                {
                    "address": "8793 Haddon Ave::Sun Valley::CA::US::91352",
                    "geoLocation": [
                        -118.39086,
                        34.22774
                    ],
                    "estimatedTimeToNextStop": 366,
                    "distanceToNextStop": 21.000000000000004,
                    "expectedDurationFromStart": 870,
                    "city": "Sun Valley",
                    "country": "US",
                    "estimatedArrivalTime": 1517516083000,
                    "estimatedDepartureTime": 1518516083000,
                    "plannedArrivalTime": 1517516083000,
                    "plannedDepartureTime": 1518516083000,
                    "postalCode": "91352",
                    "state": "CA",
                    "stopType": "D",
                    "street": "8793 Haddon Ave",
                    "stopDurationInSeconds": 0,
                    "stopSequence": 3
                }
            ],
            "lastModifiedBy": "iot",
            "lastModifiedTime": "2018-02-16T09:09:34.869Z",
            "lastModifiedTimeAsString": 1518772174869,
            "createdBy": "iot",
            "createdTime": "2018-02-16T08:58:04.520Z",
            "metricValues": [
                {
                    "id": "ee15eac2-d49f-31b7-b3b0-9af2b1d5b4ee",
                    "name": "sys_delayDurationSeconds",
                    "entityType": "shipments",
                    "eventTime": 1530273016245,
                    "computedTime": 1530273016245,
                    "eventTimeAsString": "2018-02-16T09:08:59Z",
                    "interval": "CURRENT",
                    "entityId": "39F46227-B6A8-480B-8F48-BD775786FD37",
                    "type": "KPI",
                    "lastKnown": false,
                    "numericValue": 1219
                },
                {
                    "id": "3a67eee2-2d6a-3cdd-bbb3-e70a01bd391e",
                    "name": "untraceableStatus",
                    "entityType": "shipments",
                    "eventTime": 1518772139062,
                    "computedTime": 1518772139062,
                    "eventTimeAsString": "2018-02-16T09:08:59Z",
                    "interval": "CURRENT",
                    "entityId": "C6868594-EDEB-46D3-991B-EA387C901EF2",
                    "type": "KPI",
                    "lastKnown": false,
                    "booleanValue": false
                }
            ],
            "status": "COMPLETED",
            "stopCount": 3,
            "stopsCompleted": 0,
            "tripId": "AC152E72-9754-4C59-A048-64A0E1B2D046"
        }
    ],
    "links": [
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/shipments?offset=0&limit=10&q=%7B%22driverLoginId%22:%20%7B%20%22$eq%22:%20%22IoTFMDriver3%22%20%7D%20%7D",
            "rel": "self"
        },
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/shipments",
            "rel": "canonical"
        },
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/shipments?q=%7B%22driverLoginId%22:%20%7B%20%22$eq%22:%20%22IoTFMDriver3%22%20%7D%20%7D&offset=0&limit=10",
            "rel": "first"
        },
        {
            "href": "https://iotserver/fleetMonitoring/clientapi/v2/shipments?q=%7B%22driverLoginId%22:%20%7B%20%22$eq%22:%20%22IoTFMDriver3%22%20%7D%20%7D&offset=0&limit=10",
            "rel": "last"
        }
    ],
    "offset": 0,
    "limit": 10,
    "count": 1,
    "hasMore": false
}



Complete cURL Example

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

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/shipments



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