Struktura itemsToLabelData

Struktura opisuje dane zwracane po skorzystaniu z metody getLabelsData.

Pola struktury

Nazwa pola Typ Wymagane? Opis
shipmentId integer Tak Numer przesyłki, dla której chcemy pobrać informacje
primaryWaybillNumber string Tak Numer przesyłki pierwotnej
dispatchNotificationNumber string - Identyfikator zamówienia (jeśli zamówiony kurier)
labelHeader string - Nagłówek etykiety
content string(30) Tak Zawartość przesyłki
comment string(100) Nie Dodatkowy komentarz (widoczny na liście przewozowym)
reference string(200) Nie Numer referencyjny przesyłki
billing - informacja o płatności
shippingPaymentType string Tak Określenie strony, która zostanie obciążona kosztami, możliwe opcje:
SHIPPER - nadawca,
RECEIVER - odbiorca,
USER - strona trzecia
billingAccountNumber integer Tak Numer klienta, który będzie obciążony kosztami
paymentType string Tak Wybór sposobu płatności, możliwe wartości:
CASH - płatność gotówką
BANK_TRANSFER - przelew (tylko dla klientów z umową i numerem SAP)
costsCenter string(20) Nie Miejsce powstawania kosztów
shipmentTime - informacja o czasie nadania przesyłki
labelExpDate string Tak Data ważności etykiety
shipmentDate string Tak Data nadania w formacie RRRR-MM-DD
shipmentStartHour string(32) Tak Początek zakresu godzinowego, w którym kurier ma odebrać przesyłkę; w formacie GG:MM
shipmentEndHour string(32) Tak Koniec zakresu godzinowego, w którym kurier ma odebrać przesyłkę; w formacie GG:MM
routing - dane o routingu przesyłki
senderDepot string Tak Terminal który nadaje przesyłkę
receiverDepot string Tak Terminal docelowy (odbiorcy)
senderAps string Tak Przez jakie terminale (sortownie) pośredniczące będzie jechać przesyłka w dni robocze
receiverAps string Tak Przez jakie terminale (sortownie) pośredniczące będzie jechać przesyłka w soboty
tourId string Tak Symbol trasy kuriera doręczającego
shipper - dane adresowe nadawcy
contactPerson string(60) Nie Imię i nazwisko osoby kontaktowej
contactPhone string(20) Nie Kontaktowy numer telefonu
contactEmail string(60) Nie Kontaktowy adres email
preavisoPerson string(60) Nie Imię i nazwisko do preawizacji
preavisoPhone string(20) Nie Numer telefonu do preawizacji
preavisoEmail string(60) Nie Adres email do preawizacji
country string(2) Tak Kraj nadawcy
name string(60) Tak Nazwa (imię i nazwisko bądź nazwa firmy)
postalCode string Tak Kod pocztowy
city string(17) Tak Miejscowość
street string(35) Tak Ulica
houseNumber string(10) Tak Numer domu
apartmentNumber string(10) Nie Numer lokalu
receiver - dane adresowe odbiorcy
contactPerson string(60) Nie Imię i nazwisko osoby kontaktowej
contactPhone string(20) Nie Kontaktowy numer telefonu
contactEmail string(60) Nie Kontaktowy adres email
preavisoPerson string(60) Nie Imię i nazwisko do preawizacji
preavisoPhone string(20) Nie Numer telefonu do preawizacji
preavisoEmail string(60) Nie Adres email do preawizacji
country string(2) Tak Kraj odbiorcy
isPackstation bool Nie Doręczenie do DHL Parcelstation
isPostfiliale bool Nie Doręczenie do DHL ServicePoint
postnummer string(10) Nie Numer klienta - tylko dla DE przy doręczeniu do paczkomatu
name string(60) Tak Nazwa (imię i nazwisko bądź nazwa firmy)
postalCode string Tak Kod pocztowy
city string(17) Tak Miejscowość
street string(35) Tak Ulica
houseNumber string(10) Tak Numer domu
W przypadku doręczenia do DHL Parcelstation lub DHL ServicePoint dla przesyłek zagranicznych Connect - numer parcelstation lub service point
apartmentNumber string(10) Nie Numer lokalu
neighbour - dane sąsiada (tylko, gdy wybrana usługa SAS)
name string(60) Tak Nazwa (imię i nazwisko bądź nazwa firmy)
postalCode string Tak Kod pocztowy (w formacie xxxxx: bez myślnika)
city string(17) Tak Miejscowość
street string(35) Tak Ulica
houseNumber string(10) Tak Numer domu
apartmentNumber string(10) Nie Numer lokalu
contactPhone string(9) Nie Kontaktowy numer telefonu
contactEmail string(60) Nie Kontaktowy adres email
servicepoint - dane punktu obsługi
servicePointAccountNumber integer Tak Numer punktu obsługi
name string(60) Tak Nazwa
country string(2) Tak Kraj
postalCode string Tak Kod pocztowy (w formacie xxxxx: bez myślnika)
city string(17) Tak Miejscowość
street string(35) Tak Ulica
houseNumber string(10) Tak Numer domu
apartmentNumber string(10) Nie Numer lokalu
service - usługa przewozowa i usługi dodatkowe
product string Tak Wartość słownikowa:
AH - przesyłka krajowa
09 - Domestic 09
12 - Domestic 12
EK - przesyłka Connect
PI - przesyłka International
ZK - zwrot krajowy
ZC - zwrot międzynarodowy
deliveryEvening bool Nie Wybór usługi Doręczenie wieczorne
deliveryOnSaturday bool Nie Wybór usługi Doręczenie w sobotę
pickupOnSaturday bool Nie Wybór usługi Nadanie w sobotę
collectOnDelivery bool Nie Wybór usługi opłata za pobraniem
collectOnDeliveryValue float Tak, jeśli wybrano COD Kwota pobrania w PLN, z dokładnością do groszy, maksymalnie 11000 zł.
collectOnDeliveryForm string Tak, jeśli wybrano COD Forma zwrotu pobrania. Dopuszczalne wartości: BANK_TRANSFER - przelew.
collectOnDeliveryReference string Nie Pole "referencja pobrania" na liście przewozowym.
insurance bool Nie Wybór usługi ubezpieczenie
insuranceValue float Tak, jeśli wybrano Insurance Wartość przesyłki do ubezpieczenia
returnOnDelivery bool Nie Usługa zwrotu potwierdzonego dokumentu
returnOnDeliveryReference string Nie Nazwa dokumentu zwrotnego
proofOfDelivery bool Nie Wybór usługi potwierdzenie doręczenia
Dla produktu PI - Wybór usługi utylizacji
selfCollect bool Nie Wybór usługi odbiór własny
deliveryToNeighbour bool Nie Doręczenie do sąsiada
predeliveryInformation bool Nie Wybór usługi informacja przed doręczeniem
pieceList - dane nt. paczek w przesyłce
routingBarcode string Tak Kod routingowy
type string Tak Typ paczki, możliwe wartości:
ENVELOPE - przesyłka kopertowa
PACKAGE - paczka
PALLET - paleta
weight integer Tak Waga paczki (w kilogramach), brak dla type = ENVELOPE
width integer Tak Szerokość paczki (w centymetrach), brak dla type = ENVELOPE
height integer Tak Wysokość paczki (w centymetrach), brak dla type = ENVELOPE
length integer Tak Długość paczki (w centymetrach), brak dla type = ENVELOPE
quantity integer Tak Ilość paczek tego typu
nonStandard bool Nie Oznaczenie, że paczka jest niestandardowa (true / false)
euroReturn bool Nie Oznaczenie, że palety w przesyłce są do zwrotu (true / false)
blpPieceId string(32) Nie Identyfikator paczki (JJD) na etykietę BLP (dla klientów, którzy prowadzą własną numerację)

Przykład

<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>PATRYK TESTOWY</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>Nazwa testowa.</name>
            <postalCode>02-427</postalCode>
            <city>WARSZAWA</city>
            <street>Ulica</street>
            <houseNumber>6</houseNumber>
            <apartmentNumber xsi:nil="true"/>
        </shipper>
        <receiver>
            <contactPerson>Marek Testowy</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>Mariusz Niemiecki</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>
Wróć do listy tematów