Metoda grupująca createShipment
Przy pomocy tej metody możliwe jest - w jednym żądaniu - utworzenie przesyłki i zamówienie kuriera.
Parametry wejściowe
Nazwa pola | Typ | Wymagane? | Opis |
---|---|---|---|
authData | AuthData | Tak | Struktura autoryzacyjna |
dropOffType | string | Tak | Rodzaj żądania, wartość słownikowa; możliwe wartości: REGULAR_PICKUP - utworzenie przesyłki bez restrykcji REQUEST_COURIER - utworzenie przesyłki i zamówienie kuriera COURIER_ONLY - zamówienie kuriera |
serviceType | string | Tak | Typ usługi przewozowej, wartość słownika; możliwe wartości: AH - przesyłka krajowa 09 - usługa Domestic 09 12 - usługa Domestic 12 DW - przesyłka z doręczeniem wieczornym SP - przesyłka z doręczeniem do punktu EK - przesyłka Connect PI - przesyłka International PR - produkt Premium CP - przesyłka Connect Plus CM - przesyłka Connect Plus Pallet |
labelType | string | Tak | Wybór etykiety zwrotnej, możliwe wartości: LP - list przewozowy 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 |
content | string(30) | Tak | Zawartość przesyłki |
comment | string(100) | Nie | Dodatkowy komentarz, do wydruku na liście przewozowym. Pierwsze 50 znaków wiadomości zostanie również przekazane kurierowi jako uwagi zleceniodawcy |
reference | string(200) | Nie | Numer referencyjny przesyłki |
wayBill | string(11) | Nie | Numer listu przewozowego przesyłki |
servicePointAccountNumber | string | Nie | Wymagany, jeśli nie są podane dane odbiorcy i wybrano doręczenie do punktu |
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: 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: 1722 - Doręczenie w godzinach 18-22dodatkowo płatne SOBOTA - Doręczenie w sobotędodatkowo płatne NAD_SOBOTA - Nadanie w sobotędodatkowo płatne UBEZP - Ubezpieczenie przesyłkidodatkowo płatne COD - Zwrot pobraniadodatkowo płatne PDI - Informacje przed doręczeniemdodatkowo płatne ROD - Zwrot potwierdzonych dokumentówdodatkowo płatne POD - Potwierdzenie doręczenia dodatkowo płatne / Dla produktu PI - Usługi utylizacjibezpłatne SAS - Doręczenie do sąsiadabezpłatne ODB - Odbiór własnybezpłatne |
serviceValue | float | Nie | Deklarowana wartość, wymagana podczas zamawiania usług ubezpieczenie lub zwrot pobrania |
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) |
eRodemail | string(60) | Nie | Email dla eROD |
shipmentTime - informacja o czasie nadania przesyłki | |||
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 |
shipper oraz receiver - dane adresowe nadawcy oraz odbiorcy | |||
addressType | string(1) | Tak | Typ adresu (B/C) (tylko odbiorca) |
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 W przypadku doręczenia do DHL Parcelstation lub DHL Parcelshop dla przesyłek zagranicznych Connect - numer parcelstation lub parcelshop 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 |
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 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 |
contactPhone | string(9) | Nie | Kontaktowy numer telefonu |
contactEmail | string(60) | Nie | Kontaktowy adres email |
pieceList - dane nt. paczek w przesyłce | |||
type | string | Tak | Typ paczki, możliwe wartości: ENVELOPE - przesyłka kopertowa PACKAGE - paczka PALLET - paleta |
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) |
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ę) |
customs - dane dotyczące odprawy celnej (dla przesyłek doręczanych poza UE) | |||
customsType | string(1) | Tak | Rodzaj odprawy celnej (U - uproszczona, I - indywidualna) |
costsOfShipment | integer | Tak | Wartość brutto transportu jaką zapłacił odbiorca u kupującego |
currency | string(3) | Tak | Waluta (GBP, PLN, EUR, CHF, USD) |
nipNr | string(12) | Tak (dla odprawy indywidualnej) | Numer NIP |
eoriNr | string(17) | Tak (dla odprawy indywidualnej) | Numer EORI |
vatRegistrationNumber | string(15) | Tak | Numer rejestracyjny VAT |
eoriNrReceiver | string(17) | Tak (dla odprawy indywidualnej) | Numer EORI odbiorcy |
vatRegistrationNumberReceiver | string(15) | Tak | Numer rejestracyjny VAT odbiorcy |
categoryOfItem | string(2) | Tak | Kategoria towarów (wg. słownika: 9 - "Inne", 11 - "Sprzedaż towarów", 21 - "Zwrot towarów", 31 - "Prezent", 32 - "Wzory, próbki", 91 - "Dokumenty") |
invoiceNr | string(35) | Tak (dla odprawy indywidualnej) | Numer faktury |
invoiceDate | string(10) | Tak (dla odprawy indywidualnej) | Data faktury (format: YYYY-MM-DD) |
countryOfOrigin | string(2) | Nie | Kraj pochodzenia towarów. Dozwolone wartości wg. ISO 3366-1 alfa-2. |
additionalInfo | string(100) | Nie | Dodatkowe informacje |
grossWeight | float | Tak | Waga towarów |
firstName | string(30) | Tak | Imię osoby kontaktowej |
secondaryName | string(30) | Tak | Nazwisko osoby kontaktowej |
invoice | base64 | Tak (dla odprawy indywidualnej) | Faktura VAT |
customAgreements - dane dotyczące zgód i deklaracji odprawy celnej (dla przesyłek doręczanych poza UE) | |||
notExceedValue | string(1) | Tak (dla odprawy uproszczonej) | Dozwolone wartości: T, N |
notProhibitedGoods | string(1) | Tak | Dozwolone wartości: T, N |
notRestrictedGoods | string(1) | Tak | Dozwolone wartości: T, N |
customsItem - dane dotyczące towarów w odprawie celnej (dla przesyłek doręczanych poza UE) | |||
nameEn | string(35) | Tak | Nazwa angielska towaru |
namePl | string(35) | Tak (dla odprawy indywidualnej) | Nazwa polska towaru |
quantity | integer | Tak | Liczba elementów |
weight | float | Tak | Waga towaru |
value | float | Tak | Wartość towarów |
tariffCode | string(10) | Tak (dla odprawy indywidualnej) | Kod taryfy celnej |
countryOfOrigin | string(35) | Nie | ISO Country Code, tylko dla odprawy indywidualnej |
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) |
cn23MimeType | string | - | Typ dokumentu celnego CN23 - zwracany w przypadku uproszczonej odprawy celnej |
cn23Content | string | - | Zawartość dokumentu celnego CN23 (base64) - zwracany w przypadku uproszczonej odprawy celnej |
fvProformaMimeType | string | - | Typ dokumentu faktura proforma - zwracany w przypadku uproszczonej odprawy celnej |
fvProformaContent | string | - | Zawartość dokumentu faktura proforma (base64) - zwracany w przypadku uproszczonej odprawy celnej |
fvProformaNumer | string | - | Wygenerowany numer faktury - w przypadku niepodania numeru faktury w parametrach wejściowych |
Przykłady wywołania
<authData> <username>testomir</username> <password>testalski</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 DW - usługa Doręczenie wieczorne 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>ODB</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>UBEZP</serviceType> <serviceValue>20000</serviceValue> </item> </specialServices> <shipmentTime> <shipmentDate>2012-10-23</shipmentDate> <shipmentStartHour>12:00</shipmentStartHour> <shipmentEndHour>15:00</shipmentEndHour> </shipmentTime> <labelType>LP</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>Gra komputerowa</content> <comment>ostrożnie</comment> <ship> <servicePointAccountNumber>4111177</servicePointAccountNumber> <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> <name>Janek</name> <postalCode>00909</postalCode> <city>Wawa</city> <street>Leśna</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> <addressType>B</addressType> <country>PL</country> <name>Ja</name> <postalCode>00001</postalCode> <city>Wawa</city> <street>Leśna</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>Testomir</firstName> <secondaryName>Testalski</secondaryName> </customs> </shipment>