Metoda grupująca createShipmentReturn
Metoda pozwalającą na tworzenie przesyłki i etykiety zwrotnej zarówno z listem nadawczym jak i bez niego.
Parametry wejściowe
Nazwa pola | Typ | Wymagane? | Opis |
---|---|---|---|
authData | AuthData | Tak | Struktura autoryzacyjna |
serviceType | string | Tak | Rodzaj usługi, możliwe wartości: ZC Zwrot connect ZK Zwrot krajowy |
shipmentInfo - informacja o płatności | |||
wayBill | string | Nie | Numer listu przewozowego przesyłki |
bookCourier | string | Tak | możliwość nadania przesyłki zwrotnej kurierem |
billing - informacja o płatności | |||
shippingPaymentType | string | Tak | Określenie strony, która zostanie obciążona kosztami, możliwe opcje: RECEIVER - odbiorca |
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: BANK_TRANSFER - przelew (tylko dla klientów z umową i numerem SAP) |
costsCenter | string(20) | Nie | Miejsce powstawania kosztów |
specialServices - zamawianie usług dodatkowych | |||
serviceType | string | Nie | Rodzaj usługi dodatkowej, możliwe wartości: UBEZP - Ubezpieczenie przesyłki - tylko dla przesyłek krajowychdodatkowo płatne |
serviceValue | float | Nie | Deklarowana wartość, wymagana podczas zamawiania usług ubezpieczenie |
textInstruction | string(32) | Nie | Nazwa dokumentu zwrotnego w usłudze ROD |
collectOnDeliveryForm | string | Nie |
Forma zwrotu pobrania w usłudze COD, dostępne wartości: BANK_TRANSFER - przelew (tylko dla klientów z umową i numerem SAP) |
shipmentTime - informacja o czasie nadania przesyłki | |||
labelExpDate | string | Tak | data wygaśnięcia etykiety |
labelType | string | - | Wybór etykiety zwrotnej, możliwe wartości: BLP - etykieta BLP w formacie PDF LBLP - etykieta BLP w formacie PDF A4 ZBLP - etykieta BLP w formacie drukarek Zebra ZBLP300 - etykieta BLP 300dpi w formacie drukarek Zebra Jeżeli używacie Państwo drukarki laserowej – etykieta wygenerowana w pliku pdf – parametr BLP Jeżeli używacie Państwo drukarki termicznej zebra - etykieta wygenerowana w pliku zpl – parametr ZBLP lub ZBLP300 QR_PDF - kod QR w formacie PDF dla przesyłki ZK QR2_IMG - kod QR w formacie PNG o wymiarach 2cm x 2cm dla przesyłki ZK QR4_IMG - kod QR w formacie PNG o wymiarach 4cm x 4cm dla przesyłki ZK QR6_IMG - kod QR w formacie PNG o wymiarach 6cm x 6cm dla przesyłki ZK |
content | string(30) | Tak | Zawartość przesyłki |
comment | string(100) | Nie | Dodatkowy komentarz, do wydruku na liście przewozowym. |
reference | string(20) | Nie | Numer referencyjny przesyłki |
primaryWaybillNumber | string | Nie | Numer przesyłki pierwotnej |
shippingPaymentType | string | Tak | Określenie strony, która zostanie obciążona kosztami, możliwe opcje: RECEIVER - odbiorca |
billingAccountNumber | integer | Tak | Numer klienta, który będzie obciążony kosztami |
shipper oraz receiver - dane adresowe nadawcy oraz odbiorcy | |||
country | string(2) | Tak | Kraj odbiorcy |
isPackstation | bool | Nie | Doręczenie do DHL Parcelstation |
isPostfiliale | bool | Nie | Doręczenie do DHL Parcelshop |
postnummer | string(10) | Nie | Numer klienta - wymagane 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 Suma znaków w polach "apartmentNumber" i "houseNumber" nie może przekroczyć 15 znaków |
apartmentNumber | string(10) | Nie | Numer lokalu suma znaków w polach "apartmentNumber" i "houseNumber" nie może przekroczyć 15 znaków |
preaviso oraz contact - dane do preawizacji / kontaktubezpłatne | |||
personName | string(50) | Nie | Nazwa osoby kontaktowej |
phoneNumber | string(9) | Nie | Numer telefonu (9 cyfr) |
emailAddress | string(60) | Nie | Adres email |
pieceList - dane nt. paczek w przesyłce | |||
type | string | Tak | Typ paczki, możliwe wartości: ENVELOPE - przesyłka kopertowa PACKAGE - paczka |
weight | integer | Tak | Waga paczki(w kilogramach), nie wymagane dla type = ENVELOPE |
width | integer | Tak | Szerokość paczki (w centymetrach), nie wymagane dla type = ENVELOPE |
height | integer | Tak | Wysokość paczki (w centymetrach), nie wymagane dla type = ENVELOPE |
length | integer | Tak | Długość paczki (w centymetrach), nie wymagane dla type = ENVELOPE |
quantity | integer | Tak | Ilość paczek tego typu |
nonStandard | bool | Nie | Oznaczenie, że paczka jest niestandardowa (true / false) |
blpPieceId | string(32) | Nie | Identyfikator paczki (JJD) na etykietę BLP (dla klientów, którzy prowadzą własną numerację) |
Parametry wyjściowe
Nazwa pola | Typ | Wymagane? | Opis |
---|---|---|---|
shipmentNotificationNumber | string | - | Identyfikator przesyłki |
dispatchNotificationNumber | string | - | Identyfikator zamówienia (jeśli zamówiony kurier) |
labelType | string | - | Typ etykiety zwrotnej |
labelFormat | string | - | Format MIME etykiety |
labelContent | string | - | Zawartość etykiety (zakodowana w base64) |
Przykłady wywołania
<authData> <username>testomir</username> <password>testalski</password> </authData> <shipment> <shipmentInfo> <wayBill>12345678910</wayBill> <serviceType>ZC</serviceType> <bookCourier>true</bookCourier> <billing> <shippingPaymentType>RECEIVER</shippingPaymentType> <!-- określenie strony, która zostanie obciążona kosztami, możliwe opcje serviceType: RECEIVER - płaci odbiorca --> <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>UBEZP</serviceType> <serviceValue>20000</serviceValue> </item> </specialServices> <shipmentTime> <labelExpDate>2017-07-31</labelExpDate> </shipmentTime> <labelType>BLP</labelType> <!-- wybór etykiety zwrotnej, możliwe wartości labelType: BLP - etykieta BLP w formacie PDF LBLP - etykieta BLP w formacie PDF A4 ZBLP - etykieta BLP w formacie drukarek Zebra --> </shipmentInfo> <content>Gra komputerowa</content> <comment>ostrożnie</comment> <reference>REF TESTREF TESTSTOP</reference> <primaryWaybillNumber>nr zlecenia</primaryWaybillNumber> <ship> <shipper> <preaviso> <personName>3e Spółka Jawna</personName> <phoneNumber>123456789</phoneNumber> <emailAddress>testomir@gmail.pl</emailAddress> </preaviso> <contact> <personName>3e Spółka Jawna</personName> <phoneNumber>123456789</phoneNumber> <emailAddress>testomir@gmail.pl</emailAddress> </contact> <address> <country>CZ</country> <name>Janek</name> <postalCode>50011</postalCode> <city>Test</city> <street>Test</street> <houseNumber>9</houseNumber> <apartmentNumber>59</apartmentNumber> </address> </shipper> <receiver> <preaviso> <personName>3e Spółka Jawna</personName> <phoneNumber>123456789</phoneNumber> <emailAddress>testomir@gmail.pl</emailAddress> </preaviso> <contact> <personName>3e Spółka Jawna</personName> <phoneNumber>123456789</phoneNumber> <emailAddress>testomir@gmail.pl</emailAddress> </contact> <address> <country>PL</country> <name>Ja</name> <postalCode>00001</postalCode> <city>Wawa</city> <street>Leśna</street> <houseNumber>9</houseNumber> <apartmentNumber>59</apartmentNumber> <postnummer>123456789</postnummer> <isPackstation>false</isPackstation> <isPostfiliale>false</isPostfiliale> </address> </receiver> </ship> <pieceList> <item> <type>PACKAGE</type> <!-- typ paczki, możliwe wartości: ENVELOPE - przesyłka kopertowa PACKAGE - paczka --> <weight>20</weight> <width>60</width> <height>40</height> <length>40</length> <quantity>1</quantity> </item> </pieceList> </shipment>