ItemsToLabelData Structure

This structure describes data returned after using the getLabelsData method.

Structure Fields

Field Name Type Required? Description
shipmentId integer Yes Shipment number of the shipment for which information is to be downloaded
primaryWaybillNumber string Yes Original shipment number
dispatchNotificationNumber string - Order ID (if courier is booked)
labelHeader string - Label header
content string(30) Yes Content of the parcel
comment string(100) No Additional comments (visible on the consignment note)
reference string(200) No Shipment reference number
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:
CASH - cash payment
BANK_TRANSFER - bank transfer (only for customers with an agreement and SAP number)
costsCenter string(20) No Cost centre
shipmentTime - information on the parcel shipment time
labelExpDate string Yes Label expiry date
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
routing - data for shipment routing
senderDepot string Yes Sender depot
receiverDepot string Yes Destination depot (receiver depot)
senderAps string Yes Which intermediary depots (sorting centers) the shipment will go through on working days
receiverAps string Yes Which intermediary depots (sorting centers) the shipment will go through on Saturdays
tourId string Yes Delivery courier route symbol
shipper - sender address details
contactPerson string(60) No Name and surname of the contact person
contactPhone string(20) No Contact phone number
contactEmail string(60) No Contact e-mail
preavisoPerson string(60) No Name and surname for pre-delivery notification
preavisoPhone string(20) No Phone number for pre-delivery notification
preavisoEmail string(60) No E-mail address for pre-delivery notification
country string(2) Yes Sender’s country
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
apartmentNumber string(10) No Apartment number
receiver - address details of the recipient
contactPerson string(60) No Name and surname of the contact person
contactPhone string(20) No Contact phone number
contactEmail string(60) No Contact e-mail
preavisoPerson string(60) No Name and surname for pre-delivery notification
preavisoPhone string(20) No Phone number for pre-delivery notification
preavisoEmail string(60) No E-mail address for pre-delivery notification
country string(2) Yes Recipient’s country
isPackstation bool No Delivery to DHL Parcelstation
isPostfiliale bool No Delivery to DHL ServicePoint
postnummer string(10) No Customer number - only for DE with deliveries to parcel locker
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 DHL Parcelstation or DHL ServicePoint - parcelstation or service point number.
apartmentNumber string(10) No Apartment number
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
apartmentNumber string(10) No Apartment number
contactPhone string(9) No Contact phone number
contactEmail string(60) No Contact e-mail
servicepoint - serivce point details
servicePointAccountNumber integer Yes Service point number
name string(60) Yes Name
country string(2) Yes Country
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
apartmentNumber string(10) No Apartment number
service - shipping and additional services
product string Yes Dictionary value:
AH - domestic shipment
09 - Domestic 09
12 - Domestic 12
EK - Connect shipment
PI - International shipment
ZK - domestic return
ZC - international return
deliveryEvening bool No Selection of the Evening Delivery service
deliveryOnSaturday bool No Selection of the Saturday Delivery service
pickupOnSaturday bool No Selection of the Saturday Shipment service
collectOnDelivery bool No Selection of the cash on delivery service
collectOnDeliveryValue float Yes, if COD selected Collection amount in PLN, accurate to within PLN 0.01, maximum amount PLN 11000
collectOnDeliveryForm string Yes, if COD selected Form of the collection amount refund. Permitted values: BANK_TRANSFER - bank transfer
collectOnDeliveryReference string No “COD reference” field on the consignment note
insurance bool No Selection of the insurance service
insuranceValue float Yes, if Insurance selected Value of the insured shipment
returnOnDelivery bool No Return of documents service
returnOnDeliveryReference string No Name of the return document
proofOfDelivery bool No Selection of the proof of delivery service
For a PI product- Selection of the disposal service
selfCollect bool No Selection of the self-pickup service
deliveryToNeighbour bool No Delivery to neighbour
predeliveryInformation bool No Selection of the pre-delivery information service
pieceList - shipment parcel data
routingBarcode string Yes Routing code
type string Yes Parcel type, possible values:
ENVELOPE - envelope shipment PACKAGE - parcel
PALLET - pallet
weight integer Yes Weight of the parcel (in kilograms), not applicable to type = ENVELOPE
width integer Yes Width of the parcel (in centimetres), not applicable to type = ENVELOPE
height integer Yes Height of the parcel (in centimetres), not applicable to type = ENVELOPE
length integer Yes Length of the parcel (in centimetres), not applicable to 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)

Example:

