Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : trackingEvents

Type: object

Show Source

• 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)
  If this event is related to another tracking event this field specifies the related transaction number.
• 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.

{
    "properties":{
        "iTransactionNo":{
            "description":"The transaction identifier for the shipment data of the tracking event.",
            "type":"number",
            "format":"int64"
        },
        "servprovAliasQualGid":{
            "description":"The service provider alias qualifier identifier for the tracking event.",
            "type":"string"
        },
        "servprovAliasValue":{
            "description":"The service provider alias value for the qualifier defined.",
            "type":"string"
        },
        "description":{
            "description":"A description for the tracking event captured.",
            "type":"string"
        },
        "statusLevel":{
            "description":"A status level associated with the tracking event.",
            "type":"string"
        },
        "vesselCodeQualifier":{
            "description":"The vessel code qualifier identifier defined to itemize vessel codes.",
            "type":"string"
        },
        "vesselCode":{
            "description":"The vessel code associated with the qualifier defined.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"The 3 digit country code that the vessel is registered in. ",
            "type":"string"
        },
        "vesselGid":{
            "description":"The vessel GID.",
            "type":"string"
        },
        "shipOrSailDate":{
            "description":"The ship sail date for the vessel used in the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "dischargeOrCompletionDate":{
            "description":"The discharge or completion date for the vessel used in the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "fightOrVoyageNum":{
            "description":"The flight number if the tracking event is for a air mode or the voyage number if for ocean mode.",
            "type":"string"
        },
        "weightValue":{
            "description":"A total weight value associated with the shipment tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volumeValue":{
            "description":"A total volume value associated with the shipment tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "obRefnumQualGid":{
            "description":"The order base reference qualifier for the order level data of the tracking event. Define by order base, order release, or order release line.",
            "type":"string"
        },
        "obRefnumValue":{
            "description":"The order base reference level value for the defined qualifier.",
            "type":"string"
        },
        "statusCodeGid":{
            "description":"The status code GID associated with the tracking event.                                               ",
            "type":"string"
        },
        "timeZoneGid":{
            "description":"The time zone GID for the tracking event date.                                                                   ",
            "type":"string"
        },
        "eventdate":{
            "description":"The tracking event date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "statusReasonCodeGid":{
            "description":"The status reason code that is mapped to the tracking event.",
            "type":"string"
        },
        "ssContactFunctionCode":{
            "description":"The contact function code for the individual entering the tracking event.",
            "type":"string"
        },
        "ssContactName":{
            "description":"The contact name for the individual entering the tracking event.",
            "type":"string"
        },
        "trainJctBoCode":{
            "description":"Shipment tracking event data for rail shipments. The train junction box code for the CLM message.",
            "type":"string"
        },
        "responsiblePartyGid":{
            "description":"The responsible party that is defined for the type of status for the tracking event.",
            "type":"string"
        },
        "railRoadReportingScac":{
            "description":"The SCAC for the rail road service provider that is providing the shipment status message or CLM.",
            "type":"string"
        },
        "isCarLoaded":{
            "description":"The CLM field to indicate whether the rail car is loaded or empty.",
            "type":"boolean"
        },
        "carDestinationCity":{
            "description":"Shipment tracking event data for rail shipments. Defines the rail car destination city.",
            "type":"string"
        },
        "carDestinationState":{
            "description":"Shipment tracking event data for rail shipments. Defines the rail car destination state.",
            "type":"string"
        },
        "carDestinationSplcCode":{
            "description":"Shipment tracking event data for rail shipments. Defines the rail car destination state.",
            "type":"string"
        },
        "carDestinationEtaDate":{
            "description":"Shipment tracking event data for rail shipments. Defines the estimated time of arrival to the car destination node.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "origTransactionNo":{
            "description":"If this event is to adjust a previous tracking event, this field specifies the original transaction identifier.",
            "type":"number",
            "format":"int64"
        },
        "temperature":{
            "description":"The temperature associated with the shipment tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "eventReceivedDate":{
            "description":"The time stamp for when the tracking event was received.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "driverGid":{
            "description":"The driver GID associated with the tracking event.",
            "type":"string"
        },
        "eventEndDate":{
            "description":"The event end date associated with the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "powerUnitGid":{
            "description":"The power unit GID associated with the tracking event.",
            "type":"string"
        },
        "shipmentGid":{
            "description":"The shipment GID associated with the tracking event.",
            "type":"string"
        },
        "driverRefnumQualGid":{
            "description":"The reference number qualifier for the driver that can be used to associate to a tracking event.",
            "type":"string"
        },
        "driverRefnumValue":{
            "description":"The driver reference number value for the reference number qualifier defined.",
            "type":"string"
        },
        "puRefnumQualGid":{
            "description":"The reference number qualifier for the power unit that can be used to associate to a tracking event.",
            "type":"string"
        },
        "puRefnumValue":{
            "description":"The power unit reference number value for the reference number qualifier defined.",
            "type":"string"
        },
        "relatedTransactionNo":{
            "description":"If this event is related to another tracking event this field specifies the related transaction number.",
            "type":"number",
            "format":"int64"
        },
        "externalEventReference":{
            "description":"The reference number of the event used by the external system sending the event.",
            "type":"string"
        },
        "externalDataSource":{
            "description":"The identifying code for the external system data source.",
            "type":"string"
        },
        "timeWorked":{
            "description":"The time worked for the tracking event for recording purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "timeDriven":{
            "description":"The time driven for the tracking event for recording purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "driverCalEventGid":{
            "description":"This is a GID for the driver calendar event being recorded with the tracking event, such as vacation time.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "orderBaseGid":{
            "description":"The order base identifier for the order level data of the tracking event.  Define by order base, order release, or order release line.",
            "type":"string"
        },
        "orderReleaseGid":{
            "description":"The order release identifier for the order level data of the tracking event. Define by order base, order release, or order release line.",
            "type":"string"
        },
        "orRefnumQualGid":{
            "description":"The order release reference qualifier for the order level data of the tracking event. Define by order base, order release, or order release line.",
            "type":"string"
        },
        "orRefnumValue":{
            "description":"The order release reference number value for the defined qualifier.",
            "type":"string"
        },
        "trackingNumber":{
            "description":"The specific tracking number for the shipment provided by the service provider and is matched to a reference qualifier called tracking number.",
            "type":"string"
        },
        "carDestinationLocationGid":{
            "description":"Shipment tracking event data for rail shipments. Defines the rail car destination location GID.",
            "type":"string"
        },
        "carDestinationCountry":{
            "description":"Shipment tracking event data for rail shipments. Defines the rail car destination country.",
            "type":"string"
        },
        "erpc":{
            "description":"Shipment tracking event data for rail shipments. ERPC is a system for abbreviating rail location names.",
            "type":"string"
        },
        "filingResponseType":{
            "description":"The filing response type for Automated Export System (AES) via integration as tracking events.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "shipGroupGid":{
            "description":"The shipment group GID associated with the tracking event.",
            "type":"string"
        },
        "shipGroupTypeGid":{
            "description":"The shipment group type (such as import, export, cargo manifest) for the shipment group associated with the tracking event.",
            "type":"string"
        },
        "orderReleaseLineGid":{
            "description":"The order release line for the order level data of the tracking event. Define by order base, order release, or order release line.",
            "type":"string"
        },
        "orlRefnumValue":{
            "description":"The order release line reference number value for the defined qualifier.",
            "type":"string"
        },
        "orLineRefnumQualGid":{
            "description":"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.",
            "type":"string"
        },
        "indicator":{
            "description":"A indicator that can be set to flag tracking event status.",
            "type":"string"
        },
        "carRepairHours":{
            "description":"Shipment tracking event data for rail shipments. Defines the rail car repair hours.",
            "type":"number",
            "format":"double"
        },
        "carInterchangeEtiDate":{
            "description":"Shipment tracking event data for rail shipments. Defines the rail car interchange date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "nextJunctionSplc":{
            "description":"Shipment tracking event data for rail shipments. This field specifies the interchange junction code. ETA for this junction will be Interchange ETI Date.",
            "type":"string"
        },
        "aheadLateTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "aheadOrLate":{
            "description":"No description.",
            "type":"string"
        },
        "locationGid":{
            "description":"This field describes the location at which the event occurs.",
            "type":"string"
        },
        "equipmentInitial":{
            "description":"The column defines the equipment initial for the equipment for which the event occurs.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"The column defines the equipment number for the equipment for which the event occurs.",
            "type":"string"
        },
        "carDestTimeZoneGid":{
            "description":"The time zone GID for the car destination Estimated Time of Arrival date.",
            "type":"string"
        },
        "carInterchangeTimeZoneGid":{
            "description":"The time zone GID for the car interchange Estimated Time of Interchange date.",
            "type":"string"
        },
        "shipmentStatusType":{
            "description":"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.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "shipmentRefnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.shipmentRefnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "stops":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.stops"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.equipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "hosRules":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.hosRules"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.shipUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documentResponses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.documentResponses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipmentGroupRefnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.shipmentGroupRefnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedInvolvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedInvolvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedDrivers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedDrivers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedEquipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedEquipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedPowerUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedPowerUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedShipmentGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedShipmentGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedShipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedShipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedSShipUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedSShipUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedSShipUnitLines":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedSShipUnitLines"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedDocuments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedDocuments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedOrderBases":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedOrderBases"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedObLines":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedObLines"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedObShipUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedObShipUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedOrderReleases":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedOrderReleases"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedOrLines":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedOrLines"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedOrShipUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedOrShipUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedOrShipUnitLines":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedOrShipUnitLines"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "matchedDmTransactions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.matchedDmTransactions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : aheadLateTime

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

• object dateTimeType

{
    "description":"Shipment tracking event data for rail shipments. Defines the estimated time of arrival to the car destination node.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : carInterchangeEtiDate

Shipment tracking event data for rail shipments. Defines the rail car interchange date.

Match All

Show Source

• object dateTimeType

{
    "description":"Shipment tracking event data for rail shipments. Defines the rail car interchange date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : dischargeOrCompletionDate

The discharge or completion date for the vessel used in the tracking event.

Match All

Show Source

• object dateTimeType

{
    "description":"The discharge or completion date for the vessel used in the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : documentResponses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.documentResponses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.equipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eventdate

The tracking event date.

Match All

Show Source

• object dateTimeType

{
    "description":"The tracking event date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : eventEndDate

The event end date associated with the tracking event.

Match All

Show Source

• object dateTimeType

{
    "description":"The event end date associated with the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : eventReceivedDate

The time stamp for when the tracking event was received.

Match All

Show Source

• object dateTimeType

{
    "description":"The time stamp for when the tracking event was received.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : hosRules

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.hosRules"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : matchedDmTransactions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedDmTransactions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedDocuments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedDocuments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedDrivers

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedDrivers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedEquipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedEquipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedInvolvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedInvolvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedObLines

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedObLines"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedObShipUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedObShipUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedOrderBases

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedOrderBases"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedOrderReleases

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedOrderReleases"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedOrLines

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedOrLines"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedOrShipUnitLines

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedOrShipUnitLines"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedOrShipUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedOrShipUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedPowerUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedPowerUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedShipmentGroups

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedShipmentGroups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedShipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedShipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedSShipUnitLines

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedSShipUnitLines"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : matchedSShipUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.matchedSShipUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : shipmentGroupRefnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.shipmentGroupRefnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : shipmentRefnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.shipmentRefnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : shipOrSailDate

The ship sail date for the vessel used in the tracking event.

Match All

Show Source

• object dateTimeType

{
    "description":"The ship sail date for the vessel used in the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : shipUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.shipUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : stops

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.stops"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : temperature

The temperature associated with the shipment tracking event.

Match All

Show Source

• object amountType

{
    "description":"The temperature associated with the shipment tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : timeDriven

The time driven for the tracking event for recording purposes.

Match All

Show Source

• object amountType

{
    "description":"The time driven for the tracking event for recording purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : timeWorked

The time worked for the tracking event for recording purposes.

Match All

Show Source

• object amountType

{
    "description":"The time worked for the tracking event for recording purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : volumeValue

A total volume value associated with the shipment tracking event.

Match All

Show Source

• object amountType

{
    "description":"A total volume value associated with the shipment tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weightValue

A total weight value associated with the shipment tracking event.

Match All

Show Source

• object amountType

{
    "description":"A total weight value associated with the shipment tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.documentResponses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.documentResponses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.documentResponses

Type: object

Show Source

• 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.

{
    "properties":{
        "responseSeq":{
            "description":"The response sequence number primary key for multiple document filing response tracking events.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "elementRefQualifier":{
            "description":"The filing element reference qualifier for the tracking event.",
            "type":"string"
        },
        "elementRefValue":{
            "description":"The filing element value for the qualifier defined.",
            "type":"string"
        },
        "responseCode":{
            "description":"The response code for this filing response tracking event.",
            "type":"string"
        },
        "responseSeverity":{
            "description":"The response severity indicator for this tracking event.",
            "type":"string"
        },
        "responseText":{
            "description":"The response text for this response filing tracking event.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.equipments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.equipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.equipments

Type: object

Show Source

• 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

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "sEquipmentGid":{
            "description":"The shipment equipment GID linking an equipment record to the shipment.",
            "type":"string"
        },
        "equipmentInitial":{
            "description":"The equipment initial is a mark that is registered with national or international authorities that is associated with a specific owner.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"Number identifying the equipment used.",
            "type":"string"
        },
        "equipmentInitialNumber":{
            "description":"The Equipment Initial Number field is a concatenation of equipment initial and equipment number.",
            "type":"string"
        },
        "equipmentTypeGid":{
            "description":"An equipment type is a category of equipment. Oracle Transportation Management uses equipment types when it determines equipment capacity.",
            "type":"string"
        },
        "intermodalEquipmentLength":{
            "description":"The reported length of the equipment in the tracking event.",
            "type":"number",
            "format":"double"
        },
        "tareWeight":{
            "description":"The tare weight recorded on the tracking event for the shipment equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "scaleName":{
            "description":"The received volume recorded on the tracking event for the shipment ship unit.",
            "type":"string"
        },
        "scaleLocation":{
            "description":"The scale location recorded for the tracking event.",
            "type":"string"
        },
        "scaleTicket":{
            "description":"Sequence ID printed on the scale ticket when weight is recorded.",
            "type":"string"
        },
        "scaleWeight":{
            "description":"The scale weight recorded on the tracking event for the shipment equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weightQualifier":{
            "description":"The type of weight that is represented by the scale weight; Estimate, Net, or Gross weight. E = Estimated, G = Gross, N = Net",
            "type":"string"
        },
        "equipmentGid":{
            "description":"The equipment GID if the equipment is an asset managed in OTM.",
            "type":"string"
        },
        "equipmentRefnumQualGid":{
            "description":"The equipment reference number qualifier to identify an equipment entity for a tracking event.",
            "type":"string"
        },
        "equipmentRefnumValue":{
            "description":"The equipment reference value associated with the equipment reference number qualifier.",
            "type":"string"
        },
        "chassisInitial":{
            "description":"The chassis initial is a mark that is registered with national or international authorities that is associated with a specific owner",
            "type":"string"
        },
        "chassisNumber":{
            "description":"Number identifying the used in conjunction with the equipment on the tracking event.",
            "type":"string"
        },
        "chassisInitialNumber":{
            "description":"The Chassis Initial Number field is a concatenation of chassis initial and chassis number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "sEquipmentIndex":{
            "description":"The standing order of the equipment on the shipment",
            "type":"number",
            "format":"int32"
        },
        "aarCarType":{
            "description":"The AAR car type associated with the rail equipment on the tracking event.",
            "type":"string"
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.equipments.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : scaleWeight

The scale weight recorded on the tracking event for the shipment equipment.

Match All

Show Source

• object amountType

{
    "description":"The scale weight recorded on the tracking event for the shipment equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : seals

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.equipments.seals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tareWeight

The tare weight recorded on the tracking event for the shipment equipment.

Match All

Show Source

• object amountType

{
    "description":"The tare weight recorded on the tracking event for the shipment equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.equipments.seals

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.equipments.seals"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.equipments.seals

Type: object

Show Source

• 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.

{
    "properties":{
        "sealSequence":{
            "description":"The seal sequence number that refers to the compartment that is being sealed.",
            "type":"number",
            "format":"int32"
        },
        "sEquipmentGid":{
            "description":"The shipment equipment GID.",
            "type":"string"
        },
        "sealNumber":{
            "description":"The seal number that identifies the seal tag.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.hosRules

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.hosRules"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.hosRules

Type: object

Show Source

• 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.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "hosRuleGid":{
            "description":"The hours of service rule GID for the given tracking event.",
            "type":"string"
        },
        "activityTime":{
            "description":"The activity time associated with the hours of service reported for the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "ruleBeginTime":{
            "description":"The begin time defined for the hours of service rule.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "activityTimeRemain":{
            "description":"The activity time remaining against that hours of service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityTime

The activity time associated with the hours of service reported for the tracking event.

Match All

Show Source

• object amountType

{
    "description":"The activity time associated with the hours of service reported for the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : activityTimeRemain

The activity time remaining against that hours of service.

Match All

Show Source

• object amountType

{
    "description":"The activity time remaining against that hours of service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : ruleBeginTime

The begin time defined for the hours of service rule.

Match All

Show Source

• object dateTimeType

{
    "description":"The begin time defined for the hours of service rule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedDmTransactions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedDmTransactions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedDmTransactions

Type: object

Show Source

• 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

{
    "properties":{
        "dmTransactionSeqNo":{
            "description":"Contains the unique identifier for the demurrage transaction.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedDocuments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedDocuments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedDocuments

Type: object

Show Source

• documentGid: string
  The document GID for the tracking event.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "documentGid":{
            "description":"The document GID for the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedDrivers

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedDrivers"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedDrivers

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• driverGid: string
  The driver GID for the tracking event.
• links: array links
  Read Only: true

{
    "properties":{
        "driverGid":{
            "description":"The driver GID for the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedEquipments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedEquipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedEquipments

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentGid: string
  The equipment GID for the tracking event.
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentGid":{
            "description":"The equipment GID for the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedInvolvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedInvolvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedInvolvedParties

Type: object

Show Source

• 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.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "matchObjectType":{
            "description":"The object type that was matched to the involved party. For example, order release, order base, or shipment.",
            "type":"string"
        },
        "matchObjInvPartyQualGid":{
            "description":"The involved party qualifier for the tracking event.",
            "type":"string"
        },
        "matchObjInvPartyConGid":{
            "description":"The involved party value for the involved party qualifier on the tracking event.",
            "type":"string"
        },
        "commMethodGid":{
            "description":"The communication method used to notify regarding the tracking event. ",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedObLines

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedObLines"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedObLines

Type: object

Show Source

• 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.

{
    "properties":{
        "orderBaseGid":{
            "description":"The order base identifier for the line that is  associated with the tracking event.",
            "type":"string"
        },
        "obLineGid":{
            "description":"The order base line that is associated with the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedObShipUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedObShipUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedObShipUnits

Type: object

Show Source

• 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.

{
    "properties":{
        "orderBaseGid":{
            "description":"The order base identifier for the ship unit that is  associated with the tracking event.",
            "type":"string"
        },
        "obShipUnitGid":{
            "description":"The order base ship unit that is associated with the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedOrderBases

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedOrderBases"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedOrderBases

Type: object

Show Source

• 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.

{
    "properties":{
        "orderBaseGid":{
            "description":"The order base GID for the tracking event.",
            "type":"string"
        },
        "reportingGluser":{
            "description":"The reporting application user if the tracking event was entered via the system's tracking event UI.",
            "type":"string"
        },
        "bsContactName":{
            "description":"The contact name from the tracking event.",
            "type":"string"
        },
        "bsContactFunctionCode":{
            "description":"The contact name function code from the tracking event.",
            "type":"string"
        },
        "eventDate":{
            "description":"The event date and time reported on the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "bsStatusCodeGid":{
            "description":"The status code identified on the tracking event.",
            "type":"string"
        },
        "servprovAliasQualGid":{
            "description":"The service provider alias qualifier code, such as SCAC, from the entered tracking event.",
            "type":"string"
        },
        "servprovAliasValue":{
            "description":"The service provide alias value from the tracking event.",
            "type":"string"
        },
        "timeZoneGid":{
            "description":"The time zone for the tracking event time entered.",
            "type":"string"
        },
        "statusLevel":{
            "description":"A descriptor code for the status level of the tracking event.",
            "type":"string"
        },
        "description":{
            "description":"A description of the tracking event.",
            "type":"string"
        },
        "obRefnumQualGid":{
            "description":"The order base reference number value associated with the order release qualifier that came on the tracking event.",
            "type":"string"
        },
        "obRefnumValue":{
            "description":"The order base reference number qualifier identifier.",
            "type":"string"
        },
        "bsReasonCodeGid":{
            "description":"The reason code from the tracking event that was matched to the order base.",
            "type":"string"
        },
        "bsResponsiblePartyGid":{
            "description":"The responsible party identifier of the source of the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eventDate

The event date and time reported on the tracking event.

Match All

Show Source

• object dateTimeType

{
    "description":"The event date and time reported on the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedOrderReleases

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedOrderReleases"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedOrderReleases

Type: object

Show Source

• 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.

{
    "properties":{
        "orderReleaseGid":{
            "description":"The order release GID for the tracking event.",
            "type":"string"
        },
        "reportingGluser":{
            "description":"The service provider associated with generating the tracking event.",
            "type":"string"
        },
        "bsContactName":{
            "description":"The reporting method that links into the communication methods defined for OTM.",
            "type":"string"
        },
        "bsContactFunctionCode":{
            "description":"This indicates the shipment stop number for a stop based event.",
            "type":"string"
        },
        "eventDate":{
            "description":"The location identifier of an location based event. This will be null for non-location based events.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "bsStatusCodeGid":{
            "description":"A Y/N indicator to display the status history.",
            "type":"string"
        },
        "timeZoneGid":{
            "description":"The monthly range partition to manage purging status messages.",
            "type":"string"
        },
        "statusLevel":{
            "description":"A descriptor code for the status level of the tracking event.",
            "type":"string"
        },
        "description":{
            "description":"A description of the tracking event.",
            "type":"string"
        },
        "orderReleaseRefnumValue":{
            "description":"The order release reference number value associated with the order release qualifier that came on the tracking event.",
            "type":"string"
        },
        "orderReleaseRefnumQualGid":{
            "description":"The order release reference number qualifier identifier.",
            "type":"string"
        },
        "bsReasonCodeGid":{
            "description":"The reason code from the tracking event that was matched to the order releases.",
            "type":"string"
        },
        "bsResponsiblePartyGid":{
            "description":"The responsible party identifier of the source of the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eventDate

The location identifier of an location based event. This will be null for non-location based events.

Match All

Show Source

• object dateTimeType

{
    "description":"The location identifier of an location based event. This will be null for non-location based events.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedOrLines

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedOrLines"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedOrLines

Type: object

Show Source

• 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.

{
    "properties":{
        "orderReleaseGid":{
            "description":"The order release identifier for the line that is  associated with the tracking event.",
            "type":"string"
        },
        "orderReleaseLineGid":{
            "description":"The order release line that is associated with the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedOrShipUnitLines

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedOrShipUnitLines"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedOrShipUnitLines

Type: object

Show Source

• 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.

{
    "properties":{
        "shipUnitGid":{
            "description":"The order release ship unit identifier for the ship unit line associated with the tracking event.",
            "type":"string"
        },
        "shipUnitLineNo":{
            "description":"The order release ship unit line identifier associated with the tracking event.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedOrShipUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedOrShipUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedOrShipUnits

Type: object

Show Source

• 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.

{
    "properties":{
        "orderReleaseGid":{
            "description":"The order release identifier for the ship unit that is  associated with the tracking event.",
            "type":"string"
        },
        "shipUnitGid":{
            "description":"The order release ship unit that is associated with the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedPowerUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedPowerUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedPowerUnits

Type: object

Show Source

• 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.

{
    "properties":{
        "powerUnitGid":{
            "description":"The power unit GID for the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedShipmentGroups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedShipmentGroups"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedShipmentGroups

Type: object

Show Source

• 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.

{
    "properties":{
        "shipGroupGid":{
            "description":"The shipment group GID for the tracking event.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The service provider associated with generating the tracking event.",
            "type":"string"
        },
        "reportingGluser":{
            "description":"The reporting application user if the tracking event was entered via the system's tracking event UI.",
            "type":"string"
        },
        "reportingComMethodGid":{
            "description":"The reporting method that links into the communication methods defined for OTM.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedShipments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedShipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedShipments

Type: object

Show Source

• 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.

{
    "properties":{
        "shipmentGid":{
            "description":"The shipment identifier for the tracking event.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The service provider associated with generating the tracking event.",
            "type":"string"
        },
        "reportingGluser":{
            "description":"The reporting application user if the tracking event was entered via the system's tracking event UI.",
            "type":"string"
        },
        "reportingMethod":{
            "description":"The reporting method that links into the communication methods defined for OTM.",
            "type":"string"
        },
        "shipmentStopNum":{
            "description":"The shipment stop number for a stop based event.",
            "type":"number",
            "format":"int32"
        },
        "eventLocationGid":{
            "description":"The location identifier of an location based event. This will be null for non-location based events.",
            "type":"string"
        },
        "isHidden":{
            "description":"A Y/N indicator to display the status history.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedSShipUnitLines

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedSShipUnitLines"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedSShipUnitLines

Type: object

Show Source

• 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.

{
    "properties":{
        "sShipUnitGid":{
            "description":"The shipment ship unit GID for the tracking event.",
            "type":"string"
        },
        "sShipUnitLineNo":{
            "description":"The shipment ship unit line number for the tracking event.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.matchedSShipUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.matchedSShipUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.matchedSShipUnits

Type: object

Show Source

• 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.

{
    "properties":{
        "sShipUnitGid":{
            "description":"The shipment ship unit GID for the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The shipment remark qualifier identifier.",
            "type":"string"
        },
        "remarkSequence":{
            "description":"A remark sequence number if entering multiple remarks for a shipment tracking event.",
            "type":"number",
            "format":"int64"
        },
        "remarkText":{
            "description":"The shipment remark text value for the qualifier defined.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.shipmentGroupRefnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.shipmentGroupRefnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.shipmentGroupRefnums

Type: object

Show Source

• 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.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "shipGroupRefnumQualGid":{
            "description":"The shipment group reference number qualifier identifier.",
            "type":"string"
        },
        "shipGroupRefnumValue":{
            "description":"The shipment group reference number value for the qualifier defined.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.shipmentRefnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.shipmentRefnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.shipmentRefnums

Type: object

Show Source

• 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.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "shipmentRefnumQualGid":{
            "description":"The shipment reference number qualifier identifier.",
            "type":"string"
        },
        "shipmentRefnumValue":{
            "description":"The shipment reference number value for the qualifier defined.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.shipUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.shipUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.shipUnits

Type: object

Show Source

• 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.

{
    "properties":{
        "sShipUnitGid":{
            "description":"The shipment ship unit associated with the tracking event being reported.",
            "type":"string"
        },
        "receivedWeight":{
            "description":"The received weight recorded on the tracking event for the shipment ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedVolume":{
            "description":"The received volume recorded on the tracking event for the shipment ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedShipUnitCount":{
            "description":"The received ship unit count recorded on the tracking event for the shipment ship unit.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "lines":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.shipUnits.lines"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : lines

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.shipUnits.lines"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : receivedVolume

The received volume recorded on the tracking event for the shipment ship unit.

Match All

Show Source

• object amountType

{
    "description":"The received volume recorded on the tracking event for the shipment ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : receivedWeight

The received weight recorded on the tracking event for the shipment ship unit.

Match All

Show Source

• object amountType

{
    "description":"The received weight recorded on the tracking event for the shipment ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.shipUnits.lines

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.shipUnits.lines"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.shipUnits.lines

Type: object

Show Source

• 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.

{
    "properties":{
        "sShipUnitLineNo":{
            "description":"The shipment ship unit line associated with the tracking event being reported.",
            "type":"number",
            "format":"int64"
        },
        "packagedItemGid":{
            "description":"The packaging item defined for the shipping line.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The packaging unit associated with the packaging item.",
            "type":"string"
        },
        "receivedWeight":{
            "description":"The received weight recorded on the tracking event for the shipment ship unit line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedVolume":{
            "description":"The received volume recorded on the tracking event for the shipment ship unit line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedItemPackageCount":{
            "description":"The received item count in eaches recorded on the tracking event for the shipment ship unit line.",
            "type":"number",
            "format":"int64"
        },
        "receivedPackagingUnitCount":{
            "description":"The received item count in terms of packaging units recorded on the tracking event for the shipment ship unit line.",
            "type":"number",
            "format":"int64"
        },
        "receivedCountPerShipUnit":{
            "description":"The received item count in eaches on a per ship unit received recorded on the tracking event for the shipment ship unit line.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : receivedVolume

The received volume recorded on the tracking event for the shipment ship unit line.

Match All

Show Source

• object amountType

{
    "description":"The received volume recorded on the tracking event for the shipment ship unit line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : receivedWeight

The received weight recorded on the tracking event for the shipment ship unit line.

Match All

Show Source

• object amountType

{
    "description":"The received weight recorded on the tracking event for the shipment ship unit line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.specialServices

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.specialServices

Type: object

Show Source

• 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.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service identifier that is being reported against with the tracking event being reported.",
            "type":"string"
        },
        "serviceDuration":{
            "description":"The time duration that occurred for the special service on the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "serviceTime":{
            "description":"The time for the special service activity on the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "weight":{
            "description":"The weight for the special service activity recorded on the tracking event for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume for the special service activity recorded on the tracking event for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "distance":{
            "description":"The distance for the special service activity recorded on the tracking event for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "itemCount":{
            "description":"The item piece count for the special service activity recorded on the tracking event for the shipment.",
            "type":"number",
            "format":"int64"
        },
        "shipUnitCount":{
            "description":"The ship unit count for the special service activity recorded on the tracking event for the shipment.",
            "type":"number",
            "format":"int64"
        },
        "serviceCompletionState":{
            "description":"An indication if the special service activity was completed with the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/trackingEvents.specialServices.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : distance

The distance for the special service activity recorded on the tracking event for the shipment.

Match All

Show Source

• object amountType

{
    "description":"The distance for the special service activity recorded on the tracking event for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/trackingEvents.specialServices.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : serviceDuration

The time duration that occurred for the special service on the tracking event.

Match All

Show Source

• object amountType

{
    "description":"The time duration that occurred for the special service on the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : serviceTime

The time for the special service activity on the tracking event.

Match All

Show Source

• object dateTimeType

{
    "description":"The time for the special service activity on the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : volume

The volume for the special service activity recorded on the tracking event for the shipment.

Match All

Show Source

• object amountType

{
    "description":"The volume for the special service activity recorded on the tracking event for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight for the special service activity recorded on the tracking event for the shipment.

Match All

Show Source

• object amountType

{
    "description":"The weight for the special service activity recorded on the tracking event for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.specialServices.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.specialServices.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.specialServices.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "remarkSequence":{
            "description":"A remark sequence number if entering multiple remarks for a shipment special service tracking event.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"The shipment remark text value for the qualifier defined.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object trackingEvents.stops

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/trackingEvents.stops"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : trackingEvents.stops

Type: object

Show Source

• 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.

{
    "properties":{
        "iRecNo":{
            "description":"The record number primary key identifier for the tracking event specified.",
            "type":"number",
            "format":"int64"
        },
        "stopSequence":{
            "description":"The stop sequence associated with the stop if a shipment identifier is entered and stop tracking event is for an existing stop.",
            "type":"number",
            "format":"int32"
        },
        "portLocationFunctionCode":{
            "description":"The port location function code for ocean tracking events.",
            "type":"string"
        },
        "locationRefnumQualGid":{
            "description":"The location reference number quantifier associated with a location reference number if supplied on the tracking event.",
            "type":"string"
        },
        "locationIdValue":{
            "description":"The location reference value associated with the reference number qualifier.",
            "type":"string"
        },
        "locationName":{
            "description":"A location name if supplied with the tracking event.",
            "type":"string"
        },
        "eventCity":{
            "description":"The city associated with the tracking event.",
            "type":"string"
        },
        "eventState":{
            "description":"The state associated with the tracking event.",
            "type":"string"
        },
        "eventCountry":{
            "description":"The country associated with the tracking event.",
            "type":"string"
        },
        "splcCode":{
            "description":"If the tracking stop is for a rail location the Standard Point Location Code (SPLC) can be used.",
            "type":"string"
        },
        "latitude":{
            "description":"A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.",
            "type":"string"
        },
        "longitude":{
            "description":"A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.",
            "type":"string"
        },
        "terminalName":{
            "description":"The terminal name for port associated with the tracking event status.",
            "type":"string"
        },
        "gatePierDoorNumber":{
            "description":"The gate pier door number assigned to the shipment tracking status.",
            "type":"string"
        },
        "timeZoneGid":{
            "description":"The time zone identifier for the tracking event.",
            "type":"string"
        },
        "eventdate":{
            "description":"The tracking event date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "aeiIndicator":{
            "description":"The AEI indicator for the tracking event.",
            "type":"string"
        },
        "referencePosition":{
            "description":"The position of this stop relative to the yet-to-be-created new stop.",
            "type":"string"
        },
        "stopType":{
            "description":"The stop type for the new stop created with tracking event.",
            "type":"string"
        },
        "locationGid":{
            "description":"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.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "erpc":{
            "description":"If the tracking stop is for a rail location the Eastern Railroad President's Conference (ERPC) can be used.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eventdate

The tracking event date.

Match All

Show Source

• object dateTimeType

{
    "description":"The tracking event date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top