ShipmentFullData Structure

This structure provides full data on the selected shipment. Completed structures of this type are used to define shipments created with the createShipments method.

Structure Fields

Field Name	Type	Required?	Description
shipper	Address	Yes	Sender data communicated in the address structure
receiver	ReceiverAddress	Yes	Recipient data communicated in the address structure
pieceList	array	Yes	Parcel data, list of PieceDefinition elements
payment	PaymentData	Yes	Payer and payment data
service	ServiceDefinition	Yes	Data on the selected shipping service and special services
shipmentDate	string	Yes	Shipping date (visible on the consignment note) - in YYYY-MM-DD format
skipRestrictionCheck	bool	No	Should the restriction check be omitted?
comment	string(100)	No	Additional comments (visible on the consignment note)
content	string(30)	Yes	Content of the parcel
reference	string(200)	No	Shipment reference number
wayBill	string(11)	No	Shipment waybill number
customs	CustomsData	No (required for shipments delivered outside EU)	Data on customs clearance
shipmentId	integer	-	Response only Shipment ID (if the shipment has already been created, otherwise field left blank)
created	string	-	Response only Shipment creation date in YYYY-MM-DD format (if the shipment has already been created, otherwise field left blank)
orderStatus	string	-	Response only Information whether a courier is booked for this shipment

Example:

<ShipmentFullData>
    <shipper>
        (body of the address structure)
    </shipper>
    <receiver>
        (body of the address structure)
    </receiver>
    <pieceList>
        <item>
            (body of the shipment definition structure)
        </item>
        <item>
            (body of the shipment definition structure)
        </item>
    </pieceList>
    <payment>
        (body of the payment defining method)
    </payment>
    <service>
        (body of the service defining method)
    </service>
    <shipmentDate>2012-05-15</shipmentDate>
    <content>Jewellery</content>
    <customs>
        (body of the customs clearance defining method)
    </customs>
</ShipmentFullData>

Go back to topic list