CreateShipmentStructure

This structure is an object used for the creation of new shipments in the system. It is used in the createShipment method as its parameter.

Structure Fields

Field Name Type Required? Description
authData AuthdataStructure Yes Structure containing authorisation data
shipmentData ShipmentStructure Yes Structure containing shipment data

Example:

<shipment>
    <authData>
        <username>test</username>
        <password>WSyj3$aDE</password>
    </authData>
    <shipmentData>
        <ship>
            <shipper>
                <address>
                    <name>Testan Testington</name>
                    <postcode>00999</postcode>
                    <city>Testville</city>
                    <street>Test Street</street>
                    <houseNumber>78</houseNumber>
                    <apartmentNumber>3</apartmentNumber>
                </address>
                <contact>
                    <personName>Testan</personName>
                    <phoneNumber>600700800</phoneNumber>
                    <emailAddress>testan@testington.pl</emailAddress>
                </contact>
                <preaviso>
                    <personName>Zbigniew Nowak</personName>
                    <phoneNumber>669324789</phoneNumber>
                    <emailAddress>zibi.nowy@op.pl</emailAddress>
                </preaviso>
            </shipper>
            <receiver>
                <address>
                    <addressType></addressType>
                    <name>Testan Testington</name>
                    <postcode>00999</postcode>
                    <city>Testville</city>
                    <street>Test Street</street>
                    <houseNumber>78</houseNumber>
                    <apartmentNumber>3</apartmentNumber>                    
                </address>
                <contact>
                    <personName>Testan</personName>
                    <phoneNumber>600700800</phoneNumber>
                    <emailAddress>testan@testington.pl</emailAddress>
                </contact>
                <preaviso>
                    <personName>Zbigniew Nowak</personName>
                    <phoneNumber>669324789</phoneNumber>
                    <emailAddress>zibi.nowy@op.pl</emailAddress>
                </preaviso>
            </receiver>
            <servicePointAccountNumber>1254823</servicePointAccountNumber>
        </ship>
       <shipmentInfo>
            <dropOffType>REGULAR_PICKUP</dropOffType>
            <serviceType>LM</serviceType>
            <billing>
                <shippingPaymentType>SHIPPER</shippingPaymentType>
                <billingAccountNumber>1736256</billingAccountNumber>
                <paymentType>BANK_TRANSFER</paymentType>
                <costsCenter>Lodz Headquarters</costsCenter>
            </billing>
            <specialServices>
                <item>
                    <serviceType>INSUR</serviceType>
                    <serviceValue>20</serviceValue>
                </item>
            </specialServices>
            <shipmentDate>2014-10-25</shipmentDate>
            <labelType>BLP</labelType>
           <waybill>12345678910</waybill>
       </shipmentInfo>
        <pieceList>
            <item>
                <type>PACKAGE</type>
                <width>120</width>
                <height>20</height>
                <lenght>20</lenght>
                <weight>15</weight>
                <quantity>1</quantity>
                <nonStandard>false</nonStandard>
                <blpPieceId>12312</blpPieceId>
            </item>
            <item>
                <type>ENVELOPE</type>
                <quantity>10</quantity>
            </item>
        </pieceList>
        <content>JEWELLERY</content>
        <comment>Please call persistently, I often cannot hear my phone.</comment>
        <reference></reference>
    </shipmentData>
</shipment>
Return to subject list