Party

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:  
    100    Format: 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.