BookingRequest

Request body for registering a new parcel shipment.

items
Type: array object[] · Item[]
required

List of parcel items being shipped.
Details about the physical item being shipped.
- itemNumber
  Type: integer
  required
  
  Sequence number for the item in the shipment.
- trackingReference
  Type: string
  max length:
  35
  required
  
  Optional external tracking reference for the item.
- contents
  Type: string
  max length:
  100
  
  Brief description of the contents for customs/declaration.
- height
  Type: number
  
  Item height in centimeters (cm).
- length
  Type: number
  
  Item length in centimeters (cm).
- volume
  Type: integer
  
  Item volume in cubic decimeter.
- weight
  Type: integer
  
  Item weight in grams (g).
- width
  Type: number
  
  Item width in centimeters (cm).
parties
Type: array object[] · Party[] 2…3
required

Consignee and consignor details. Must contain at least two Party objects.
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.
shopId
Type: integer
required

The identifier of the shop making the booking.
transportSolutionId
Type: integer
required

The chosen transport solution ID.
desiredDeliveryDate
Type: stringFormat: date nullable

Requested delivery date in ISO 8601 format (YYYY-MM-DD). Pass null for standard delivery.
messageToCarrier
Type: string nullable

Optional message to the carrier handling the shipment.
messageToConsignee
Type: string nullable

Optional message to the recipient (consignee).
shipmentId
Type: string nullable

An optional external identifier for the shipment (e.g., customer order ID). Pass null to let Helthjem assign one.