CreateShipment Grouping Method

Using this method, you can create a shipment and book a courier in one request.

Input Parameters

Field Name Type Required? Description
authData AuthData Yes Authorisation structure
dropOffType string Yes Request type, dictionary value; possible values:
REGULAR_PICKUP - creating a shipment without limitations
REQUEST_COURIER - creating a shipment and booking a courier
COURIER_ONLY - booking a courier
serviceType string Yes Type of shipping service, dictionary value; possible values:
AH - domestic shipment
09 - Domestic service 09
12 - Domestic service 12
DW - evening delivery shipment
SP - shipment delivered to point
EK - Connect shipment
PI - International shipment
PR - Premium product
CP - Connect Plus shipment
CM - Connect Plus Pallet shipment
labelType string Yes Return label selection, possible values:
LP - consignment note
BLP - BLP label in PDF format
LBLP - LBLP label in PDF A4 format
ZBLP - BLP label in the format used by Zebra printers
ZBLP300 - BLP 300 dpi label in the format used by Zebra printers
If you use a laser printer – label generated in PDF file – BLP parameter
If you use a Zebra thermal printer - label generated in zpl file – ZBLP or ZBLP300 parameter
content string(30) Yes Content of the parcel
comment string(100) No Additional comments to be printed on the consignment note.
The first 50 characters of the message will be communicated to the courier as a customer comment.
reference string(200) No Shipment reference number
wayBill string(11) No Shipment waybill number
servicePointAccountNumber string No Required only if receiver's details are left empty and selected product is SP (if eligible)
billing - billing information
shippingPaymentType string Yes Identification of the party to be charged, possible options:
SHIPPER - shipper,
RECEIVER - receiver,
USER - third party
billingAccountNumber integer Yes Customer number to be charged
paymentType string Yes Payment method selection, possible values:
BANK_TRANSFER - bank transfer (only for customers with an agreement and SAP number)
costsCenter string(20) No Cost centre
specialServices - ordering special services
serviceType string No Special service type, possible values:
1722 - Deliveries between 5 pm and 10 pm additional fees apply
SOBOTA - Saturday Delivery additional fees apply
NAD_SOBOTA - Saturday pickup additional fees apply
UBEZP - Shipment Insurance additional fees apply
COD - Cash on delivery additional fees apply
PDI - Pre-delivery information additional fees apply
ROD - Return of documents dodatkowo płatne / For a PI product- Selection of the disposal servicefree of charge
SAS - Delivery to Neighbour free of charge
ODB - Self-pickup free of charge
serviceValue float No Declared value required when ordering the insurance service or the COD service
textInstruction string(32) No Name of the return document in the ROD service
collectOnDeliveryForm string No Form of the collection amount refund in the COD service, possible values:
BANK_TRANSFER - bank transfer (only for customers with an agreement and SAP number)
shipmentTime - information on the parcel shipment time
shipmentDate string Yes Shipment time in YYYY-MM-DD format
shipmentStartHour string(32) Yes Beginning of the time range when a courier can collect the shipment; in HH:MM format
shipmentEndHour string(32) Yes End of the time range when a courier can collect the shipment; in HH:MM format
shipper and receiver - address details of the sender and recipient
addressType string(1) Yes Address type (B/C) (only recipient)
country string(2) Yes Recipient’s country
isPackstation bool No Delivery to DHL Parcelstation
isPostfiliale bool No Delivery to DHL Parcelshop
postnummer string(10) No Customer number - required only for DE with deliveries to parcel lockers
name string(60) Yes Name (first name and surname or company name)
postalCode string Yes Postal code
city string(17) Yes Town/city
street string(35) Yes Street
houseNumber string(10) Yes House number
In the case of deliveries of international Connect shipments to a DHL Parcelstation or DHL Parcelshop - parcelstation or parcelshop number The sum of characters in the "apartmentNumber" and "houseNumber" fields shall not exceed 15 characters.
apartmentNumber string(10) No Apartment number The sum of characters in the "apartmentNumber" and "houseNumber" fields shall not exceed 15 characters.
pre-delivery notification and contact - details for pre-delivery notification / contact
personName string(50) No Name of contact person
phoneNumber string(9) No Phone number (9 digits)
emailAddress string(60) No E-mail address
neighbour - neighbour details (only if NEI service is selected)
name string(60) Yes Name (first name and surname or company name)
postalCode string Yes Postal code (in xxxxx format without dash)
city string(17) Yes Town/city
street string(35) Yes Street
houseNumber string(10) Yes House number The sum of characters in the "apartmentNumber" and "houseNumber" fields shall not exceed 15 characters.
apartmentNumber string(10) No Apartment number The sum of characters in the "apartmentNumber" and "houseNumber" fields shall not exceed 15 characters.
contactPhone string(9) No Contact phone number
contactEmail string(60) No Contact e-mail
pieceList - shipment parcel data
type string Yes Parcel type, possible values:
ENVELOPE - envelope shipment PACKAGE - parcel
PALLET - pallet
weight integer Yes Weight of the parcel (in kilograms), not required for type = ENVELOPE
width integer Yes Width of the parcel (in centimetres), not required for type = ENVELOPE
height integer Yes Height of the parcel (in centimetres), not required for type = ENVELOPE
length integer Yes Length of the parcel (in centimetres), not required for type = ENVELOPE
quantity integer Yes Quantity of parcels of this type
nonStandard bool No Indication that the parcel is non-standard (true / false)
euroReturn bool No Indication that the pallets in the shipment are to be returned (true / false)
blpPieceId string(32) No Parcel ID (JJD) for BLP label (for customers with their own numbering)
customs - data relating to customs clearance (for shipments delivered outside of the EU)
customsType string(1) Yes Type of customs clearance (U - simplified, I - individual)
costsOfShipment integer Yes Gross value of transport paid by the recipient to the buyer
currency string(3) Yes Currency (GBP, PLN, EUR, CHF, USD)
nipNr string(12) Yes (for individual customs clearance) NIP number
eoriNr string(17) Yes (for individual customs clearance) EORI number
vatRegistrationNumber string(15) Yes VAT registration number
eoriNrReceiver string(17) Yes (for individual customs clearance) Numer EORI - receiver
vatRegistrationNumberReceiver string(15) Yes VAT registration number - receiver
categoryOfItem string(2) Yes Category of items (according to dictionary: 9 - “Other", 11 - “Sale of goods", 21 - “Return of goods", 31 - “Gifts", 32 - “Samples of goods", 91 - “Documents")
invoiceNr string(35) Yes (for individual customs clearance) Invoice number
invoiceDate string(10) Yes (for individual customs clearance) Invoice data (format YYYY-MM-DD)
countryOfOrigin string(2) No Country of origin of the goods. Permitted values according to ISO 3366-1 alfa-2.
additionalInfo string(100) No Additional information
grossWeight float Yes Weight of the goods
firstName string(30) Yes Name of the contact person
secondaryName string(30) Yes Surname of the contact person
invoice base64 Yes (for individual customs clearance) VAT invoice
customAgreements - data relating to customs clearance consents and declarations (for shipments delivered outside of the EU)
notExceedValue string(1) Yes (for simplified customs clearance) Permitted values: Y, N
notProhibitedGoods string(1) Yes Permitted values: Y, N
notRestrictedGoods string(1) Yes Permitted values: Y, N
customsItem - data relating to goods in customs clearance (for shipments delivered outside of the EU)
nameEn string(35) Yes English name of the item
namePl string(35) Yes (for individual customs clearance) Polish name of the item
quantity integer Yes Number of components
weight float Yes Weight of the item
value float Yes Value of the goods
tariffCode string(10) Yes (for individual customs clearance) Customs tariff code
countryOfOrigin string(35) No ISO Country Code, for individual customs clearance only

