Get Tracking Events
get
/shipments/{shipmentGid}/trackingEvents
Request
Path Parameters
-
shipmentGid(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : shipments.trackingEvents
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
eventLocationGid: string
The location identifier of an location based event. This will be null for non-location based events.
-
isHidden: boolean
A Y/N indicator to display the status history.
-
iTransactionNo: number
(int64)
The transaction identifier for the shipment data of the tracking event.
-
links: array
links
Read Only:
true
-
partitionKey: number
(double)
The monthly range partition to manage purging status messages.
-
reportingGluser: string
The reporting application user if the tracking event was entered via the system's tracking event UI.
-
reportingMethod: string
The reporting method that links into the communication methods defined for OTM.
-
servprovGid: string
The service provider associated with generating the tracking event.
-
shipmentStopNum: number
(int32)
The shipment stop number for a stop based event.