<getLabelsDataResponse>
    <item>
        <shipmentId>15337764915</shipmentId>
        <primaryWaybillNumber xsi:nil="true"/>
        <dispatchNotificationNumber xsi:nil="true"/>
        <labelHeader>DHL PARCEL CONNECT</labelHeader>
        <content>1231231313</content>
        <comment xsi:nil="true"/>
        <reference xsi:nil="true"/>
        <billing>
            <shippingPaymentType>SHIPPER</shippingPaymentType>
            <billingAccountNumber>1297870</billingAccountNumber>
            <paymentType>BANK_TRANSFER</paymentType>
            <costsCenter xsi:nil="true"/>
        </billing>
        <shipmentTime>
            <labelExpDate xsi:nil="true"/>
            <shipmentDate>2018-07-30</shipmentDate>
            <shipmentStartHour xsi:nil="true"/>
            <shipmentEndHour xsi:nil="true"/>
        </shipmentTime>
        <routing>
            <senderDepot>WA</senderDepot>
            <receiverDepot>OL</receiverDepot>
            <senderAps>WA</senderAps>
            <receiverAps>WA</receiverAps>
            <tourId>211CA</tourId>
        </routing>
        <shipper>
            <contactPerson>PAT TESTLEY</contactPerson>
            <contactPhone>123123213</contactPhone>
            <contactEmail>email@email.pl</contactEmail>
            <preavisoPhone xsi:nil="true"/>
            <preavisoEmail xsi:nil="true"/>
            <preavisoPerson xsi:nil="true"/>
            <country>PL</country>
            <name>Test name</name>
            <postalCode>02-427</postalCode>
            <city>WARSAW</city>
            <street>Street</street>
            <houseNumber>6</houseNumber>
            <apartmentNumber xsi:nil="true"/>
        </shipper>
        <receiver>
            <contactPerson>MARK TESTLEY</contactPerson>
            <contactPhone>0011100010</contactPhone>
            <contactEmail>email2@email2.pl</contactEmail>
            <preavisoPhone xsi:nil="true"/>
            <preavisoEmail xsi:nil="true"/>
            <preavisoPerson xsi:nil="true"/>
            <country>DE</country>
            <isPackstation>false</isPackstation>
            <isPostfiliale>false</isPostfiliale>
            <postnummer xsi:nil="true"/>
            <name>Markus Germain</name>
            <postalCode>10115</postalCode>
            <city>Berlin</city>
            <street>Ackerstraße</street>
            <houseNumber>24/12</houseNumber>
            <apartmentNumber xsi:nil="true"/>
        </receiver>
        <neighbour>
            <name xsi:nil="true"/>
            <postalCode xsi:nil="true"/>
            <city xsi:nil="true"/>
            <street xsi:nil="true"/>
            <houseNumber xsi:nil="true"/>
            <apartmentNumber xsi:nil="true"/>
            <contactPhone xsi:nil="true"/>
            <contactEmail xsi:nil="true"/>
        </neighbour>
        <servicepoint>
            <servicePointAccountNumber xsi:nil="true"/>
            <name xsi:nil="true"/>
            <country/>
            <postcode xsi:nil="true"/>
            <city xsi:nil="true"/>
            <street xsi:nil="true"/>
            <houseNumber xsi:nil="true"/>
            <apartmentNumber xsi:nil="true"/>
        </servicepoint>
        <service>
            <product>EK</product>
            <deliveryEvening>false</deliveryEvening>
            <deliveryOnSaturday>false</deliveryOnSaturday>
            <pickupOnSaturday>false</pickupOnSaturday>
            <collectOnDelivery>false</collectOnDelivery>
            <collectOnDeliveryValue>0</collectOnDeliveryValue>
            <collectOnDeliveryForm xsi:nil="true"/>
            <collectOnDeliveryReference/>
            <insurance>false</insurance>
            <insuranceValue>0</insuranceValue>
            <returnOnDelivery>false</returnOnDelivery>
            <returnOnDeliveryReference/>
            <proofOfDelivery>false</proofOfDelivery>
            <selfCollect>false</selfCollect>
            <predeliveryInformation>false</predeliveryInformation>
            <deliveryToNeighbour>false</deliveryToNeighbour>
        </service>
        <pieceList>
            <item>
                <routingBarcode>2LDE20115+60000000</routingBarcode>
                <type>PACKAGE</type>
                <width>20</width>
                <height>20</height>
                <length>20</length>
                <weight>20</weight>
                <quantity>1</quantity>
                <nonStandard>false</nonStandard>
                <blpPieceId>JJD000030100028000000000507</blpPieceId>
                <euroReturn>false</euroReturn>
            </item>
        </pieceList>
    </item>
</getLabelsDataResponse>
Go back to topic list