Output Parameters

Field Name Type Required? Description
shipmentNotificationNumber string - Parcel ID
dispatchNotificationNumber string - Order ID (if courier is booked)
labelType string - Return label type
labelFormat string - MIME label format
labelContent string - Label content (encoded in base64)
cn23MimeType string - Customs document type CN23 - returned in the case of simplified customs clearance
cn23Content string - Contents of customs document CN23 (base24) - returned in the case of simplified customs clearance
fvProformaMimeType string - Proforma invoice document type - returned in the case of simplified customs clearance
fvProformaContent string - Contents of proforma invoice (base64) - returned in the case of simplified customs clearance
fvProformaNumer string - Generated invoice number - if no invoice number is provided in the input parameters

Examples of calls

<authData>
    <username>testan</username>
    <password>testington</password>
</authData>
<shipment>
    <shipmentInfo>
        <dropOffType>REQUEST_COURIER</dropOffType>
        <!-- możliwe wartości dropOffType:
            REGULAR_PICKUP - utworzenie przesyłki bez sprawdzania restrykcji na kod pocztowy (zbiór stały)
            REQUEST_COURIER - utworzenie przesyłki i zamówienie kuriera
            COURIER_ONLY - zamówienie kuriera -->
        <serviceType>AH</serviceType>
        <!-- typ usługi przewozowej, możliwe opcje serviceType:
            AH - przesyłka krajowa
            09 - usługa domestic 09
            12 - usługa domestic 12
            SP - usługa doręczenie do punktu DHL -->
        <billing>
            <shippingPaymentType>SHIPPER</shippingPaymentType>
            <!-- określenie strony, która zostanie obciążona kosztami, możliwe opcje serviceType:
                SHIPPER - płaci nadawca
                USER - płatność trzecia strona -->
            <billingAccountNumber>1204663</billingAccountNumber>
            <paymentType>BANK_TRANSFER</paymentType>
            <!-- wybór sposobu płatności, możliwe wartości paymentType:
                 BANK_TRANSFER - przelew (tylko dla klientów z umową i numerem SAP) -->
            <costsCenter>ABC1235</costsCenter>
        </billing>
        <specialServices>
            <item>
                <serviceType>SEL</serviceType>
                <!-- rodzaj usługi dodatkowej, możliwe wartości serviceType:
                    - 1722 - Doręczenie w godzinach 18-22
                    - SOBOTA - Nadanie / doręczenie w sobotę
                    - UBEZP - Ubezpieczenie przesyłki
                    - COD - Zwrot pobrania
                    - PDI - Informacje przed doręczeniem
                    - ROD - Zwrot potwierdzonych dokumentów
                    - POD - Potwierdzenie doręczenia
                    - ODB - Odbiór własny
                    -->
            </item>
            <item>
                <serviceType>INSUR</serviceType>
                <serviceValue>20000</serviceValue>
            </item>
        </specialServices>
        <shipmentTime>
            <shipmentDate>2012-10-23</shipmentDate>
            <shipmentStartHour>12:00</shipmentStartHour>
            <shipmentEndHour>15:00</shipmentEndHour>
        </shipmentTime>
        <labelType>CN</labelType>
        <!-- wybór etykiety zwrotnej, możliwe wartości labelType:
            LP - list przewozowy
            BLP - etykieta BLP w formacie PDF
            ZBLP - etykieta BLP w formacie drukarek Zebra -->
    </shipmentInfo>
    <content>Computer game</content>
    <comment>handle with care</comment>
    <ship>
        <shipper>
            <preaviso>
                <personName>3e General Partnership</personName>
                <phoneNumber>123456789</phoneNumber>
                <emailAddress>testomir@gmail.pl</emailAddress>
            </preaviso>
            <contact>
                <personName>3e General Partnership</personName>
                <phoneNumber>123456789</phoneNumber>
                <emailAddress>testomir@gmail.pl</emailAddress>
            </contact>
            <address>
                <name>Janek</name>
                <postalCode>00909</postalCode>
                <city>Wawa</city>
                <street>Lesna</street>
                <houseNumber>9</houseNumber>
                <apartmentNumber>59</apartmentNumber>
            </address>
        </shipper>
        <receiver>
            <preaviso>
                <personName>3e General Partnership</personName>
                <phoneNumber>123456789</phoneNumber>
                <emailAddress>testomir@gmail.pl</emailAddress>
            </preaviso>
            <contact>
                <personName>3e General Partnership</personName>
                <phoneNumber>123456789</phoneNumber>
                <emailAddress>testomir@gmail.pl</emailAddress>
            </contact>
            <address>
                <addressType>B</addressType>
                <country>PL</country>
                <name>Me</name>
                <postalCode>00001</postalCode>
                <city>Wawa</city>
                <street>Lesna</street>
                <houseNumber>9</houseNumber>
                <apartmentNumber>59</apartmentNumber>
            </address>
        </receiver>
    </ship>
    <pieceList>
        <item>
            <type>ENVELOPE</type>
            <!-- typ paczki, możliwe wartości:
                ENVELOPE - przesyłka kopertowa
                PACKAGE - paczka
                PALLET - paleta -->
            <quantity>1</quantity>
        </item>
        <item>
            <type>PACKAGE</type>
            <weight>20</weight>
            <width>60</width>
            <height>40</height>
            <length>40</length>
            <quantity>1</quantity>
        </item>
    </pieceList>
    <customs>
        <customsType>U</customsType>
        <costsOfShipment>10</costsOfShipment>
        <currency>PLN</currency>
        <nipNr>5218487281</nipNr>
        <categoryOfItem>9</categoryOfItem>
        <countryOfOrigin>PL</countryOfOrigin>
        <customAgreements>
            <notExceedValue>T</notExceedValue>
            <notProhibitedGoods>T</notProhibitedGoods>
            <notRestrictedGoods>T</notRestrictedGoods>
        </customAgreements>
        <customsItem>
            <item>
                <nameEn>test</nameEn>
                <namePl>test</namePl>
                <quantity>2</quantity>
                <weight>2.0</weight>
                <value>100</value>
                <tariffCode>001</tariffCode>
            </item>
        </customsItem>
        <firstName>Testan</firstName>
        <secondaryName>Testington</secondaryName>
    </customs>
</shipment>
Go back to topic list