Get Tracking Events
get
/trackingEvents
Request
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 : trackingEvents
Type:
Show Source
object
-
aheadLateTime:
aheadLateTime
No description.
-
aheadOrLate: string
No description.
-
attribute1: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute10: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute11: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute12: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute13: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute14: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute15: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute16: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute17: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute18: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute19: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute2: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute20: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute3: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute4: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute5: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute6: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute7: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute8: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute9: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attributeDate1:
attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate10:
attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate2:
attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate3:
attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate4:
attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate5:
attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate6:
attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate7:
attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate8:
attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate9:
attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeNumber1: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber10: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber2: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber3: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber4: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber5: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber6: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber7: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber8: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber9: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
carDestinationCity: string
Shipment tracking event data for rail shipments. Defines the rail car destination city.
-
carDestinationCountry: string
Shipment tracking event data for rail shipments. Defines the rail car destination country.
-
carDestinationEtaDate:
carDestinationEtaDate
Shipment tracking event data for rail shipments. Defines the estimated time of arrival to the car destination node.
-
carDestinationLocationGid: string
Shipment tracking event data for rail shipments. Defines the rail car destination location GID.
-
carDestinationSplcCode: string
Shipment tracking event data for rail shipments. Defines the rail car destination state.
-
carDestinationState: string
Shipment tracking event data for rail shipments. Defines the rail car destination state.
-
carDestTimeZoneGid: string
The time zone GID for the car destination Estimated Time of Arrival date.
-
carInterchangeEtiDate:
carInterchangeEtiDate
Shipment tracking event data for rail shipments. Defines the rail car interchange date.
-
carInterchangeTimeZoneGid: string
The time zone GID for the car interchange Estimated Time of Interchange date.
-
carRepairHours: number
(double)
Shipment tracking event data for rail shipments. Defines the rail car repair hours.
-
countryCode3Gid: string
The 3 digit country code that the vessel is registered in.
-
description: string
A description for the tracking event captured.
-
dischargeOrCompletionDate:
dischargeOrCompletionDate
The discharge or completion date for the vessel used in the tracking event.
-
documentResponses:
documentResponses
-
domainName: string
Database domain where this data is stored.
-
driverCalEventGid: string
This is a GID for the driver calendar event being recorded with the tracking event, such as vacation time.
-
driverGid: string
The driver GID associated with the tracking event.
-
driverRefnumQualGid: string
The reference number qualifier for the driver that can be used to associate to a tracking event.
-
driverRefnumValue: string
The driver reference number value for the reference number qualifier defined.
-
equipmentInitial: string
The column defines the equipment initial for the equipment for which the event occurs.
-
equipmentNumber: string
The column defines the equipment number for the equipment for which the event occurs.
-
equipments:
equipments
-
erpc: string
Shipment tracking event data for rail shipments. ERPC is a system for abbreviating rail location names.
-
eventdate:
eventdate
The tracking event date.
-
eventEndDate:
eventEndDate
The event end date associated with the tracking event.
-
eventReceivedDate:
eventReceivedDate
The time stamp for when the tracking event was received.
-
externalDataSource: string
The identifying code for the external system data source.
-
externalEventReference: string
The reference number of the event used by the external system sending the event.
-
fightOrVoyageNum: string
The flight number if the tracking event is for a air mode or the voyage number if for ocean mode.
-
filingResponseType: string
The filing response type for Automated Export System (AES) via integration as tracking events.
-
hosRules:
hosRules
-
indicator: string
A indicator that can be set to flag tracking event status.
-
insertDate:
insertDate
Read Only:
true
insert date -
isCarLoaded: boolean
The CLM field to indicate whether the rail car is loaded or empty.
-
iTransactionNo: number
(int64)
The transaction identifier for the shipment data of the tracking event.
-
links: array
links
Read Only:
true
-
locationGid: string
This field describes the location at which the event occurs.
-
matchedDmTransactions:
matchedDmTransactions
-
matchedDocuments:
matchedDocuments
-
matchedDrivers:
matchedDrivers
-
matchedEquipments:
matchedEquipments
-
matchedInvolvedParties:
matchedInvolvedParties
-
matchedObLines:
matchedObLines
-
matchedObShipUnits:
matchedObShipUnits
-
matchedOrderBases:
matchedOrderBases
-
matchedOrderReleases:
matchedOrderReleases
-
matchedOrLines:
matchedOrLines
-
matchedOrShipUnitLines:
matchedOrShipUnitLines
-
matchedOrShipUnits:
matchedOrShipUnits
-
matchedPowerUnits:
matchedPowerUnits
-
matchedShipmentGroups:
matchedShipmentGroups
-
matchedShipments:
matchedShipments
-
matchedSShipUnitLines:
matchedSShipUnitLines
-
matchedSShipUnits:
matchedSShipUnits
-
nextJunctionSplc: string
Shipment tracking event data for rail shipments. This field specifies the interchange junction code. ETA for this junction will be Interchange ETI Date.
-
obRefnumQualGid: string
The order base reference qualifier for the order level data of the tracking event. Define by order base, order release, or order release line.
-
obRefnumValue: string
The order base reference level value for the defined qualifier.
-
orderBaseGid: string
The order base identifier for the order level data of the tracking event. Define by order base, order release, or order release line.
-
orderReleaseGid: string
The order release identifier for the order level data of the tracking event. Define by order base, order release, or order release line.
-
orderReleaseLineGid: string
The order release line for the order level data of the tracking event. Define by order base, order release, or order release line.
-
origTransactionNo: number
(int64)
If this event is to adjust a previous tracking event, this field specifies the original transaction identifier.
-
orLineRefnumQualGid: string
The order release line reference qualifier for the order level data of the tracking event. Define by order base, order release, or order release line.
-
orlRefnumValue: string
The order release line reference number value for the defined qualifier.
-
orRefnumQualGid: string
The order release reference qualifier for the order level data of the tracking event. Define by order base, order release, or order release line.
-
orRefnumValue: string
The order release reference number value for the defined qualifier.
-
powerUnitGid: string
The power unit GID associated with the tracking event.
-
puRefnumQualGid: string
The reference number qualifier for the power unit that can be used to associate to a tracking event.
-
puRefnumValue: string
The power unit reference number value for the reference number qualifier defined.
-
railRoadReportingScac: string
The SCAC for the rail road service provider that is providing the shipment status message or CLM.
- relatedTransactionNo: number (int64)
-
remarks:
remarks
-
responsiblePartyGid: string
The responsible party that is defined for the type of status for the tracking event.
-
servprovAliasQualGid: string
The service provider alias qualifier identifier for the tracking event.
-
servprovAliasValue: string
The service provider alias value for the qualifier defined.
-
shipGroupGid: string
The shipment group GID associated with the tracking event.
-
shipGroupTypeGid: string
The shipment group type (such as import, export, cargo manifest) for the shipment group associated with the tracking event.
-
shipmentGid: string
The shipment GID associated with the tracking event.
-
shipmentGroupRefnums:
shipmentGroupRefnums
-
shipmentRefnums:
shipmentRefnums
-
shipmentStatusType: string
Used for the ease of identification of the type of event. For example, this can be used to specify if the tracking is for matching with shipment, shipment group, order, etc.
-
shipOrSailDate:
shipOrSailDate
The ship sail date for the vessel used in the tracking event.
-
shipUnits:
shipUnits
-
specialServices:
specialServices
-
ssContactFunctionCode: string
The contact function code for the individual entering the tracking event.
-
ssContactName: string
The contact name for the individual entering the tracking event.
-
statusCodeGid: string
The status code GID associated with the tracking event.
-
statusLevel: string
A status level associated with the tracking event.
-
statusReasonCodeGid: string
The status reason code that is mapped to the tracking event.
-
stops:
stops
-
temperature:
temperature
The temperature associated with the shipment tracking event.
-
timeDriven:
timeDriven
The time driven for the tracking event for recording purposes.
-
timeWorked:
timeWorked
The time worked for the tracking event for recording purposes.
-
timeZoneGid: string
The time zone GID for the tracking event date.
-
trackingNumber: string
The specific tracking number for the shipment provided by the service provider and is matched to a reference qualifier called tracking number.
-
trainJctBoCode: string
Shipment tracking event data for rail shipments. The train junction box code for the CLM message.
-
updateDate:
updateDate
Read Only:
true
update date -
vesselCode: string
The vessel code associated with the qualifier defined.
-
vesselCodeQualifier: string
The vessel code qualifier identifier defined to itemize vessel codes.
-
vesselGid: string
The vessel GID.
-
volumeValue:
volumeValue
A total volume value associated with the shipment tracking event.
-
weightValue:
weightValue
A total weight value associated with the shipment tracking event.
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : carDestinationEtaDate
Shipment tracking event data for rail shipments. Defines the estimated time of arrival to the car destination node.
Match All
Show Source
Nested Schema : carInterchangeEtiDate
Shipment tracking event data for rail shipments. Defines the rail car interchange date.
Match All
Show Source
Nested Schema : dischargeOrCompletionDate
The discharge or completion date for the vessel used in the tracking event.
Match All
Show Source
Nested Schema : documentResponses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : equipments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : eventEndDate
The event end date associated with the tracking event.
Match All
Show Source
Nested Schema : eventReceivedDate
The time stamp for when the tracking event was received.
Match All
Show Source
Nested Schema : hosRules
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedDmTransactions
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedDocuments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedDrivers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedEquipments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedInvolvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedObLines
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedObShipUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedOrderBases
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedOrderReleases
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedOrLines
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedOrShipUnitLines
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedOrShipUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedPowerUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedShipmentGroups
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedShipments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedSShipUnitLines
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : matchedSShipUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipmentGroupRefnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipmentRefnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : shipOrSailDate
The ship sail date for the vessel used in the tracking event.
Match All
Show Source
Nested Schema : shipUnits
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : stops
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : temperature
The temperature associated with the shipment tracking event.
Match All
Show Source
Nested Schema : timeDriven
The time driven for the tracking event for recording purposes.
Match All
Show Source
Nested Schema : timeWorked
The time worked for the tracking event for recording purposes.
Match All
Show Source
Nested Schema : volumeValue
A total volume value associated with the shipment tracking event.
Match All
Show Source
Nested Schema : weightValue
A total weight value associated with the shipment tracking event.
Match All
Show Source
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : trackingEvents.documentResponses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
elementRefQualifier: string
The filing element reference qualifier for the tracking event.
-
elementRefValue: string
The filing element value for the qualifier defined.
-
links: array
links
Read Only:
true
-
responseCode: string
The response code for this filing response tracking event.
-
responseSeq: number
(int64)
The response sequence number primary key for multiple document filing response tracking events.
-
responseSeverity: string
The response severity indicator for this tracking event.
-
responseText: string
The response text for this response filing tracking event.
Nested Schema : trackingEvents.equipments
Type:
Show Source
object
-
aarCarType: string
The AAR car type associated with the rail equipment on the tracking event.
-
chassisInitial: string
The chassis initial is a mark that is registered with national or international authorities that is associated with a specific owner
-
chassisInitialNumber: string
The Chassis Initial Number field is a concatenation of chassis initial and chassis number.
-
chassisNumber: string
Number identifying the used in conjunction with the equipment on the tracking event.
-
domainName: string
Database domain where this data is stored.
-
equipmentGid: string
The equipment GID if the equipment is an asset managed in OTM.
-
equipmentInitial: string
The equipment initial is a mark that is registered with national or international authorities that is associated with a specific owner.
-
equipmentInitialNumber: string
The Equipment Initial Number field is a concatenation of equipment initial and equipment number.
-
equipmentNumber: string
Number identifying the equipment used.
-
equipmentRefnumQualGid: string
The equipment reference number qualifier to identify an equipment entity for a tracking event.
-
equipmentRefnumValue: string
The equipment reference value associated with the equipment reference number qualifier.
-
equipmentTypeGid: string
An equipment type is a category of equipment. Oracle Transportation Management uses equipment types when it determines equipment capacity.
-
intermodalEquipmentLength: number
(double)
The reported length of the equipment in the tracking event.
-
iRecNo: number
(int64)
The record number primary key identifier for the tracking event specified.
-
links: array
links
Read Only:
true
-
scaleLocation: string
The scale location recorded for the tracking event.
-
scaleName: string
The received volume recorded on the tracking event for the shipment ship unit.
-
scaleTicket: string
Sequence ID printed on the scale ticket when weight is recorded.
-
scaleWeight:
scaleWeight
The scale weight recorded on the tracking event for the shipment equipment.
-
seals:
seals
-
sEquipmentGid: string
The shipment equipment GID linking an equipment record to the shipment.
-
sEquipmentIndex: number
(int32)
The standing order of the equipment on the shipment
-
tareWeight:
tareWeight
The tare weight recorded on the tracking event for the shipment equipment.
-
weightQualifier: string
The type of weight that is represented by the scale weight; Estimate, Net, or Gross weight. E = Estimated, G = Gross, N = Net
Nested Schema : scaleWeight
The scale weight recorded on the tracking event for the shipment equipment.
Match All
Show Source
Nested Schema : seals
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : tareWeight
The tare weight recorded on the tracking event for the shipment equipment.
Match All
Show Source
Nested Schema : trackingEvents.equipments.seals
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
sealNumber: string
The seal number that identifies the seal tag.
-
sealSequence: number
(int32)
The seal sequence number that refers to the compartment that is being sealed.
-
sEquipmentGid: string
The shipment equipment GID.
Nested Schema : trackingEvents.hosRules
Type:
Show Source
object
-
activityTime:
activityTime
The activity time associated with the hours of service reported for the tracking event.
-
activityTimeRemain:
activityTimeRemain
The activity time remaining against that hours of service.
-
domainName: string
Database domain where this data is stored.
-
hosRuleGid: string
The hours of service rule GID for the given tracking event.
-
iRecNo: number
(int64)
The record number primary key identifier for the tracking event specified.
-
links: array
links
Read Only:
true
-
ruleBeginTime:
ruleBeginTime
The begin time defined for the hours of service rule.
Nested Schema : activityTime
The activity time associated with the hours of service reported for the tracking event.
Match All
Show Source
Nested Schema : activityTimeRemain
The activity time remaining against that hours of service.
Match All
Show Source
Nested Schema : ruleBeginTime
The begin time defined for the hours of service rule.
Match All
Show Source
Nested Schema : trackingEvents.matchedDmTransactions
Type:
Show Source
object
-
dmTransactionSeqNo: number
(int64)
Contains the unique identifier for the demurrage transaction.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : trackingEvents.matchedDocuments
Type:
Show Source
object
-
documentGid: string
The document GID for the tracking event.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : trackingEvents.matchedDrivers
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
driverGid: string
The driver GID for the tracking event.
-
links: array
links
Read Only:
true
Nested Schema : trackingEvents.matchedEquipments
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
equipmentGid: string
The equipment GID for the tracking event.
-
links: array
links
Read Only:
true
Nested Schema : trackingEvents.matchedInvolvedParties
Type:
Show Source
object
-
commMethodGid: string
The communication method used to notify regarding the tracking event.
-
domainName: string
Database domain where this data is stored.
-
iRecNo: number
(int64)
The record number primary key identifier for the tracking event specified.
-
links: array
links
Read Only:
true
-
matchObjectType: string
The object type that was matched to the involved party. For example, order release, order base, or shipment.
-
matchObjInvPartyConGid: string
The involved party value for the involved party qualifier on the tracking event.
-
matchObjInvPartyQualGid: string
The involved party qualifier for the tracking event.
Nested Schema : trackingEvents.matchedObLines
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
obLineGid: string
The order base line that is associated with the tracking event.
-
orderBaseGid: string
The order base identifier for the line that is associated with the tracking event.
Nested Schema : trackingEvents.matchedObShipUnits
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
obShipUnitGid: string
The order base ship unit that is associated with the tracking event.
-
orderBaseGid: string
The order base identifier for the ship unit that is associated with the tracking event.
Nested Schema : trackingEvents.matchedOrderBases
Type:
Show Source
object
-
bsContactFunctionCode: string
The contact name function code from the tracking event.
-
bsContactName: string
The contact name from the tracking event.
-
bsReasonCodeGid: string
The reason code from the tracking event that was matched to the order base.
-
bsResponsiblePartyGid: string
The responsible party identifier of the source of the tracking event.
-
bsStatusCodeGid: string
The status code identified on the tracking event.
-
description: string
A description of the tracking event.
-
domainName: string
Database domain where this data is stored.
-
eventDate:
eventDate
The event date and time reported on the tracking event.
-
links: array
links
Read Only:
true
-
obRefnumQualGid: string
The order base reference number value associated with the order release qualifier that came on the tracking event.
-
obRefnumValue: string
The order base reference number qualifier identifier.
-
orderBaseGid: string
The order base GID for the tracking event.
-
reportingGluser: string
The reporting application user if the tracking event was entered via the system's tracking event UI.
-
servprovAliasQualGid: string
The service provider alias qualifier code, such as SCAC, from the entered tracking event.
-
servprovAliasValue: string
The service provide alias value from the tracking event.
-
statusLevel: string
A descriptor code for the status level of the tracking event.
-
timeZoneGid: string
The time zone for the tracking event time entered.
Nested Schema : eventDate
The event date and time reported on the tracking event.
Match All
Show Source
Nested Schema : trackingEvents.matchedOrderReleases
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.
-
links: array
links
Read Only:
true
-
orderReleaseGid: string
The order release GID for the tracking event.
-
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 : trackingEvents.matchedOrLines
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
orderReleaseGid: string
The order release identifier for the line that is associated with the tracking event.
-
orderReleaseLineGid: string
The order release line that is associated with the tracking event.
Nested Schema : trackingEvents.matchedOrShipUnitLines
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipUnitGid: string
The order release ship unit identifier for the ship unit line associated with the tracking event.
-
shipUnitLineNo: number
(int32)
The order release ship unit line identifier associated with the tracking event.
Nested Schema : trackingEvents.matchedOrShipUnits
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
orderReleaseGid: string
The order release identifier for the ship unit that is associated with the tracking event.
-
shipUnitGid: string
The order release ship unit that is associated with the tracking event.
Nested Schema : trackingEvents.matchedPowerUnits
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
powerUnitGid: string
The power unit GID for the tracking event.
Nested Schema : trackingEvents.matchedShipmentGroups
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
reportingComMethodGid: string
The reporting method that links into the communication methods defined for OTM.
-
reportingGluser: string
The reporting application user if the tracking event was entered via the system's tracking event UI.
-
servprovGid: string
The service provider associated with generating the tracking event.
-
shipGroupGid: string
The shipment group GID for the tracking event.
Nested Schema : trackingEvents.matchedShipments
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.
-
links: array
links
Read Only:
true
-
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.
-
shipmentGid: string
The shipment identifier for the tracking event.
-
shipmentStopNum: number
(int32)
The shipment stop number for a stop based event.
Nested Schema : trackingEvents.matchedSShipUnitLines
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
sShipUnitGid: string
The shipment ship unit GID for the tracking event.
-
sShipUnitLineNo: number
(int64)
The shipment ship unit line number for the tracking event.
Nested Schema : trackingEvents.matchedSShipUnits
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
sShipUnitGid: string
The shipment ship unit GID for the tracking event.
Nested Schema : trackingEvents.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
iRecNo: number
(int64)
The record number primary key identifier for the tracking event specified.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The shipment remark qualifier identifier.
-
remarkSequence: number
(int64)
A remark sequence number if entering multiple remarks for a shipment tracking event.
-
remarkText: string
The shipment remark text value for the qualifier defined.
Nested Schema : trackingEvents.shipmentGroupRefnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
iRecNo: number
(int64)
The record number primary key identifier for the tracking event specified.
-
links: array
links
Read Only:
true
-
shipGroupRefnumQualGid: string
The shipment group reference number qualifier identifier.
-
shipGroupRefnumValue: string
The shipment group reference number value for the qualifier defined.
Nested Schema : trackingEvents.shipmentRefnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
iRecNo: number
(int64)
The record number primary key identifier for the tracking event specified.
-
links: array
links
Read Only:
true
-
shipmentRefnumQualGid: string
The shipment reference number qualifier identifier.
-
shipmentRefnumValue: string
The shipment reference number value for the qualifier defined.
Nested Schema : trackingEvents.shipUnits
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
lines:
lines
-
links: array
links
Read Only:
true
-
receivedShipUnitCount: number
(int64)
The received ship unit count recorded on the tracking event for the shipment ship unit.
-
receivedVolume:
receivedVolume
The received volume recorded on the tracking event for the shipment ship unit.
-
receivedWeight:
receivedWeight
The received weight recorded on the tracking event for the shipment ship unit.
-
sShipUnitGid: string
The shipment ship unit associated with the tracking event being reported.
Nested Schema : lines
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : receivedVolume
The received volume recorded on the tracking event for the shipment ship unit.
Match All
Show Source
Nested Schema : receivedWeight
The received weight recorded on the tracking event for the shipment ship unit.
Match All
Show Source
Nested Schema : trackingEvents.shipUnits.lines
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
packagedItemGid: string
The packaging item defined for the shipping line.
-
packagingUnitGid: string
The packaging unit associated with the packaging item.
-
receivedCountPerShipUnit: number
(int64)
The received item count in eaches on a per ship unit received recorded on the tracking event for the shipment ship unit line.
-
receivedItemPackageCount: number
(int64)
The received item count in eaches recorded on the tracking event for the shipment ship unit line.
-
receivedPackagingUnitCount: number
(int64)
The received item count in terms of packaging units recorded on the tracking event for the shipment ship unit line.
-
receivedVolume:
receivedVolume
The received volume recorded on the tracking event for the shipment ship unit line.
-
receivedWeight:
receivedWeight
The received weight recorded on the tracking event for the shipment ship unit line.
-
sShipUnitLineNo: number
(int64)
The shipment ship unit line associated with the tracking event being reported.
Nested Schema : receivedVolume
The received volume recorded on the tracking event for the shipment ship unit line.
Match All
Show Source
Nested Schema : receivedWeight
The received weight recorded on the tracking event for the shipment ship unit line.
Match All
Show Source
Nested Schema : trackingEvents.specialServices
Type:
Show Source
object
-
distance:
distance
The distance for the special service activity recorded on the tracking event for the shipment.
-
domainName: string
Database domain where this data is stored.
-
iRecNo: number
(int64)
The record number primary key identifier for the tracking event specified.
-
itemCount: number
(int64)
The item piece count for the special service activity recorded on the tracking event for the shipment.
-
links: array
links
Read Only:
true
-
remarks:
remarks
-
serviceCompletionState: string
An indication if the special service activity was completed with the tracking event.
-
serviceDuration:
serviceDuration
The time duration that occurred for the special service on the tracking event.
-
serviceTime:
serviceTime
The time for the special service activity on the tracking event.
-
shipUnitCount: number
(int64)
The ship unit count for the special service activity recorded on the tracking event for the shipment.
-
specialServiceGid: string
The special service identifier that is being reported against with the tracking event being reported.
-
volume:
volume
The volume for the special service activity recorded on the tracking event for the shipment.
-
weight:
weight
The weight for the special service activity recorded on the tracking event for the shipment.
Nested Schema : distance
The distance for the special service activity recorded on the tracking event for the shipment.
Match All
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : serviceDuration
The time duration that occurred for the special service on the tracking event.
Match All
Show Source
Nested Schema : serviceTime
The time for the special service activity on the tracking event.
Match All
Show Source
Nested Schema : volume
The volume for the special service activity recorded on the tracking event for the shipment.
Match All
Show Source
Nested Schema : weight
The weight for the special service activity recorded on the tracking event for the shipment.
Match All
Show Source
Nested Schema : trackingEvents.specialServices.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The remark qualifier identifier.
-
remarkSequence: number
(int64)
A remark sequence number if entering multiple remarks for a shipment special service tracking event.
-
remarkText: string
The shipment remark text value for the qualifier defined.
Nested Schema : trackingEvents.stops
Type:
Show Source
object
-
aeiIndicator: string
The AEI indicator for the tracking event.
-
domainName: string
Database domain where this data is stored.
-
erpc: string
If the tracking stop is for a rail location the Eastern Railroad President's Conference (ERPC) can be used.
-
eventCity: string
The city associated with the tracking event.
-
eventCountry: string
The country associated with the tracking event.
-
eventdate:
eventdate
The tracking event date.
-
eventState: string
The state associated with the tracking event.
-
gatePierDoorNumber: string
The gate pier door number assigned to the shipment tracking status.
-
iRecNo: number
(int64)
The record number primary key identifier for the tracking event specified.
-
latitude: string
A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.
-
links: array
links
Read Only:
true
-
locationGid: string
Typically a location GID is not supplied on a stop tracking event if you have entered the stop sequence number. If adding an additional stop to the shipment, this field together with the reference position is required.
-
locationIdValue: string
The location reference value associated with the reference number qualifier.
-
locationName: string
A location name if supplied with the tracking event.
-
locationRefnumQualGid: string
The location reference number quantifier associated with a location reference number if supplied on the tracking event.
-
longitude: string
A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.
-
portLocationFunctionCode: string
The port location function code for ocean tracking events.
-
referencePosition: string
The position of this stop relative to the yet-to-be-created new stop.
-
splcCode: string
If the tracking stop is for a rail location the Standard Point Location Code (SPLC) can be used.
-
stopSequence: number
(int32)
The stop sequence associated with the stop if a shipment identifier is entered and stop tracking event is for an existing stop.
-
stopType: string
The stop type for the new stop created with tracking event.
-
terminalName: string
The terminal name for port associated with the tracking event status.
-
timeZoneGid: string
The time zone identifier for the tracking event.