ShipmentBasicData Structure

This structure provides basic data on the shipment. Elements of this type are returned e.g. by the getMyShipments method.

Structure Fields

Field Name	Type	Required?	Description
shipmentId	integer	Yes	Parcel ID
created	string	Yes	Shipment creation date in YYYY-MM-DD format
shipper	Address	Yes	Sender data communicated in the address structure
receiver	Address	Yes	Recipient data communicated in the address structure
orderStatus	string	Yes	Information whether a courier is booked for this shipment

Example:

<ShipmentBasic>
    <shipmentId>11102224567</shipmentId>
    <created>2012-11-15</created>
    <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>
    <receiver>
        <name>Receiver received</name>
        <postalCode>00909</postalCode>
        <city>Warsaw</city>
        <street>Testville</street>
        <houseNumber>2</houseNumber>
        <contactPerson>Receiver</contactPerson>
        <contactEmail>recipient@anydomain.eu</contactEmail>
    </receiver>
    <orderStatus/>
</ShipmentBasic>

Go back to topic list