BookingResponse

Response after a successful booking.

freightProductId
Type: integer
required

ID of the freight product assigned to the shipment.
items
Type: array object[] · BookingResponseItem[]
required

The registered parcel items, including assigned tracking references.
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.
orderId
Type: integer
required

The unique Helthjem numeric order identifier.
parties
Type: array object[] · Party[]
required

The consignee and consignor details as registered.
Consignee (recipient) or Consignor (sender) details.
- address
  Type: string
  max length:
  105
  required
  
  Street address, including street number and apartment/entrance.
- countryCode
  Type: string
  required
  
  Two-letter country code (ISO 3166-1).
- email
  Type: string
  max length:
  100Format: email
  required
  
  Email address for notification/contact.
- name
  Type: string
  required
  
  Name of the party. Mandatory for consignee and consignor.
- phone1
  Type: string
  max length:
  100
  required
  
  Primary phone number.
- postalName
  Type: string
  required
  
  Also known as city.
- type
  Type: stringenum
  required
  
  Role of the party in the shipment.
  
  values
  consignee
  consignor
  servicePoint
- zipCode
  Type: string
  required
  
  Also known as postal code.
- coaddress
  Type: string nullable
  
  Care-of address, if applicable.
- contact
  Type: string
  max length:
  35
  
  Internal contact identifier.
- detailedAddress
  Type: object nullable
  
  Structured detailed address object, returned in booking responses. Not required on input.
- id
  Type: integer nullable
  
  Identifier that can be used to identify the same party between different shipments.
- phone2
  Type: string
  max length:
  100 nullable
  
  Secondary phone number.
- reference
  Type: string
  max length:
  35
  
  Internal reference for this party.
properties
Type: object · BookingResponseProperties
required

Routing and operational metadata assigned to the shipment by Helthjem.
- areaId
  Type: string
  
  Internal area identifier.
- freightProductName
  Type: string
  
  Internal name of the freight product.
- mainCarNumber
  Type: string
  
  Main car/route number for the shipment.
- pickupZipString
  Type: string
  
  Pickup zip code and city.
- productName
  Type: string
  
  Full product name.
- regionId
  Type: string
  
  Internal region identifier.
- routeAddress
  Type: string
  
  Address of the assigned route hub.
- routeDescription
  Type: string
  
  Description of the assigned route.
- routeName
  Type: string
  
  Internal route name/number.
- routeSeq
  Type: string
  
  Sequence number within the route.
- routeZipAndCity
  Type: string nullable
  
  Route zip and city string, if available.
- routing
  Type: string
  
  Full internal routing string.
- routingCode
  Type: string
  
  Simple routing code.
- routingDescription
  Type: string
  
  Description of the routing.
- routingDetailed
  Type: string
  
  Detailed routing breakdown.
- shopName
  Type: string
  
  Name of the shop that made the booking.
- transportCompanyId
  Type: string
  
  ID of the transport company.
- transportNetId
  Type: string
  
  ID of the transport network.
shipmentId
Type: string
required

The GS1-formatted shipment identifier. Used for label generation and tracking.
additionalServices
Type: array object[]

List of additional services applied to the shipment.
Empty object