TrackingItem

Details and events for a single parcel/item within a shipment.

  • events
    Type: array object[] · DetailedTrackingEvent[]
    required

    Chronological list of detailed tracking events for this parcel.

    Detailed single event record.

    • eventGroup
      Type: object · EventGroup
      required

      The grouping category for the event type.

    • eventTime
      Type: string
      required

      Local time the event occurred (YYYY-MM-DD HH:MM:SS).

    • eventType
      Type: object · EventType
      required

      Details about the specific type of event.

    • additionalInfo
      Type: string nullable

      Any additional text information related to the event.

    • changeUserId
      Type: integer nullable

      ID of the user who registered the change.

    • changeUsername
      Type: string nullable

      Username who registered the change.

    • comChannelType
      Type: string nullable

      Communication channel type (if applicable).

    • eventData
      Type: object nullable

      Extra data payload for the event.

    • eventTimeUtc
      Type: stringFormat: date-time

      UTC time the event occurred (ISO 8601 format).

    • lat
      Type: numberFormat: double nullable

      Latitude of the event location.

    • locationContext
      Type: string nullable

      Contextual name of the location (e.g., shop name).

    • locationContextId
      Type: integer nullable

      ID of the location context.

    • lon
      Type: numberFormat: double nullable

      Longitude of the event location.

    • message
      Type: string nullable

      Specific message text associated with the event.

    • regSystem
      Type: object · RegistrationSystem nullable

      The system used to register the event.

  • freightProductId
    Type: integer
    required

    ID of the freight product used.

  • parcelStatus
    Type: string
    required

    Current overall status of the parcel.

  • trackingNumber
    Type: string
    required

    Unique tracking number for the individual parcel.

  • freightProductName
    Type: string

    Name of the freight product.

  • linkedParcelNumbers
    Type: array string[]

    List of other linked parcel numbers.

  • returnCode
    Type: string nullable

    Return code if the parcel is being returned.