TrackingShipment

The root object for a single shipment's tracking details.

  • items
    Type: array object[] · TrackingItem[]
    required

    List of items (parcels) within the shipment.

    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.

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

  • shipmentNumber
    Type: string
    required

    The main identifier for the shipment.

  • shopId
    Type: integer
    required

    ID of the shop.

  • consigneeReference
    Type: string

    Customer reference associated with the recipient (consignee).

  • consignorReference
    Type: string

    Shop reference associated with the sender (consignor).

  • properties
    Type: object

    Additional shipment properties.

  • shopName
    Type: string

    Name of the shop associated with the shipment.