ShipmentOrderInfo Structure

This structure defines basic parameters of the shipments for which a courier is booked. Required in the bookCourier method if courier is ordered without providing shipment IDs.

Structure Fields

Field Name	Type	Required?	Description
shipper	Address structure	Yes	Sender details
numberOfExPieces	integer	Yes	Quantity of express shipments
numberOfDrPieces	integer	Yes	Quantity of general shipments
totalWeight	integer	Yes	Sum weight of the parcels
heaviestPieceWeight	integer	Yes	Weight of the heaviest parcel

Example:

<shipmentOrderInfo>
    <shipper>
        <name>Testan Testington</name>
        <postalCode>02796</postalCode>
        <city>Warsaw</city>
        <street>Wąwozowa</street>
        <houseNumber>2</houseNumber>
        <contactPerson>Testan Testington</contactPerson>
        <contactEmail>testan@anydomain.eu</contactEmail>
    </shipper>
    <numberOfExPieces>3</numberOfExPieces>
    <numberOfDrPieces>0</numberOfDrPieces>
    <totalWeight>40</totalWeight>
    <heaviestPieceWeight>15</heaviestPieceWeight>
</shipmentOrderInfo>

Go back to topic list