Get Tracking Events
get
/orderReleases/{orderReleaseGid}/trackingEvents
Request
Path Parameters
-
orderReleaseGid(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 : orderReleases.trackingEvents
Type:
Show Source
object
-
bsContactFunctionCode: string
This indicates the shipment stop number for a stop based event.
-
bsContactName: string
The reporting method that links into the communication methods defined for OTM.
-
bsReasonCodeGid: string
The reason code from the tracking event that was matched to the order releases.
-
bsResponsiblePartyGid: string
The responsible party identifier of the source of the tracking event.
-
bsStatusCodeGid: string
A Y/N indicator to display the status history.
-
description: string
A description of the tracking event.
-
domainName: string
Database domain where this data is stored.
-
eventDate:
eventDate
The location identifier of an location based event. This will be null for non-location based events.
-
iTransactionNo: number
(int64)
The transaction identifier for the order release data of the tracking event.
-
links: array
links
Read Only:
true
-
orderReleaseRefnumQualGid: string
The order release reference number qualifier identifier.
-
orderReleaseRefnumValue: string
The order release reference number value associated with the order release qualifier that came on the tracking event.
-
reportingGluser: string
The service provider associated with generating the tracking event.
-
statusLevel: string
A descriptor code for the status level of the tracking event.
-
timeZoneGid: string
The monthly range partition to manage purging status messages.
Nested Schema : eventDate
The location identifier of an location based event. This will be null for non-location based events.
Match All
Show Source
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format