BookingResponseItem

A parcel item as returned after a successful booking, including Helthjem-assigned tracking references and routing metadata.

  • itemNumber
    Type: integer
    required

    Sequence number for the item in the shipment.

  • trackingReference
    Type: string
    required

    Assigned GS1 tracking reference for the item.

  • articles
    Type: array object[]

    List of articles within the item.

    Empty object
  • contents
    Type: string

    Brief description of item contents.

  • contentValue
    Type: number nullable

    Declared value of item contents.

  • externalOrderId
    Type: string nullable

    External order identifier, if applicable.

  • externalSupplierId
    Type: string nullable

    External supplier identifier, if applicable.

  • height
    Type: number

    Item height in centimetres.

  • itemId
    Type: integer nullable

    Internal item ID, if assigned.

  • length
    Type: number

    Item length in centimetres.

  • linkedParcelType
    Type: string nullable

    Type of linked parcel, if applicable.

  • linkedTrackingReference
    Type: string nullable

    Tracking reference of a linked parcel, if applicable.

  • properties
    Type: object

    Additional item properties, including a short display identifier.

  • returnCode
    Type: string nullable

    Return code if the parcel is being returned.

  • volume
    Type: integer nullable

    Item volume in cubic decimetres.

  • weight
    Type: integer

    Item weight in grams.

  • width
    Type: number

    Item width in centimetres.